账户
您可以在这里获得API端口、API密钥以及查询账户余额接口.
端口描述
API是您的软件和我们的激活服务器之间的互动协议。为了使您的短信接收过程自动化需要API。要使用API，您必须使用您的API密钥，所有请求均进入 https://nzsms.com/api/。GET接口可使用 ?apikey=YOUR_APIKEY，POST接口可在JSON里传入 apikey，也可使用请求头 X-API-Key。
APIKEY
您的APIKEY： 登录后显示
查询余额
https://nzsms.com/api/me?apikey=YOUR_APIKEY
| 参数 | 类型 | 必需的 | 描述 |
|---|---|---|---|
| apikey | string | 是的 | 您的APIKEY |
正确的结果:
{"ok":true,"balance":"96.72","apikey":"YOUR_APIKEY"}
{"ok":true,"balance":"96.72","apikey":"YOUR_APIKEY"}
可能的错误:
{"detail":"不正确的apikey"}
{"detail":"不正确的apikey"}
请求号码
POST https://nzsms.com/api/orders/create
{"apikey":"YOUR_APIKEY","service_id":510042,"service_name":"WeChat","country_name":"泰国","provider":"acsim","cost":"0.13"}获取短信
POST https://nzsms.com/api/orders/1001/sms
{"apikey":"YOUR_APIKEY"}更改请求状态
POST https://nzsms.com/api/orders/1001/release
{"apikey":"YOUR_APIKEY"}未收到短信时释放号码；如释放前已经回码，系统会同步短信并按成功订单处理。
重新激活号码
POST https://nzsms.com/api/orders/1001/sms
{"apikey":"YOUR_APIKEY"}等待状态可重复点击 C 获取短信；成功返回短信时才扣用户分。
获取国家列表
GET https://nzsms.com/api/countries?apikey=YOUR_APIKEY
国家列表由本地缓存返回，每天自动同步一次，接口异常时使用旧缓存兜底。
获取服务列表
GET https://nzsms.com/api/services?apikey=YOUR_APIKEY&country=泰国&service=WeChat
服务搜索会短期缓存服务列表，再按国家本地过滤，用于降低切换国家时的等待时间。
获取短信记录
GET https://nzsms.com/api/orders?apikey=YOUR_APIKEY
获取可租借地区
GET https://nzsms.com/api/rent/tariffs?apikey=YOUR_APIKEY GET https://nzsms.com/api/rent/tariffs?apikey=YOUR_APIKEY&area_code=US
不传 area_code 返回地区列表；传入 area_code 返回该地区可租月份和平台售价。
租借号码
POST https://nzsms.com/api/rent/create
{"apikey":"YOUR_APIKEY","area_code":"US","time":1}租借成功后立即扣费。租借开始 20 分钟内未收到短信，号码处于可关闭状态时可退款。
获取租借订单
GET https://nzsms.com/api/rent/orders?apikey=YOUR_APIKEY&tab=active GET https://nzsms.com/api/rent/orders?apikey=YOUR_APIKEY&tab=expired
获取租借短信
POST https://nzsms.com/api/rent/1001/sms
{"apikey":"YOUR_APIKEY"}关闭租借号码
POST https://nzsms.com/api/rent/1001/close
{"apikey":"YOUR_APIKEY"}号码处于可关闭状态时会关闭成功；成功后平台自动退回该租借订单扣除的余额。
续租号码
GET https://nzsms.com/api/rent/1001/renew-options?apikey=YOUR_APIKEY
POST https://nzsms.com/api/rent/1001/renew
{"apikey":"YOUR_APIKEY","time":1}通用短信接收 - 请求号码
POST https://nzsms.com/api/keyword-orders/create
{"apikey":"YOUR_APIKEY","country":"中国","keyword":"验证码","mobile":"","dedupe":"0"}通用短信接收 - 获取短信
POST https://nzsms.com/api/orders/1001/sms
{"apikey":"YOUR_APIKEY"}通用短信接收 - 释放号码
POST https://nzsms.com/api/orders/1001/release
{"apikey":"YOUR_APIKEY"}通用短信接收 - 获取短信记录
GET https://nzsms.com/api/orders?apikey=YOUR_APIKEY