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