开发者文档
接口为 RESTful 风格，通过访问令牌鉴权，请求与响应统一使用 UTF-8 编码的 JSON。下方每个接口都附有可直接运行的 curl 示例。
SMS API — 发送短信
在您的业务系统中直接触发发送。to 可传单个号码，或用英文逗号分隔批量提交（单次最多 1000 个）；受理成功即返回 message_id，可凭它查询送达状态。
鉴权请求头
参数
必填
描述
Authorization是
在请求里带上 API 令牌，鉴权类型设为 Bearer，示例：
Authorization: Bearer {api_token}Accept是
设置为 application/json
发送短信
向一个或多个号码发送文本短信。响应中的 segments 为本条占用的条数，cost 为该条总费用。
接口地址
POST https://redsmsbox.com/api/v1/sms/send参数
参数
必填
类型
描述
to是
string
接收号码，E.164 格式（含国家码）；批量用英文逗号分隔
message是
string
短信正文，格式【签名】正文，营销类须以「退订回 T」结尾
channel否
string
通道 ID，缺省走账户默认通道
sender_id否
string
国际短信自定义发件人标识（Sender ID）
schedule_at否
string
定时发送时间（ISO 8601 UTC），缺省立即下发
callback_url否
string
本条短信状态回执的 Webhook 地址，覆盖账户默认设置
示例请求
curl -X POST https://redsmsbox.com/api/v1/sms/send \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"to": "+8613800138000",
"message": "【RedsmsBox】您的验证码是 123456，5 分钟内有效。"
}'返回值
{
"ok": true,
"message_id": "msg_3f7a91",
"status": "queued",
"to": "+8613800138000",
"segments": 1,
"cost": "0.06",
"currency": "USD"
}{
"ok": false,
"error_code": "invalid_parameter",
"error": "The body is not valid JSON, or a field failed validation"
}失败响应固定是这个信封：error 字段永远是英文、不随界面语言变化（它面向机器与日志聚合），请按 error_code 分支，不要匹配 error 的文字。完整错误码表见控制台的开发者文档。
查询发送状态
按发送时返回的 message_id 查询单条短信的当前状态与运营商回执时间。
接口地址
GET https://redsmsbox.com/api/v1/sms/{message_id}参数
参数
必填
类型
描述
message_id是
string
发送接口返回的短信编号
示例请求
curl -X GET https://redsmsbox.com/api/v1/sms/msg_3f7a91 \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'返回值
{
"ok": true,
"message_id": "msg_3f7a91",
"status": "delivered",
"to": "+8613800138000",
"segments": 1,
"cost": "0.06",
"currency": "USD",
"submitted_at": "2026-08-16T09:12:31Z",
"delivered_at": "2026-08-16T09:12:34Z"
}{
"ok": false,
"error_code": "invalid_parameter",
"error": "The body is not valid JSON, or a field failed validation"
}失败响应固定是这个信封：error 字段永远是英文、不随界面语言变化（它面向机器与日志聚合），请按 error_code 分支，不要匹配 error 的文字。完整错误码表见控制台的开发者文档。
查询发送记录
分页列出当前账户的发送记录，可按时间与状态筛选。
接口地址
GET https://redsmsbox.com/api/v1/sms参数
参数
必填
类型
描述
status否
string
按状态筛选，如 queued / delivered / failed
start否
string
起始时间（ISO 8601 UTC）
end否
string
结束时间（ISO 8601 UTC）
page否
number
页码，缺省为 1
示例请求
curl -X GET 'https://redsmsbox.com/api/v1/sms?status=delivered&page=1' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'返回值
{
"ok": true,
"page": 1,
"total": 2,
"items": [
{
"message_id": "msg_3f7a91",
"status": "delivered",
"to": "+8613800138000",
"segments": 1,
"cost": "0.06"
}
]
}{
"ok": false,
"error_code": "invalid_parameter",
"error": "The body is not valid JSON, or a field failed validation"
}失败响应固定是这个信封：error 字段永远是英文、不随界面语言变化（它面向机器与日志聚合），请按 error_code 分支，不要匹配 error 的文字。完整错误码表见控制台的开发者文档。
未找到所需内容？欢迎直接咨询
请说明您的业务场景，客服将提供可发范围、线路建议与单价。