WhatsApp API getPhone - nxtele/http-api-document GitHub Wiki

查询号码信息

通过API查询WhatsApp的号码信息查询

  • URL：https://api2.nxcloud.com/api/wa/getPhone
  • Method：POST
  • Content-Type：application/json
  • 需要鉴权：是

鉴权机制

鉴权规则请参考地址：API接口调用约定

请求参数

header参数：

参数名 类型 必选 示例值 说明
accessKey String 是 fmexxx3ki 用户身份标识
ts String 是 1655710885431 当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType String 是 2 WhatsApp业务类型，取固定值“2”
action String 是 getPhone WhatsApp业务操作，取固定值“getPhone”
sign String 是 6e95xxx826 API入参参数签名，签名算法

body参数：

参数名 类型 必选 示例值 说明
appkey String 是 牛信云WhatsApp应用的appkey
business_phones String 否 86158xxx1795 商户的WhatsApp号码列表，需要带国码，多个号码以“, ”分隔。如185xxx99,861xxx24。如参数为空，则返回应用下所有号码信息。
messaging_product String 是 whatsapp 发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”

请求示例

body（application/json） 参数：

{
    "business_phones": "185xxx99,861xxx24",
    "appkey": "jh42xxxd434",
    "messaging_product": "whatsapp"
}

响应参数

参数名 类型 说明
code Integer 结果编码
data JsonObject 请求结果
message String 请求结果说明
  • data object参数：
参数名 类型 说明
business_phones array[business_phone object] 号码信息序列，对于只有1个号码的响应消息，包含1个phone object。
  • business_phone object参数：
参数名 类型 说明
display_phone_number string 注册WhatsApp的号码
quality_rating string 号码质量枚举 枚举值: GREEN: 高质量；YELLOW:中质量； RED:低质量 ；UNKNOW:质量未知
verified_name string 号码的显示名
name_status string 名称审核状态枚举 枚举值: APPROVED: 显示名称获批。 NONE: 没有可用证书 AVAILABLE_WITHOUT_REVIEW: 可下载电话号码的证书，而且无需进行审核，即可使用显示名 DECLINED: 名称尚未获得批准。您不能下载证书 EXPIRED: 您的证书已过期，不可再下载 PENDING_REVIEW: 您的名称请求正在审核中。您不能下载证书
status string 号码状态枚举 枚举值: PENDING, DELETED, MIGRATED, BANNED, RESTRICTED, RATE_LIMITED, FLAGGED, CONNECTED,DISCONNECTED,UNKNOWN, UNVERIFIED
current_limit string 商户发起会话24小时限制等级枚举 枚举值: TIER_1K: 1 千位客户/24 小时 TIER_10K: 1 万位客户/24 小时 TIER_100K: 10万位客户/24 小时TIER_50: 50 位客户/24 小时 TIER_250: 250 位客户/24 小时 TIER_UNLIMITED: 不适用
code_verification_status string 号码验证状态枚举 枚举值: NOT_VERIFIED: 未验证 VERIFIED: 已验证 EXPIRED: 已过期
waba_id string WABA唯一ID
waba_name string WABA名称

响应示例

成功示例

{
    "code": 0,
    "data": {
        "86xxx24": [
            {
                "display_phone_number": "+86 xxx 24",
                "quality_rating": "GREEN",
                "name_status": "APPROVED",
                "verified_name": "GLORY JACK",
                "code_verification_status": "VERIFIED",
                "current_limit": "",
                "status": "CONNECTED",
                "waba_id": "11696xxxxx86404",
                "waba_name": "GLORY TEST"
            }
        ],
        "1xxx99": [
            {
                "display_phone_number": "+1 xxx99",
                "quality_rating": "GREEN",
                "name_status": "APPROVED",
                "verified_name": "Glory HK",
                "code_verification_status": "NOT_VERIFIED",
                "current_limit": "",
                "status": "CONNECTED",
                "waba_id": "11696xxxxx86404",
                "waba_name": "GLORY TEST"
            }
        ]
    },
    "message": "请求成功"
}

失败示例

{
    "code": -1,
    "message": "请求失败",
    "data": null
}

响应码说明

code message 解决办法
0 请求成功
-1 请求失败 请联系技术人员排除问题
1000~100X 鉴权问题 详情查看API鉴权部分
9000 参数异常 参数遗漏，请检查必须的参数
9001 系统业务错误 请联系技术人员排除问题
9002 商户手机号错误 请确认商户号码是否属于whatsapp号码
9006 该whatsapp号码未绑定应用 请联系业务人员处理应用和手机号绑定操作