SY-P10-1.0.013
API: newVision/batchxsend - 批量发送
概览
newVision/batchxsend 是 SUBMAIL 的5G新视通群发 API 。
newVision/batchxsend 提供完整且强大的群发发送功能，解决开发者在应用场景中的群发营销信息的需求，具有极大的 API 并发效率。
URL
https://api-v4.mysubmail.com/newVision/batchxsend
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/newVision/batchxsend.json （默认） |
xml | https://api-v4.mysubmail.com/newVision/batchxsend.xml |
yaml | https://api-v4.mysubmail.com/newVision/batchxsend.yaml |
http 请求方式
| 请求方式 | content-type设置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授权
是
参阅 API 授权和验证机制
请求参数
| 参数 | 类型 | 必需/可选 | 默认 | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 无 | 在 SUBMAIL 应用集成中创建的彩信应用 ID |
project | string | 必需 | 无 | 模板标记（ID） |
to | string | 必需 | 无 | 联系人手机号集合，多个号码用半角英文逗号分隔，单次提交最大支持1000个号码 示例：15212345678,18600000000,19911112222 |
tag | string | 可选 | 无 | 自定义标签功能，该标签可用作SUBHOOK追踪（32 个字符以内） |
timestamp | UNIX 时间戳 | 可选 | 无 | 参阅 API 授权与验证机制 > Timestamp UNIX 时间戳 |
sign_type | string | 可选 | normal | API 授权模式，可选参数： sha256、md5、sha1、normal <br/>参阅 API 授权与验证机制 > 授权和验证方式 |
signature | string | 必需 | 无 | 应用密匙或数字签名 参阅 API授权与验证机制 > 授权和验证方式 |
代码示例
发送一封测试短信
POST URL
https://api-v4.mysubmail.com/newVision/batchxsendPOST DATA
appid=your_appid&project=ThJBE4&signature=your_app_key&to=15212345678返回
{
"status": "success",
"total_fee": 0.35,
"responses": [
{
"status": "success",
"to": "15212345678",
"send_id": "00ad714ae189439b6c4f8482cee29004",
"fee": 0.35
}
]
}请求失败
{
"status": "error",
"code": 252,
"msg": "Incorrect recipient message address, if you are using the addressbook model, this addressbook does not have any contacts"
}注：如果联系人地址中包含多个联系人，接口只会返回请求成功的联系人列表
错误代码
参阅 API 错误代码