API: SMS/BatchXSend - 短信批量模板群发
版本号 v4.002
更新说明
2024年11月12日
1. 接口新增了对动态短信签名的支持，可以通过sms_signature参数来实现通过一个模板，发送多种签名的短信。
概览
sms/batchxsend 是 SUBMAIL 的批量短信发送接口。与 sms/xsend 接口相似，在请求中自由提交短信内容，to （联系人）参数可以批量提交联系人手机号码（单次请求最大支持 10000 个）大幅提高群发需求的发送效率。
URL
https://api-v4.mysubmail.com/sms/batchxsend
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/sms/batchxsend.json （默认） |
xml | https://api-v4.mysubmail.com/sms/batchxsend.xml |
yaml | https://api-v4.mysubmail.com/sms/batchxsend.yaml |
http 请求方式
| 请求方式 | content-type设置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授权
是
参阅 API 授权和验证机制
sms/batchxsend POST 方法请求参数
| 参数 | 类型 | 必需/可选 | 默认 | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 无 | 在 SUBMAIL 应用集成中创建的短信应用ID |
signature | string | 必需 | 无 | 应用密匙或数字签名 参阅 API授权与验证机制 > 授权和验证方式。当sign_type=normal时signature应传appkey的值。 |
to | string | 必需 | 无 | 收件人手机号码，多个手机号请使用半角逗号“,”分隔，如“138,139”。单次请求最大上限可提交 10000 个手机号码 |
project | string | 必需 | 无 | 模版 ID<br/>在 SUBMAIL > Message >项目中查看你所创建的短信模版 ID。请参见获取项目 ID |
vars | jsonstring | 必需 | 无 | 使用文本变量动态控制短信中的文本。 参阅 了解如何创建和使用文本变量 |
sms_signature | string | 可选 | 无 | 自定义短信签名，如果忽略此参数，将使用模板的默认签名作为签名 |
tag | string | 可选 | 无 | 自定义标签功能，该标签可用作SUBHOOK追踪 （32 个字符以内，添加了 tag 参数的 API 请求，会在所有的 SUBHOOK 事件中携带此参数。tag参数不参加加密计算） |
timestamp | string | 可选 | 无 | 参阅 API 授权与验证机制 > Timestamp UNIX 时间戳 |
sign_type | string | 可选 | normal | API 授权模式（ md5 or sha1 or normal ）参阅 API 授权与验证机制 > 授权和验证方式 |
sign_version | string | 可选 | 无 | signature加密计算方式 (当sign_version传2时，vars参数不参与加密计算) |
代码示例
发送请求
request: curl -d "appid=***&signature=***&project=xxxx&to=138xxxx,139xxxx" https://api-v4.mysubmail.com/sms/batchxsend响应
{
"status": "success", //请求状态
"batchlist": "***", //任务ID
"total_fee": 2, //总计费条数
"responses": [
{
"status": "success", //单号状态
"to": "138xxxxxx", //号码
"send_id": "007cb85168d1450e7aca462462ef12b8", //单号 SEND ID
"fee": 1 //单号计费条数
},
{
"status": "success",
"to": "139xxxxxx",
"send_id": "de4e69f475d24aad62948ac601e1c0ac",
"fee": 1
}
]
}请求失败
{
"status":"error",
"code":"1xx",
"msg":"error message"
}错误代码
参阅 API 错误代码