发送通知短信

POST

/api/v1/sms_notice

短信网关

平台对外的通知短信接口。平台在后台固定配置模板 ID，调用方只需要传手机号、通知内容和必要的模板变量即可。

请求参数

Authorization

API Key

在 header 添加参数

x-api-key

示例：

x-api-key: ********************

Body 参数application/json必填

示例

最少参数使用平台配置的模板编号使用模板变量对象传参

{
    "mobile": "13800000000",
    "content": "【api.btr.cc】您的订单已支付，订单号 202605110001"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

最少参数使用平台配置的模板编号使用模板变量对象传参

curl --location '/api/v1/sms_notice' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "mobile": "13800000000",
    "content": "【api.btr.cc】您的订单已支付，订单号 202605110001"
}'

返回响应

🟢201

application/json

发送成功

Bodyapplication/json

示例

{
    "code": 0,
    "message": "发送成功",
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "priceSource": "default",
    "unitPrice": "0.1000",
    "data": {
        "productCode": "sms_notice",
        "mobile": "13800000000",
        "templateId": "SMS_NOTICE_001"
    }
}

🟠403

🟠404

修改于 2026-05-11 11:39:57

发送验证码短信

SmsCodeRequest