模板发送接口
说明
- 请求前请将发送ip配置到商户IP白名单
- 模板必须是已审核的短信模板，与签名绑定
- 可支持多个手机号发送相同内容
- 商户订单号作为商户自身标识，可由商户自定义，多次传入相同订单号，不保持幂等返回，即同一笔订单商户订单号相同，会生成多个订单下发。
HTTP头信息
| 参数 | 内容 |
|---|---|
| Accept | application/json;charset=utf-8; |
| Content-Type | application/json;charset=utf-8; |
| merchantId | {对应商户id} |
| sign | {签名，生成方式详见开发引导-接口验签部分} |
请求
URL: https://api.moziapi.com/sms/send/template
请求方式: POST
请求参数
| 参数 | 类型 | 最大长度 | 是否必填 | 说明 |
|---|---|---|---|---|
| merchantOrderId | string | 64 | 否 | 商户订单号，接入可自定义，选填。 |
| tplId | int | 是 | 已审核模板id，模板id可在【商户后台-模板管理】处查询 | |
| parameter | map | 是 | 参数健值对，无参数传空map{} | |
| mobiles | string | 是 | 暂不支持国际号码，支持11位手机号, 一次最多100个手机号，使用英文,分隔 |
json请求参数示例
{
"merchantOrderId":"12219873912837",
"tplId":10003,
"parameter":{
"name":"用户A",
"num":900
},
"mobiles":"1522000xxxx,1581230xxxx"
}
响应结果
| 参数 | 类型 | 最大长度 | 是否必填 | 说明 |
|---|---|---|---|---|
| merchantOrderId | string | 64 | 否 | 商户提交的订单号 |
| status | int | 1 | 是 | 响应状态：1：成功；0：失败 |
| code | string | 4 | 否 | 响应错误码 |
| msg | string | 128 | 否 | 响应错误信息 |
| result | resultObj[] | 100 | 否 | 发送单/多个手机号结果 |
| resultObj.mobile | string | 11 | 是 | 手机号码 |
| resultObj.code | string | 7 | 是 | 标识码 B000000-发送成功 其余请参照错误码表 |
| resultObj.msg | string | 128 | 是 | 状态描述 |
| resultObj.orderId | int | 20 | 是 | 平台订单号 |
json返回正确参数示例
{
"merchantOrderId": "12219873912837",
"status":1,
"result": [
{
"mobile": "1522000xxxx",
"code": "B000000",
"msg": "成功",
"orderId": 298451059435671552
},
{
"mobile": "1581230xxxx",
"code": "B000000",
"msg": "成功",
"orderId": 298451059444060160
}
]
}
json返回错误参数示例
{
"merchantOrderId": "12219873912837",
"status": 0,
"code": "B100001",
"msg": "白名单校验未通过"
}