/check/whatsapp_basic

1.API 说明
2.请求参数
3.响应参数
4.错误码
5.示例

1.API 说明

本 API 用于检测某个手机号是否已注册 WhatsApp(基础版本)。

请求方式

POST

请求地址

https://cloudapi.argentina.accuauth.com/check/whatsapp_basic

Debugging Tool

Debugging Tool

2.请求参数

2.1 请求头(Request Header)

参数 类型 是否必填 说明
X-DF-API-ID string 是 API 访问凭证,请参见 API Request
X-DF-API-SECRET string 是 API 访问凭证,请参见 API Request

2.2 请求体(Request Body)

字段 类型 说明
required number string 阿根廷手机号,需以 54 开头
optional callback string 暂不支持

3.响应参数

字段 类型 说明
request_id string 每次请求的唯一 ID
status string 响应状态:请求成功为 OK;检测进行中为 PENDING;其他为失败状态。详见 错误码
result object 检测结果,详见下方 result 说明
result 字段说明:
字段 类型 说明
number string 手机号
whatsapp string 是否注册,yes 表示已注册,no 表示未注册

响应示例
{
    "status": "OK",
    "result": {
      "number": "+5475293XXXX",
      "whatsapp": "yes"
    },
    "request_id": "TID591cb9fb0e284cf296912a4d0ffea889"
}

4.错误码

本 API 常见错误码如下:

HTTP 状态码 Status 字段 说明
400 PENDING 操作进行中
400 INVALID_ARGUMENT 请求参数无效
401 UNAUTHORIZED 未授权或访问被拒绝
401 KEY_EXPIRED API ID 已过期
403 NO_PERMISSION 无权使用该 API
403 OUT_OF_QUOTA API 调用次数已超出配额
403 RATE_LIMIT_EXCEEDED API 请求频率超出限制
404 NOT_FOUND 未找到请求的 API
500 INTERNAL_ERROR 服务器内部错误

说明: 当发生上述 40X 错误时,请查看响应中的 reason 字段获取详细原因。

错误响应示例
{
    "status": "INVALID_ARGUMENT",
    "reason": "argument 'number': not found",
    "request_id": "TID0bb59f6aa6454717b870b16202ccf36f"
}

5.Sample

results matching ""

    No results matching ""