SendCardSms_短信服务_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.

接口说明

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

QPS 限制

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

流控信息

请求速率为1000/1(s)。更多流控信息,请前往配额中心查看

授权信息

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

请求参数

字段名称字段详情
CardObjectsarray<object>

卡片短信对象。

示例值:SendCardSms
SignNamestring

短信签名名称。您可以通过 QuerySmsSignList 接口查询当前账号已申请的签名或在短信服务控制台查看签名列表。展开详情

示例值:阿里云参考取值来源:
    CreateSmsSign
    UpdateSmsSign
    AddSmsSign
    QuerySmsSignList
    ModifySmsSign
CardTemplateCodestring

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

示例值:CARD_SMS_70
SmsTemplateCodestring

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

示例值:SMS_48068****
SmsUpExtendCodestring

上行短信扩展码。上行短信,指发送给通信服务提供商的短信,用于定制某种服务、完成查询,或是办理某种业务等,需要收费的,按运营商普通短信资费进行扣费。展开详情

示例值:1
FallbackTypestring

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

示例值:SMS
DigitalTemplateCodestring

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

示例值:DIGITAL_SMS_31359****
OutIdstring

预留给调用方使用的 ID。

示例值:38d76c9b-4a9a-4c89-afae-61fd8e0e****
SmsTemplateParamstring

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

示例值:{"jifen":"积分"}
DigitalTemplateParamstring

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

示例值:{"msg","xxxd"}
TemplateCodestring

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

示例值:SMS_2322****参考取值来源:
    UpdateSmsTemplate
    CreateSmsTemplate
    QuerySmsTemplateList
TemplateParamstring

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

示例值:{ "code": "1111" }

返回参数

字段名称字段详情
Codestring

请求状态码。展开详情

示例值:OK
RequestIdstring

请求 ID。

示例值:F655A8D5-B967-440B-8683-DAD6FF8D28D0
Successboolean

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

示例值:true
Dataobject

返回数据。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
200
ForbiddenAction
Access to the account is denied. Please contact the administrator.诊断

变更历史

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

相关示例

发送卡片短信
2022-06-22