发送短信
接口功能
用户调用IoT云通信的发送消息接口进行短信下发。此接口可以下发单条消息，也可以下发多条消息。
接口地址
项目 |
描述 |
|---|---|
消息方向 |
SP-> IoT云通信 |
方法 |
HTTPS + POST |
URI |
https://{IP:Port}/common/sms/sendTemplateMessage
说明：
IP:Port表示IoT云通信的IP和端口号，IP和端口号在申请开通接入完成后由系统自动分配，可通过“控制台 > 国内短信 > 开通接入”页面进行查看。 |
请求消息
参数列表 |
类型 |
必选/可选 |
最大长度 |
描述信息 |
|---|---|---|---|---|
account |
String |
必选 |
30 |
账号。 |
password |
String |
必选 |
100 |
密码：明文密码。
说明：
账号、密码是在短信控制台申请开通接入且审核通过后，由系统发送至用户账号绑定的邮箱。 |
requestLists |
List<MtSmsMessage> |
必选 |
20 |
消息体，List长度最大支持20。MtSmsMessage参数填写请参见短信下发消息体MtSmsMessage。 |
requestId |
String |
可选 |
20 |
每次请求的id。 |
statusCallback |
String |
可选 |
1024 |
客户的回调地址，用于接收短信状态报告。 如：https://{IP:Port}/common/sms/notifyReportMessage 其中，IP:Port表示客户平台的IP和端口号。
|
extendInfos |
List<NamedParameter> |
可选 |
10 |
扩展信息。 |
请求消息样例（使用带变量的模板）： { "account": "account", "password":"password", "requestLists": [ { "mobiles":["12345678911"], "templateId":"sms1011", "templateParas":{"Name":"Amigo","time":"2020-04-30 23:59:59"}, "signature":"【华为】" } ], "requestId":"202003270923-0000001", "statusCallback":"https://ip:port/sms/notifySmsMessage" } 请求消息样例（使用无变量的模板）： { "account": "account", "password":"password", "requestLists": [ { "mobiles":["12345678911"], "templateId":"sms1011", "signature":"【华为】" } ], "requestId":"202003270923-0000001", "statusCallback":"https://ip:port/sms/notifySmsMessage" } |
||||
响应消息
参数列表 |
类型 |
必选/可选 |
最大长度 |
描述信息 |
|---|---|---|---|---|
resultCode |
String |
必选 |
6 |
结果码。 |
resultDesc |
String |
可选 |
100 |
结果描述。 |
resultLists |
List<MtSmsMessageRsp> |
可选 |
- |
返回本次下发的响应详情。MtSmsMessageRsp参数填写请参见短信下发响应对象MtSmsMessageRsp。 |
响应消息样例如下。 消息处理失败样例： { "resultCode":"100003", "resultDesc":" Parameter format error", "resultLists": null } 消息处理成功样例： { "resultCode":"0", "resultLists": [ { "mobile": "12345678911", "resultCode": "0", "resultDesc": "submit success, waiting for delivery report.", "messageId":"123456" }, { "mobile": "12345678912", "resultCode": "0", "resultDesc": "submit success, waiting for delivery report.", "messageId":"56789" } ] } |
||||
