SendMessageWithTemplate_短信服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

SendMessageWithTemplate 接口仅支持往中国内地发送短信。

流控信息

请求速率为1500/1(s)。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
Tostring

接收短信号码。号码格式为:国际区号+号码。例如:861503871****。展开详情

示例值:861503871****
Fromstring

发送方标识,请传入短信签名名称。您可以登录短信服务控制台,选择发往中国大陆 > 短信签名,在短信签名列表查看签名名称。

示例值:Alicloud321
TemplateCodestring

短信模板编码。您可以登录短信服务控制台,选择发往中国大陆 > 短信内容,在短信内容列表查看短信模板编码。

示例值:SMS_****
TemplateParamstring

短信模板变量对应的实际值。如果模板中存在变量,该参数为必填项。

示例值:{"code":"1234","product":"ytx"}
SmsUpExtendCodestring

上行短信扩展码。

示例值:90999
ValidityPeriodinteger<int64>

短信有效时长

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1
ChannelIdstring

通道 ID

示例值:5739

返回参数

字段名称字段详情
ResponseCodestring

短信提交状态。

示例值:OK
NumberDetailobject

号码明细。

ResponseDescriptionstring

短信提交状态的详细描述。

示例值:The SMS Send Request was accepted
Segmentsstring

短信计费条数。

示例值:1
Tostring

接收短信号码。号码格式为:国际区号+号码。例如:861503871****。

示例值:861503871****
MessageIdstring

消息 ID。

示例值:1**************3
RequestIdstring

请求 ID。

示例值:F655A8D5-B967-440B-8683-DAD6FF8D23D6

返回示例

变更历史

变更时间变更内容概要操作
2024-03-28
新增请求参数ChannelId
2023-06-27
新增请求参数ValidityPeriod
2021-03-03
变更返回参数

相关示例

通过云通信OpenApi 调用 SendMessageWithTemplate 发送中国内地(大陆)短信
2021-12-21