跳转到内容

WhatsApp批量号码检测API：快速手机号验证

检查输入的国际手机号的WhatsApp详情，是否为WhatsApp账号。基于短期缓存和实时检测的服务。

上传检测文件代码示例：

Terminal window
curl --location 'https://api.checknumber.ai/v1/tasks' \
--header 'X-API-Key: API-KEY' \
--form 'file=@"./number.txt"' \
--form 'task_type="ws"'

检查任务状态代码示例：

Terminal window
curl --location 'https://api.checknumber.ai/v1/gettasks' \
--header 'X-API-Key: API-KEY' \
--form 'task_id="task_id"'

上传检测文件成功的响应

{
  "task_id": "cs9viu7i61pkfs4oavvg",
  "status": "pending",
  "total": 20000,
  "estimated_amount": {
    "amount": "2.000000",
    "currency": "USD"
  },
  "message": "Task created successfully. Numbers are being validated and processed in the background.",
  "created_at": "2024-10-19T18:24:56.450567423Z"
}

处理状态的响应

{
  "created_at": "2024-10-19T18:24:56.450567423Z",
  "updated_at": "2024-10-19T18:33:22.86152082Z",
  "task_id": "cs9viu7i61pkfs4oavvg",
  "user_id": "test",
  "status": "processing",
  "total": 20000,
  "success": 6724,
  "failure": 0
}

任务完成时的响应，包含结果下载链接

{
  "created_at": "2024-10-19T18:24:56.450567423Z",
  "updated_at": "2024-10-19T18:53:43.141760071Z",
  "task_id": "cs9viu7i61pkfs4oavvg",
  "user_id": "test",
  "status": "exported",
  "total": 20000,
  "success": 20000,
  "failure": 0,
  "result_url": "https://example-link-to-results.xlsx",
  "actual_amount": {
    "amount": "2.000000",
    "currency": "USD"
  }
}

上传文件请求网址

POST https://api.checknumber.ai/v1/tasks

上传文件请求参数

参数说明
filefile，上传文件，每行应包含一个E.164格式的电话号码
task_typestring，任务类型，设置为”ws”

检查任务状态请求网址

POST https://api.checknumber.ai/v1/gettasks

检查任务状态请求参数

参数说明
task_idstring，从任务创建返回的任务ID

结果字段

字段说明示例
NumberE.164格式的手机号+41798284651
whatsapp该号码是否有活跃的WhatsApp账号yes, no

响应格式

字段说明
created_at任务创建时间戳
updated_at任务状态最后更新时间戳
task_id唯一任务标识符
user_id用户ID
status任务状态：
pending: 已排队等待
processing: 正在处理
exported: 结果可下载
failed：任务失败，已扣费用自动退回
total已处理的总手机号数量
success成功识别的号码数量
failure处理失败的号码数量
result_url（可选）当状态为exported时的结果下载链接
actual_amount（可选）实际扣费金额，任务结算后返回
estimated_amount（创建响应）任务预估费用，最终以任务完成后的结算金额为准

状态码

状态码说明
200free，请求成功（如状态查询）
202charge，任务创建成功，预扣预估费用
400free，错误的请求：参数或文件格式无效、任务类型不支持、或有效数据量低于最小批量
401free，API Key 缺失或无效
402free，账户余额不足
404free，任务不存在
413free，上传文件过大
500free，内部服务器错误，请稍后重试