开放接口

对接开放 API

用 API 密钥调用接口,实现自动取号、读码、续费与发送。频率限制 1 秒 10 次。

GET/open-api/user/balance
获取当前账户的可用余额。
请求参数
参数必填类型说明
keyStringAPI 密钥,账户唯一
返回示例
{ "code": 10000, "message": "success", "data": { "balance": 100.0000 } }
GET/open-api/number/get
按条件获取号码,可批量。
请求参数
参数必填类型说明
keyStringAPI 密钥
appIdInt应用标识
countryIdInt美国 188 · 加拿大 33
numberTypeInt全新卡 1 · 重启卡 2
quantityInt购买数量,最小 1
返回示例
{ "code": 10000, "data": [ { "number": 12722917613, "key": "读取密钥" } ] }
GET/open-api/msg/get
获取号码收到的短信,不传号码则返回账户最新一条。
返回示例
{ "code": 10000, "data": [ { "fromNumber": 14687944569, "toNumber": 15856931105, "message": "验证码 78890" } ] }
POST/open-api/number/renew
批量续费号码,传入号码数组。
请求参数
参数必填类型说明
keyStringAPI 密钥
appIdInt应用标识
numberArrArray号码数组
GET/open-api/sms/send
发送一条短信,内容最多 200 字符。
返回示例
{ "code": 10000, "message": "success", "data": "发送成功" }