跳转到内容

WhatsApp 深度检测

检查输入的全球号码的 WhatsApp 详细信息,是否是 WhatsApp 账户,个人资料图片 URL、性别和年龄,以及个人资料图片的类型。

上传检测文件代码示例:

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

检查任务状态代码示例:

curl --location 'https://api.ekycpro.com/api/tasks/s4oR_IDoee0?userUSER_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": "test1",
"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": "test1",
"status": "processing",
"total": 20000,
"success": 6724,
"failure": 0
}

提供任务完成并包含结果下载 URL 的响应示例

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

上传文件请求 URL

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

检查任务状态请求 URL

POST https://api.ekycpro.com/api/tasks/{TASK_ID}

请求参数

参数描述
user_idstring,用户定义的用户 ID
filefile,上传文件,上传的文件中的每一行应包含一个电话号码,号码必须是 E.164 格式。

响应格式

字段描述
created_at任务创建的时间戳。
updated_at任务状态的最后更新时间戳。
task_id任务的唯一标识符。
user_id发起任务的用户 ID。
status任务的当前状态。可能的值有:
pending:任务已排队,等待处理。
processing:任务正在处理中。
completed:任务处理完成。
exported:任务结果已处理并可供下载。
total任务中处理的电话号码总数。
success成功识别出 WhatsApp 属性的电话号码数量。
failure无法识别或处理的电话号码数量。
result_url(可选)下载任务结果的 URL,当任务状态为 exported 时提供。

状态码

状态码描述
200charge,请求成功,任务已创建或任务状态已成功检索。
400free,错误请求,通常由于参数或文件格式不正确。
500free,内部服务器错误,请稍后重试请求。