短信下发
更新时间:2023-07-28
描述
实现短信下发功能,一次支持提交多个手机号。
注意:
下发短信前,需要先申请签名和短信模板,且审核通过后使用。
URL
/api/v3/sendSms
HTTP Method
POST
请求Body参数
参数名称 | 类型 | 是否必需 | 描述 | 示例 |
---|---|---|---|---|
mobile | String | 是 | 手机号码,支持单个或多个手机号,多个手机号之间以英文逗号分隔,一次请求最多支持200个手机号。国际/港澳台号码请按照E.164规范表示,例如台湾手机号以+886开头,”+“不能省略。 | 13800138000,13800138001,+886951234567 |
template | String | 是 | 短信模板ID,模板申请成功后自动创建,全局内唯一 | sms-tmpl-KyAUkV64619 |
signatureId | String | 是 | 短信签名ID,签名表申请成功后自动创建,全局内唯一 | sms-signQxkiwz88470 |
contentVar | JsonObject | 是 | 模板变量内容,用于替换短信模板中定义的变量 | {"param1":"123","param2":"abc"} |
custom | String | 否 | 用户自定义参数,格式为字符串,状态回调时会回传该值 | - |
userExtId | String | 否 | 通道自定义扩展码,上行回调时会回传该值,其格式为纯数字串。默认为不开通,请求时无需设置该参数。如需开通请联系SMS帮助申请 | 123 |
请求Query参数
参数名称 | 类型 | 是否必需 | 描述 | 示例 |
---|---|---|---|---|
clientToken | String | 否 | 幂等性参数,避免client在http响应超时而重试时出现同一条短信多次发送的情况。如传入,则作为请求的messageId前缀,并在响应中回传,有效时间:3分钟 | - |
什么是E.164?
E.164是由国际电信联盟(International Telecommunication Union,简称ITU)发布的一种国际号码表示方法。一个完整的E.164规范号码由[+][国家或地区码][地区内号码]三部分组成。
示例:
国家或地区 国家或地区码 地区内号码 E.164表示 中国台湾 886 7751875413 +8867751875413 美国 1 4155552971 +14155552971 英国 44 2071236750 +442071236750
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
requestId | String | 发送请求的唯一流水ID |
code | String | 请求提交状态,1000表示成功 |
message | String | 请求提交状态描述 |
data | List |
SendMessageItem数组,一个SendMessageItem对应一个手机号的响应结果 |
SendMessageItem定义
参数名称 | 类型 | 描述 |
---|---|---|
mobile | String | 手机号 |
code | String | 对应手机号的提交状态,1000表示成功 |
message | String | 对应手机号的响应结果描述 |
messageId | String | 对应手机号的消息ID |
HTTP请求示例
POST http://smsv3.bj.baidubce.com/api/v3/sendSms?clientToken=e325ea68-02c1-47ad-8844-c7b93cafaeba
Authorization: bce-auth-v1/626e6a284eac4e3f97cc30b38ffea6a4/2019-12-04T06:53:12Z/3600/host;x-bce-console-rpc-id;x-bce-date/d3a5b16483e4d999ce705cb3a8a2f30b728adcd422787a4bd2618b4e215c0327
Content-Type: application/json
Host: smsv3.bj.baidubce.com
x-bce-date: 2019-12-04T06:53:12Z
{
"mobile": "13800138000",
"template": "sms-tmpl-awKvRY85349",
"signatureId": "sms-signQxkiwz88470",
"contentVar": {
"code": "23456",
"minute": "1"
}
}
成功响应示例
HTTP/1.1 200 OK
Content-Length: 218
Content-Type: application/json;charset=UTF-8
Date: Wed, 04 Dec 2019 06:53:13 GMT
X-Bce-Request-Id: 5e6dacd5-8815-4183-8255-4ff079bf24e6
{
"requestId": "5e6dacd5-8815-4183-8255-4ff079bf24e6",
"code": "1000",
"message": "成功",
"data": [
{
"code": "1000",
"message": "成功",
"mobile": "13800138000",
"messageId": "e325ea68-02c1-47ad-8844-c7b93cafaeba_13800138000"
}
]
}