API 文档

面向单号检测的 WhatsApp 验证 API

选择 service_type，提交一个手机号，即可同步获得对应产品的结果。

API 速览一个同步接口、三种 service_type，统一的 code / msg / data 响应结构。

认证

使用在设置中创建的 API Key，并随每次请求一起发送。

X-API-Key: wac_your_api_key

单次检测

POST /api/v1/check

service_typews、ws_avatar 或 ws_business

identifier带国家码的 E.164 手机号

请求体

{
  "service_type": "ws",
  "identifier": "+14155552671"
}

产品与返回字段

wsWhatsApp 注册检测确认手机号是否已注册 WhatsApp。

1 积分

ws_avatarWhatsApp 头像检测在确认注册状态的同时，判断账号是否设置了可见头像。

2 积分

ws_businessWhatsApp 商业账号检测在确认注册状态的同时，识别号码是否使用 WhatsApp 商业账号。

2 积分

avatar=false and business=false 并不代表号码未注册；注册状态请始终以 registered 为准。

缓存状态是内部实现，不会出现在 API 响应中；客户端不应依赖 cached 字段。

响应示例

每款产品都返回相同的 code / msg / data 结构，data 内的字段取决于请求的 service_type。

wsWhatsApp 注册检测1 积分

{
  "code": 0,
  "msg": "ok",
  "data": {
    "id": 123,
    "identifier": "+14155552671",
    "registered": true,
    "transaction_id": "chk_example123",
    "status": "success",
    "service_type": "ws",
    "charged_credits": 1
  }
}

ws_avatarWhatsApp 头像检测2 积分

{
  "code": 0,
  "msg": "ok",
  "data": {
    "id": 123,
    "identifier": "+14155552671",
    "registered": true,
    "transaction_id": "chk_example123",
    "status": "success",
    "service_type": "ws_avatar",
    "avatar": true,
    "avatar_url": "https://pps.waavatar.xyz/v/example.jpg",
    "charged_credits": 2
  }
}

ws_businessWhatsApp 商业账号检测2 积分

{
  "code": 0,
  "msg": "ok",
  "data": {
    "id": 123,
    "identifier": "+14155552671",
    "registered": true,
    "transaction_id": "chk_example123",
    "status": "success",
    "service_type": "ws_business",
    "business": true,
    "charged_credits": 2
  }
}

错误码

40000不支持的 service_type 或字段冲突

40001JSON 请求体无效

40002手机号无效

40100缺少或无效的 API Key

40200积分不足

42900超出速率限制

50300检测服务维护中

cURL 示例

export WA_CHECKER_API_BASE="https://your-api-domain.com"

curl -X POST "$WA_CHECKER_API_BASE/api/v1/check" \
  -H "X-API-Key: wac_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "service_type": "ws", "identifier": "+14155552671" }'

将 WA_CHECKER_API_BASE 替换为你部署的 API 基础地址。

创建 API Key