文档说明

SMSBUYS API 通过 uKey 识别调用账户,并使用 projectID 指定业务项目。获取号码成功后,接口会返回该号码对应的 PID,后续获取短信、发送短信、查询发送状态、释放号码和频道退款等操作都需要使用这个 PID。

收码业务调用流程

  1. 准备账户的 uKey
  2. 查询并选择正确的 projectID
  3. 调用“获取号码”接口,并保存返回的 PID
  4. 使用 PID 调用“获取短信”接口查询短信内容。
  5. 收到短信后完成业务处理。
  6. 不再使用号码时,调用“释放号码”接口。
重要

接口示例中的 uKey、PID、号码和项目 ID 均为示例值。请替换为你自己的真实数据,不要把真实 uKey 发布到公开页面或日志中。

发送短信业务调用流程

  1. 调用“获取号码”接口,并将 type 设置为 1
  2. 保存返回的 PID。
  3. 调用“发送短信”接口提交目标号码和短信内容。
  4. 调用“查询发送状态”接口确认发送结果。
  5. 任务完成后释放号码。

通用返回字段

字段说明
ret业务状态码,0 通常表示请求成功。
msg部分接口返回的状态或错误说明。
PID号码业务唯一标识,用于后续查询和操作。

请求频率

接口页面说明中给出的限制为每分钟不超过 50,000 次。超过限制可能返回 ret = -99,表示请求频率过快。

建议

不要以毫秒级频率重复轮询同一个 PID。应根据实际业务设置合理的查询间隔,并在收到终态后立即停止轮询。

号码生命周期

  • 获取号码本身不扣费。
  • 短信到达或发送成功后自动扣除费用。
  • 收码等待时间为 6 分钟,超时后系统自动释放号码。
  • 最多可以同时获取 3,000 个等待收码的号码,超过后可能返回状态码 20。
  • 不再使用号码时应及时释放,避免不必要的占用或费用。