发送短信接口

此接口可以供第三方平台在自己的系统中实现发送短信的能力

访问路径

POST   openapi/call/sms/v1/sendSms

短信请求参数

参数是否必填参数类型示例含义
msgStringkf系统报备后的短信内容
paramsList发送集合,最大不能超过500
mobileString150xxxxxxxx待发送的手机号
varsJSON{"var1":"张三","var2":"4.14日"}有变量的模板,发送时需填写的参数
msgIdString691034450712944640当前短信的自定义id 最长32位,支持uuid或是guid格式,与推送短信状态的msgId相对应,
typeString"CL" 或 "JJ"或""ZT"短信固定参数
smsTypeint1短信类型:1 营销 ;2 验证码; 3 通知; 4 金融; 5 彩信; 6 闪信
templateIdString83141365035539251123当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": false, "message": "模板不存在", "code": "0000012", "data": null }
发送成功
{ "success": true, "message": "200 ok!", "code": "200", "data": null "msgId":"691034450712944640" }
2024-08-02