SendBatchCardSms
批量发送卡片短信
服务地址:
华东1 金融云
输入参数
只看必填
CardTemplateCode卡片短信模板Code
SmsTemplateCode回落文本短信的模板Code
FallbackType回落类型
DigitalTemplateCode回落数字短信的模板Code
OutId预留给调用方使用的ID
PhoneNumberJson接收短信的手机号码
SignNameJson短信签名名称
CardTemplateParamJson卡片短信模板参数对应的实际值
SmsTemplateParamJson文本短信模板参数对应的实际值
DigitalTemplateParamJson数字短信模板参数对应的实际值
SmsUpExtendCodeJson上行短信扩展码
TemplateCode自定义发送内容模板CODE
TemplateParamJson自定义发送内容模板变量对应的实际值
插件下载了解更多
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.

接口说明

  • 发送卡片短信为计费接口,卡片短信发送失败或渲染失败时不计费,详情请参见多媒体短信定价
  • 目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或联系阿里云售前咨询
  • 卡片短信超时时间建议设置为≥3S;发生超时失败的情况时,建议查看回执状态后再判断是否重试。同时建议您在调用此接口时,不要开启 SDK 重试逻辑,否则可能会造成多次发送的情况。超时和重试的相关设置,请参见超时机制重试机制
  • 国内短信、国际短信及多媒体短信目前均不支持幂等的能力,请您做好幂等控制,防止因多次重试而导致的重复操作问题。
  • 发送卡片短信前需添加卡片短信模板且模板审核通过。本接口在发送短信时,会校验号码是否支持卡片短信。如果该手机号不支持发送卡片短信,可在接口中设置是否接受数字短信和文本短信的回落,提升发送的触达率。
  • 批量发送卡片短信,每个号码可以使用不同的签名,不同的回落。在一次请求中,最多可以向 100 个手机号码分别发送卡片短信。

QPS 限制

本接口的单用户 QPS 限制为 1000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

请求参数

字段名称字段详情
CardTemplateCodestring

卡片短信模板 Code。请在控制台卡片短信模板管理页面选择已通过审核的卡片短信模板 Code。

示例值:CARD_SMS_3**5
SmsTemplateCodestring

回落文本短信的模板 Code。FallbackType 选择 SMS 回落文本短信时,此参数必填。展开详情

示例值:SMS_23425****
FallbackTypestring

回落类型。取值:展开详情

示例值:SMS
DigitalTemplateCodestring

回落数字短信的模板 Code。FallbackType 选择 DIGITALSMS 回落数字短信时,此参数必填。展开详情

示例值:DIGITAL_SMS_23408****
OutIdstring

预留给调用方使用的 ID。

示例值:16545681783595370
PhoneNumberJsonstring

接收短信的手机号码。

示例值:["1390000****","1370000****"]
SignNameJsonstring

短信签名名称。展开详情

示例值:["阿里云","阿里巴巴"]
CardTemplateParamJsonstring

卡片短信模板参数对应的实际值。CardTemplateCode 卡片短信模板内含有变量时,此参数必填。展开详情

示例值:[{"customurl":"http://www.alibaba.com","dyncParams":"{"a":"hello","b":"world"}"}]
SmsTemplateParamJsonstring

文本短信模板参数对应的实际值。SmsTemplateCode 回落的文本短信模板内含有变量时,此参数必填。展开详情

示例值:[{"a":1,"b":2},{"a":9,"b":8}]
DigitalTemplateParamJsonstring

数字短信模板参数对应的实际值。DigitalTemplateCode 回落的数字短信模板内含有变量时,此参数必填。展开详情

示例值:[{"a":1,"b":2},{"a":9,"b":8}]
SmsUpExtendCodeJsonstring

上行短信扩展码。

示例值:[\"6\",\"6\"]
TemplateCodestring

自定义发送内容模板 CODE。展开详情

示例值:SMS_20375****参考取值来源:
    UpdateSmsTemplate
    CreateSmsTemplate
    QuerySmsTemplateList
TemplateParamJsonstring

自定义发送内容模板变量对应的实际值。TemplateCode 填入包含变量的短信模板时,此参数必填。展开详情

示例值:[{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]

返回参数

字段名称字段详情
Codestring

请求状态码。展开详情

示例值:OK
RequestIdstring

请求 ID。

示例值:A90E4451-FED7-49D2-87C8-00700A8C4D0D
Successboolean

调用接口是否成功。取值:展开详情

示例值:true
Dataobject

返回数据。

变更历史
变更时间变更内容概要操作
2022-09-30
新增请求参数TemplateCode
新增请求参数TemplateParamJson
2022-06-17
新增OpenAPI,批量发送卡片短信