注册
首页/文档中心/开发者中心/快速接入

开发者文档

短信接口快速接入

这是一条面向第一次接入的最短路径：先准备账号和 API 信息，再准备签名模板，随后用控制台发送测试短信，最后接入 API、查看发送记录并完成上线前检查。

查看国内短信 API

接入目标

  • 完成账号、接口信息、签名模板、测试手机号和测试内容准备。
  • 先通过控制台发送一条测试短信，确认账号和内容链路可用。
  • 再在业务系统中完成 API 调用、返回值处理、日志记录和失败排查。
  • 上线前确认余额、签名模板、频控策略、发送记录和状态报告都能被跟踪。

准备工作

准备项需要确认的内容为什么重要
账号权限可以登录控制台，并能查看 API 信息、发送测试、查询记录。避免开发联调时被权限或账号状态卡住。
API 信息接口账号、接口密钥、请求地址、请求方式、字符编码。这是后端调用短信接口的基础参数。
短信签名签名名称、主体资料、业务场景是否一致。签名不规范会影响模板审核和正式发送。
短信模板固定文案、变量位置、验证码有效期或通知内容。模板决定短信内容能否稳定复用。
测试手机号准备可接收短信的真实手机号，并记录测试时间。便于对照发送记录和接收结果。
业务日志记录请求参数、返回码、业务订单号和用户手机号脱敏信息。上线后排查失败和重复发送问题。

选择接入方式

方式推荐场景注意事项
API 接入业务系统需要自动发送验证码、通知、订单提醒或营销触达。需要后端处理返回码、重试、日志、频控和状态回执。
插件接入网站、商城、CMS 希望通过插件完成验证码或通知短信配置。仍需要准备账号、签名模板和测试手机号。
控制台测试运营或开发想先验证短信内容、签名模板和发送结果。适合联调前验证，不等同于正式业务系统接入。

快速接入步骤

步骤操作完成标准
1. 登录控制台注册或登录短信宝账号，进入控制台。能正常查看账户信息和发送相关功能。
2. 获取 API 信息找到接口账号、接口密钥和 API 文档页面。后端拿到联调所需的基础参数。
3. 准备签名与模板根据验证码、通知或营销场景准备签名和模板内容。测试短信内容与正式业务内容方向一致。
4. 发送控制台测试在控制台填写手机号和短信内容，发送一条测试短信。能在发送记录中看到提交结果。
5. 调用 API按 API 文档拼装请求参数，处理接口返回值。业务系统能提交短信请求并记录返回码。
6. 查询发送记录按手机号、时间、业务订单号或状态查看发送结果。能定位提交成功、发送失败或用户未收到。
7. 对照错误码排查如果接口返回错误码，查看错误码说明并调整参数或内容。错误能够被开发侧快速定位并修正。
8. 做上线检查检查余额、模板、频控、日志、状态报告和客服排查路径。正式流量接入前风险可控。

API 联调检查

  • 请求地址、请求方式、参数名称和编码方式必须与 API 文档一致。
  • 接口账号和密钥不要写在前端代码中，建议放在服务端配置或安全配置中心。
  • 调用后先判断接口返回码，再把业务订单号、手机号脱敏信息、发送时间写入日志。
  • 验证码类短信建议设置业务侧频控，避免重复发送、刷接口或被用户连续触发。
  • 不要只依赖“接口提交成功”判断用户已收到短信，最终结果要结合发送记录或状态报告。

测试与发送记录

要看什么怎么看排查价值
提交结果查看接口返回值或控制台发送记录中的提交状态。判断请求是否进入短信发送链路。
发送状态查看发送记录或状态报告中的成功、失败、未知状态。判断运营商侧或终端侧是否完成送达。
失败原因对照错误码、失败说明、手机号和短信内容。定位参数、余额、签名模板、内容或通道问题。
测试时间记录每次测试的手机号、时间、内容和返回码。便于客服或技术支持复盘问题。

常见问题排查

现象优先检查下一步
接口返回参数错误参数名称、必填项、编码、签名、模板变量。对照 API 文档修正请求。
提交成功但未收到发送记录、状态报告、手机号、终端拦截、短信内容。按发送失败排查页继续定位。
签名或模板异常签名主体、模板文案、变量格式、报备状态。回到产品文档中的签名与模板说明。
余额或套餐相关错误账户余额、套餐状态、测试额度。查看计费与测试说明或联系商务支持。
频繁触发验证码业务侧频控、同手机号次数、同 IP 次数。增加冷却时间和安全校验。

上线前检查

检查项建议状态
签名与模板正式业务文案已经确认，变量位置清晰，报备资料与业务一致。
接口日志能记录请求参数摘要、返回码、业务订单号和发送时间。
错误处理常见错误码有明确处理动作，异常情况不会阻塞主流程。
发送记录运营、客服或开发能查到测试记录和正式发送记录。
余额与提醒账户余额或套餐状态可被业务负责人跟踪。
帮助页面客服或运营知道从错误码、发送记录、帮助中心继续排查。

下一步

国内短信 API进入接口参数、返回值和示例说明。 代码示例按语言复制调用样例开始联调。 错误码说明建立失败排查和开发处理动作。 状态报告 / 发送记录 API把发送结果接回业务系统。 签名与模板确认签名、模板和报备规则。 发送失败排查面向客服和运营的排查路径。