This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
云码平台 - 商家接入文档
商家身份鉴权
调用API接口， 请在 HTTP 请求头中添加您账号的 JWT Token ：
- Header Key：Authorization
- Header Value：XXXXXXXXXXX （查看商家授权令牌）
短信接码流程
获取手机号
接口地址：https://api.code92.top/api/adm/sms.code/get.phone
请求示例(POST)：
{
"project": "telegram", // 接码项目，可选值：见本页底部项目表
"provider": "terminal", // 此项固定不可变
"countryCode": "us" // 获取指定国家的手机号（两位国家编码），可选值：见本页底部国家代码表
}
成功响应示例：
{
"code": "succeed", // 使用if ( code == "succeed" ) 判定获取成功。
"data": {
"callingCode": 66, // 国际电话区号
"id": 552149995081733, // 业务流水号，存下来，在后续的接口调用中要传入。
"phoneNumber": "858683974" // 不带区号的电话号码
}
}
失败响应示例：
{
"code": "unexpected", // 错误码
"msg": "外部接口异常 0|-1" // 错误原因
}
获取验证码
此步骤需要多次尝试，建议设定请求间隔为5s，持续5min
接口地址：https://api.code92.top/api/adm/sms.code/get
请求示例(POST)：
{
"id": 611987201483781 // 业务流水号
}
取到码响应示例：
{
"code": "succeed",
"data": {
"receiveStatus": "received", // 如果取到短信验证码 此字段值为 “received”
"smsCode": "1234" // 短信验证码
}
}
未取到码示例：
{
"code": "succeed",
"data": {
"receiveStatus": "waiting" // 如果是waiting，或者executing ，说明还在取码中，可等待几秒再调用此接口
}
}
{
"code": "succeed",
"data": {
"receiveStatus": "timeout" // 如果是timeout，说明长时间未收到验证码，系统已经自动释放了该手机号，不会再去收码了。
}
}
报告验证码错误
如您收到验证码输入目标程序后提示验证码不正确，可调用错误上报接口，将该次任务状态重置为waiting， 之后继续执行步骤3，直到状态为received，即收到了新的正确的验证码。
接口地址：https://api.code92.top/api/adm/sms.code/report.sms.code.error
请求示例(POST)：
{
"id": 611987201483781 // 业务流水号
}
响应示例：
{
"code": "succeed",
"data": 1
}
释放手机号
如果调用步骤2多次未获取到验证码，需要放弃此号继续做下一个任务时，请调用释放手机号接口，释放手机号之后即停止计费，避免损耗。
接口地址：https://api.code92.top/api/adm/sms.code/release.phone
请求示例(POST)：
{
"id": 611987201483781 // 业务流水号
}
响应示例：
{
"code": "succeed",
"data": 1
}
拉黑手机号
如果不希望获取到某个手机号，可以调用手机号拉黑接口，拉黑之后可确保24小时内不会再次取到此手机号。
接口地址：https://api.code92.top/api/adm/sms.code/ban.phone
请求示例(POST)：
{
"id": 611987201483781 // 业务流水号
}
响应示例：
{
"code": "succeed",
"data": 1
}