使用短信模板发送短信,只支持发往中国内地。
接口说明
使用说明
SendMessageWithTemplate 接口仅支持往中国内地发送短信。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dysms:SendMessageWithTemplate |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| To |
string |
是 |
接收短信号码。号码格式为:国际区号+号码。例如:861503871****。 电话代码详情,请参见电话代码。 |
861503871**** |
| From |
string |
是 |
发送方标识,请传入短信签名名称。您可以登录短信服务控制台,选择发往中国大陆 > 短信签名,在短信签名列表查看签名名称。 |
Alicloud321 |
| TemplateCode |
string |
是 |
短信模板编码。您可以登录短信服务控制台,选择发往中国大陆 > 短信内容,在短信内容列表查看短信模板编码。 |
SMS_**** |
| TemplateParam |
string |
否 |
短信模板变量对应的实际值。如果模板中存在变量,该参数为必填项。 |
{"code":"1234","product":"ytx"} |
| SmsUpExtendCode |
string |
否 |
上行短信扩展码。 |
90999 |
| ValidityPeriod |
integer |
否 |
短信有效时长 |
1 |
| ChannelId |
string |
否 |
通道 ID |
5739 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| ResponseCode |
string |
短信提交状态。 |
OK |
| NumberDetail |
object |
号码明细。 |
|
| Carrier |
string |
号码所属的运营商网络。 |
China Mobile |
| Region |
string |
号码所属地区。 |
Nanjing, Jiangsu |
| Country |
string |
号码所属国家。 |
China |
| ResponseDescription |
string |
短信提交状态的详细描述。 |
The SMS Send Request was accepted |
| Segments |
string |
短信计费条数。 |
1 |
| To |
string |
接收短信号码。号码格式为:国际区号+号码。例如:861503871****。 |
861503871**** |
| MessageId |
string |
消息 ID。 |
1**************3 |
| RequestId |
string |
请求 ID。 |
F655A8D5-B967-440B-8683-DAD6FF8D23D6 |
示例
正常返回示例
JSON格式
{
"ResponseCode": "OK",
"NumberDetail": {
"Carrier": "China Mobile",
"Region": "Nanjing, Jiangsu",
"Country": "China"
},
"ResponseDescription": "The SMS Send Request was accepted",
"Segments": "1",
"To": "861503871****",
"MessageId": "1**************3",
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8D23D6"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。