请求方式
POST
访问路径
/openapi/call/sms/v1/sendSms
短信请求参数
| 参数 | 是否必填 | 参数类型 | 示例 | 含义 |
|---|---|---|---|---|
| msg | 是 | String | kf系统报备后的短信内容 | |
| params | 是 | List | 发送集合,最大不能超过500 | |
| mobile | 是 | String | 150xxxxxxxx | 待发送的手机号 |
| vars | 否 | JSON | {"var1":"张三","var2":"4.14日"} | 有变量的模板,发送时需填写的参数 |
| msgId | 否 | String | 691034450712944640 | 当前短信的自定义id 最长32位,支持uuid或是guid格式,与推送短信状态的msgId相对应, |
| type | 是 | String | "CL" 或 "JJ"或""ZT" | 短信固定参数 |
| smsType | 是 | int | 1 | 短信类型:1 营销 ;2 验证码; 3 通知; 4 金融; 5 彩信; 6 闪信 |
| templateId | 否 | String | 83141365035539251123 | 当type为ZT时,则templateId必传 |
请求示例
非变量模板请求示例
{
"msg":"【极简科技】亲,您的订单审核通过出库中。稍后客服将跟您电话确认收货信息,请务必保持电话畅通!客服电话4001540085",
"params":[{
"mobile":"13778220778",
"vars":{
}
}],
"type":"CL",
"smsType" :3
"msgId":"691034450712944640"
}变量模板请求示例
{
"msg":"【极简科技】尊敬的用户:订单号{var1}审核通过出库中。稍后客服{var2}将跟您电话确认收货信息,请务必保持电话畅通!",
"params":[{
"mobile":"13778220778",
"vars":{
"var1":"tr",
"var2":"tr",
}
}],
"type":"CL",
"smsType" :3,
"msgId":"691034450712944640"
}返回参数
| 字段名称 | 字段类型 | 字段描述 |
| success | boolean | 请求是否成功 |
| message | String | 响应结果 |
| code | String | 响应码 |
| data | String | 响应文本 |
| msgId | String | 当前短信的自定义id 最长32位,支持uuid或是guid格式,与推送短信状态的msgId相对应, |
返回值示例:
模板不存在:
{
"success": false,
"message": "模板不存在",
"code": "0000012",
"data": null
}发送成功
{
"success": true,
"message": "200 ok!",
"code": "200",
"data": null
"msgId":"691034450712944640"
}