API: SMS/BatchXSend - 短信批量模板群发


概览


sms/batchxsend 是 SUBMAIL 的批量短信发送接口。与 sms/xsend 接口相似,在请求中自由提交短信内容,to (联系人)参数可以批量提交联系人手机号码(单次请求最大支持 10000 个)大幅提高群发需求的发送效率。



URL


https://api-v4.mysubmail.com/sms/batchxsend


支持格式


格式URL
jsonhttps://api-v4.mysubmail.com/sms/batchxsend.json (默认)
xmlhttps://api-v4.mysubmail.com/sms/batchxsend.xml
yamlhttps://api-v4.mysubmail.com/sms/batchxsend.yaml


http 请求方式


请求方式content-type设置
http postmultipart/form-data、x-www-form-urlencoded、application/json


是否需要授权


参阅 API 授权和验证机制


sms/batchxsend POST 方法请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短信应用ID
tostring必需收件人手机号码,多个手机号请使用半角逗号“,”分隔,如“138,139”。单次请求最大上限可提交 10000 个手机号码
projectstring必需模版 ID<br/>在 SUBMAIL > Message >项目中查看你所创建的短信模版 ID。请参见获取项目 ID
varsjsonstring必需使用文本变量动态控制短信中的文本。 参阅 了解如何创建和使用文本变量
tagstring可选自定义标签功能,该标签可用作SUBHOOK追踪
(32 个字符以内,添加了 tag 参数的 API 请求,会在所有的 SUBHOOK 事件中携带此参数。tag参数不参加加密计算)
timestampUNIX 时间戳可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal
参阅 API 授权与验证机制 > 授权和验证方式
sign_versionstring可选signature加密计算方式
(当sign_version传2时,content参数不参与加密计算)
signaturestring必需应用密匙或数字签名
参阅 API授权与验证机制 > 授权和验证方式。当sign_type=normal时signature应传appkey的值。


代码示例


发送请求
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 错误代码