获取手机号列表

请求方式

GET /whatsapp/phoneNumbers HTTP/1.1
Host: https://{your-domain}/api/open/v1

请求头

字段类型注释
X-API-Keystring必填,API 密钥

请求参数

字段类型注释
waba_idstring是,WABA 账户 ID
pageint否,页码,默认 1
limitint否,每页条数,默认 10
fieldsstring否,指定返回字段

可用 fields 字段:id, display_phone_number, verified_name, status, quality_rating, country_code, country_dial_code, code_verification_status, account_mode, host_platform, messaging_limit_tier, is_official_business_account

返回的结果

{
  “code”: 1,
  “msg”: “OK”,
  “data”: {
    “data”: {
      “0”: {
        “id”: “1906385232743451”,
        “display_phone_number”: “+1 631-555-5555”,
        “verified_name”: “Jasper’s Market”,
        “status”: “CONNECTED”,
        “quality_rating”: “GREEN”,
        “country_code”: “US”,
        “country_dial_code”: “1”,
        “code_verification_status”: “VERIFIED”,
        “account_mode”: “LIVE”,
        “host_platform”: “CLOUD_API”,
        “messaging_limit_tier”: “TIER_1K”,
        “is_official_business_account”: true
      }
    },
    “total”: 1,
    “per_page”: 10,
    “current_page”: 1
  }
}

字段类型注释
idstring电话号码 ID
display_phone_numberstring显示电话号码
verified_namestring已验证名称
statusstring连接状态
quality_ratingstring质量评级
country_codestring国家代码
country_dial_codestring国家拨号代码
code_verification_statusstring验证码验证状态
account_modestring账户模式
host_platformstring托管平台
messaging_limit_tierstring消息发送限制层级
is_official_business_accountbool是否为官方商业账户
totalint总记录数
per_pageint每页条数
current_pageint当前页码