这里汇总短信 API、快速接入、代码示例、错误码、发送记录和状态报告。第一次接入时先看快速接入;需要联调国内短信时,先查看国内短信 API;遇到失败时按当前返回格式和错误码继续排查。
开发者中心能帮你做什么
- 面向需要接入验证码短信、通知短信、营销短信、国际短信或语音验证码的开发者。
- 适合查看“接口怎么接、参数怎么看、示例在哪里、失败怎么排查”这类使用问题。
- 国内短信 API 支持
txt 和 json 两种返回格式:不填写 f 时默认返回 txt,填写 f=json 时返回 JSON。
按需求选择文档
| 文档 | 解决的问题 | 下一步 |
|---|
| 快速接入 | 从账号准备到第一条测试短信,跑通最小接入闭环。 | 进入快速接入 |
| 国内短信 API | 查看 https://api.smsbao.com/sms 的请求地址、请求参数,以及文本和 JSON 两种返回格式。 | 查看接口 |
| 国际短信 API | 面向海外手机号验证码或通知场景,查看国际短信接口说明。 | 查看国际短信 API |
| 语音验证码 API | 短信未达或高价值验证场景中,查看语音验证码接口说明。 | 查看语音验证码 API |
| 发送记录与状态报告说明 | 确认短信提交、发送、失败原因和回执处理方式。 | 查看发送记录与状态说明 |
| 代码示例 | 按语言复制短信 API 调用示例,降低接口联调成本。 | 查看 Demo 示例 |
| 错误码说明 | 按返回格式查看文本返回码或 JSON 状态码。 | 查看错误码说明 |
返回格式怎么选
| 返回方式 | 请求参数 | 返回内容 | 适合场景 |
|---|
txt 返回 | u、p、g、m、c | 明文文本返回,例如 0、30、40。 | 不填写 f,保持现有调用方式。 |
json 返回 | u、p、g、m、c、f=json | JSON:code、msg、data。 | 填写 f=json,统一处理状态码、描述信息和返回数据。 |
标准接入流程
| 步骤 | 要完成的事 | 产出结果 |
|---|
| 1. 准备账号 | 注册或登录短信宝账号,确认可以进入控制台。 | 可以获取 API 信息并进行测试。 |
| 2. 确认返回格式 | 不填写 f 时返回 txt;填写 f=json 时返回 JSON。 | 后端具备联调所需的请求地址、参数名和返回格式。 |
| 3. 准备签名与模板 | 按业务场景准备短信签名、模板变量和报备资料。 | 测试内容与正式内容符合审核要求。 |
| 4. 控制台测试 | 先在控制台发送测试短信,排除账号、内容、手机号问题。 | 确认链路能正常提交和接收。 |
| 5. API 联调 | 接入接口、处理返回值、记录请求日志和业务订单号。 | 业务系统可以稳定提交短信请求。 |
| 6. 查看记录和状态 | 通过发送记录或状态报告确认最终发送结果。 | 能定位提交成功、发送失败、用户未收到等问题。 |