发送卡片短信。
接口说明
- 卡片短信超时时间建议设置为≥3S；发生超时失败的情况时，建议查看回执状态后再判断是否重试。同时建议您在调用此接口时，不要开启 SDK 重试逻辑，否则可能会造成多次发送的情况。超时和重试的相关设置，请参见超时机制、重试机制。
- 国内短信、国际短信及多媒体短信目前均不支持幂等的能力，请您做好幂等控制，防止因多次重试而导致的重复操作问题。
- 发送卡片短信前需添加卡片短信模板且模板审核通过。本接口在发送短信时，会校验号码是否支持卡片短信。如果该手机号不支持发送卡片短信，可在接口中设置是否接受数字短信和文本短信的回落，提升发送的触达率。
QPS 限制
本接口的单用户 QPS 限制为 1000 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dysms:SendCardSms | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CardObjects | array<object> | 是 | 卡片短信对象。 | |
| object | 是 | 卡片短信对象。 | ||
| customUrl | string | 否 | 渲染失败后跳转链接。 | https://alibaba.com |
| dyncParams | string | 否 | 动态参数。动参变量不需要${} | {\"param3\":\"李四3\",\"param1\":\"李四\",\"param2\":\"李四2\"} |
| mobile | string | 否 | 手机号码。 | 1390000**** |
| SignName | string | 是 | 短信签名名称。请在控制台国内消息页面中的签名管理页签下签名名称一列查看。 说明
必须是通过审核的短信签名。
| 阿里云 |
| CardTemplateCode | string | 是 | 卡片短信模板 Code。请在控制台国内消息页面中的模板管理页签下模板 CODE一列查看。 说明
必须是已添加、并通过审核的卡片短信模板。
| CARD_SMS_70 |
| SmsTemplateCode | string | 是 | 回落文本短信的模板 Code。请在控制台国内消息页面中的模板管理页签下模板 CODE一列查看。 说明
必须是已添加、并通过审核的短信模板。FallbackType 为 SMS 时为必填。
| SIER_TEST_01 |
| SmsUpExtendCode | string | 否 | 上行短信扩展码。上行短信，指发送给通信服务提供商的短信，用于定制某种服务、完成查询，或是办理某种业务等，需要收费的，按运营商普通短信资费进行扣费。 说明
无上述需求的用户请忽略此字段。
| 1 |
| FallbackType | string | 是 | 回落类型。取值：
| SMS |
| DigitalTemplateCode | string | 否 | 回落数字短信的模板 Code。请在控制台国内消息页面中的模板管理页签下模板 CODE一列查看。 说明
必须是已添加、并通过审核的短信模板。
| SMS_003 |
| OutId | string | 否 | 预留给调用方使用的 ID。 | 38d76c9b-4a9a-4c89-afae-61fd8e0e**** |
| SmsTemplateParam | string | 否 | 回落文本短信的模板变量对应的实际值。 说明
如果 JSON 中需要带换行符，请参照标准的 JSON 协议处理。
| {\"jifen\":\"回落参数\"} |
| DigitalTemplateParam | string | 否 | 回落数字短信的模板变量对应的实际值。 说明
如果 JSON 中需要带换行符，请参照标准的 JSON 协议处理。
| {\"msg\",\"xxxd\"} |
| TemplateCode | string | 否 | 文本短信模板 CODE。 请在控制台国内消息或国际/港澳台消息页面中的模板管理页签下模板 CODE一列查看。 说明
必须是已添加、并通过审核的模板 CODE；且发送国际/港澳台消息时，请使用国际/港澳台短信模版。
| SMS_2322**** |
| TemplateParam | string | 否 | 短信模板变量对应的实际值，JSON 格式。 说明
如果 JSON 中需要带换行符，请参照标准的 JSON 协议处理。
| { \"code\": \"1111\" } |
返回参数
示例
正常返回示例
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 status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 200 | ForbiddenAction | Access to the account is denied. Please contact the administrator. | 没有访问权限，请联系管理员 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-09 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |