跳转到内容

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

检查输入的国际手机号是否开通了 WhatsApp 账号

上传检测文件示例代码:

curl --location 'https://api.ekycpro.com/wa/api/simple/tasks' \
--header 'X-API-Key: API-KEY' \
--form 'user_id="USER_ID"' \
--form 'file=@"input.txt"'

检查任务状态示例代码:

curl --location 'https://api.ekycpro.com/wa/api/simple/tasks/cs9viu7i61pkfs4oavvg?user_id=USER_ID' \
--header 'X-API-Key: API-KEY'

上传检测文件成功的响应

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

处理状态的响应

{
"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"
}

上传文件请求地址

POST https://api.ekycpro.com/wa/api/simple/tasks

上传文件请求参数

参数说明
user_idstring, 用户 ID
filefile, 上传文件,每行包含一个 E.164 格式的手机号

检查任务状态请求地址

GET https://api.ekycpro.com/wa/api/simple/tasks/{TASK_ID}

检查任务状态请求参数

参数说明
user_idstring, 用户 ID

结果字段

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

响应格式

字段说明
created_at任务创建时间戳
updated_at任务状态最后更新时间戳
task_id唯一任务标识符
user_id用户 ID
status任务状态:
pending: 已排队等待
processing: 正在处理
completed: 处理完成
exported: 结果可下载
total已处理的总手机号数量
success成功识别的号码数量
failure处理失败的号码数量
result_url(可选)当状态为exported时的结果下载链接

状态码

状态码说明
200charge, 请求成功,任务已创建或状态已获取
400free, 请求错误,参数或文件格式无效
500free, 服务器内部错误,请稍后重试