从一次单号检测开始
使用保存在你服务器上的 API 密钥，向 https://api.numdetect.com 发送请求。你可以在控制台创建多个密钥，每个系统一个，也可以随时删除其中任何一个。不要把密钥放进前端代码。
cURL
curl "https://api.numdetect.com/api/v1/checks" \
-H "Authorization: Bearer $NUMDETECT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{
"phone": "+12025550147",
"products": [
"whatsapp"
]
}'使用样例号码的示意请求。请将 $NUMDETECT_API_KEY 替换为你的密钥；每次运行都是真实、收费的检测。
检测返回什么
每个输入、每款产品各返回一条结果。先看 registered：true 和 false 是明确结果，null 是无法判断。单号检测只对 true 和 false 计费；批量分组在批量任务完成后整组扣费。
200 OK
{
"id": "10000000-0000-4000-8000-000000000001",
"input_kind": "phone",
"input": "+12025550147",
"country": "US",
"charged": 4000,
"results": [
{
"product_id": "whatsapp",
"status": "success",
"result": true,
"price": 4000,
"charged": 4000
}
]
}status- success：明确结论；unknown：没有明确结论；failed：无法访问该产品。只有 success 会收费。
result- true：找到账号；false：没有账号；status 不是 success 时为 null。
info- 部分产品返回的附加字段，例如 WhatsApp Business 标识。
price- 该产品此次检测的价格，单位为 USD micros（1,000,000 = $1）。
charged- 实际扣费金额：明确结论时为价格，否则为 0。
01
先在后台体验
先在控制台运行几次单号检测，了解输入和结论，再开始编写你的集成。
02
读取当前能力目录
获取产品列表，查看哪些产品在售、它们的输入类型、国家和价格。不要根据公开网站硬编码这些内容。
03
创建并跟踪任务
创建检测或批量任务时发送 Idempotency-Key。如果响应丢失，请用同一个键重试，不要换新键。
批量号码处理流程
- 1
上传 CSV 或文本文件，并提供产品、号码所在的列，以及你最多愿意支付的金额。
- 2
名单按国家拆分；每个国家由你选择的每个产品分别检测。
- 3
持续查看任务进度直到完成，或接收 Webhook 通知。
- 4
下载一份结果文件，包含每一原始行，以及每个产品一列的结论。
Key 保存在你的服务端
- 每个账号最多 10 个 Bearer API 密钥，随时可删除。
- 批量任务完成时会发送带签名的 Webhook。
- 结果文件通过有效期 10 分钟的链接下载。
凭据请使用环境变量；如果密钥泄露，请在控制台删除。联系客服时请附上检测或任务 ID；切勿把 API 密钥粘贴到截图或公开示例中。
准备好检测你的号码了吗？
注册后即可开始，无需审核。充值余额后，检测真实号码。