開發者文件
介面為 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 的文字。完整錯誤碼表見控制台的開發者文件。
未找到所需內容？歡迎直接諮詢
請說明您的業務場景，客服將提供可發範圍、線路建議與單價。