首页 短信服务 API参考 API目录 卡片短信 SendCardSms - 发送卡片短信

SendCardSms - 发送卡片短信

发送卡片短信。

接口说明

  • 发送卡片短信前已添加卡片短信模板且模板审核通过,如果该手机号不支持发送卡片短信,SendCardSms接口支持数字短信和文本短信的回落,提升发送的触发率。
  • SendCardSms接口在发送短信时,会校验号码是否支持卡片短信。如果不支持可在接口中设置是否接受回落,如果不接受回落就直接返回失败。

QPS限制

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

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dysms:SendCardSmsRead
  • SMS
    acs:dysms:*:{#accountId}:*

请求参数

名称类型必填描述示例值
CardObjectsarray

卡片短信对象。

object

卡片短信对象。

customUrlstring

渲染失败后跳转链接。

https://alibaba.com
dyncParamsstring

动态参数。动参变量不需要${}

{\"param3\":\"李四3\",\"param1\":\"李四\",\"param2\":\"李四2\"}
mobilestring

手机号码。

1390000****
SignNamestring

短信签名名称。请在控制台国内消息页面中的签名管理页签下签名名称一列查看。

说明必须是通过审核的短信签名。
阿里云
CardTemplateCodestring

卡片短信模板Code。请在控制台国内消息页面中的模板管理页签下模板CODE一列查看。

说明必须是已添加、并通过审核的卡片短信模板。
CARD_SMS_70
SmsTemplateCodestring

回落文本短信的模板Code。请在控制台国内消息页面中的模板管理页签下模板CODE一列查看。

说明必须是已添加、并通过审核的短信模板。FallbackTypeSMS时为必填。
SIER_TEST_01
SmsUpExtendCodestring

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

说明无上述需求的用户请忽略此字段。
1
FallbackTypestring

回落类型。取值:

  • SMS:不支持卡片短信的号码,回落文本短信。
  • DIGITALSMS:不支持卡片短信的号码,回落数字短信。
  • NONE:不需要回落。
SMS
DigitalTemplateCodestring

回落数字短信的模板Code。请在控制台国内消息页面中的模板管理页签下模板CODE一列查看。

说明必须是已添加、并通过审核的短信模板。
SMS_003
OutIdstring

预留给调用方使用的ID。

38d76c9b-4a9a-4c89-afae-61fd8e0e****
SmsTemplateParamstring

回落文本短信的模板变量对应的实际值。

说明如果JSON中需要带换行符,请参照标准的JSON协议处理。
{\"jifen\":\"回落参数\"}
DigitalTemplateParamstring

回落数字短信的模板变量对应的实际值。

说明如果JSON中需要带换行符,请参照标准的JSON协议处理。
{"msg","xxxd"}
TemplateCodestring

文本短信模板CODE。

请在控制台国内消息国际/港澳台消息页面中的模板管理页签下模板CODE一列查看。

说明必须是已添加、并通过审核的模板CODE;且发送国际/港澳台消息时,请使用国际/港澳台短信模版。
SMS_2322****
TemplateParamstring

短信模板变量对应的实际值,JSON格式。

说明如果JSON中需要带换行符,请参照标准的JSON协议处理。
{"code":"1111"}

返回参数

名称类型描述示例值
object

返回数据。

Codestring

请求状态码。

OK
RequestIdstring

请求ID。

F655A8D5-B967-440B-8683-DAD6FF8D28D0
Successboolean

调用接口是否成功。取值:

  • true:调用成功。

  • false:调用失败。

true
Dataobject

返回数据。

MediaMobilesstring

发送卡片短信的手机号。

1390000****
BizCardIdstring

卡片短信发送ID。

123
BizDigitalIdstring

数字短信发送ID。

232
CardTmpStateinteger

卡片短信模板审核状态。

  • 0:审核中
  • 1:审核通过
  • 2:审核不通过
说明未审核通用的短信走回落流程。
0
NotMediaMobilesstring

回落的手机号。

1390000****
BizSmsIdstring

文本短信发送ID。

524

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8D28D0",
  "Success": true,
  "Data": {
    "MediaMobiles": "1390000****",
    "BizCardId": "123",
    "BizDigitalId": "232",
    "CardTmpState": 0,
    "NotMediaMobiles": "1390000****",
    "BizSmsId": "524"
  }
}

错误码

Http code错误码错误信息描述
200ForbiddenActionAccess to the account is denied. Please contact the administrator.没有访问权限,请联系管理员

访问错误中心查看更多错误码。

阿里云首页 短信服务 相关技术圈