获取卡片短信短链。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dysms:GetCardSmsLink | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CardTemplateCode | string | 是 | 卡片短信模板 Code。请在控制台国内消息页面中的模板管理页签下模板 CODE一列查看。 说明
必须是已添加、并通过审核的短信模板。
| CARD_SMS_**** |
| OutId | string | 否 | 外部流水扩展字段。 | BC20220608102511660860762**** |
| PhoneNumberJson | string | 否 | 手机号码、用户 ID 或系统内部标识。 说明
| [\"1390000**** \",\"1370000**** \"] |
| SignNameJson | string | 是 | 短信签名名称。 请在控制台国内消息页面中的签名管理页签下签名名称一列查看。 说明
必须是已添加、并通过审核的短信签名；且短信签名的个数必须与手机号码的个数相同、内容一一对应。
| [\"阿里云\", \"阿里云2\"] |
| CardTemplateParamJson | string | 否 | 卡片短信动参。 | [{\"customUrl\":\"https://alibaba.com\",\"dyncParams\": \"{\\\"动参key\\\":\\\"动参value\\\"}\"},{\"customUrl\":\"https://alibaba.com\",\"dyncParams\": \"{\\\"动参key\\\":\\\"动参value\\\"}\"}] |
| CardCodeType | integer | 否 | 卡片短信短链编码类型。
| 2 |
| CardLinkType | integer | 否 | 卡片短信短链类型。
说明
CardLinkType 不填时，默认为标准生成短码。如需生成自定义短码，请联系阿里运营人员进行报备。
| 1 |
| Domain | string | 否 | 发送账号分配的短链域名，需要提前报备。 说明
| xxx.com |
| CustomShortCodeJson | string | 否 | 客户自定义短码。长度为 4~8 位的数字或字母。 说明
当生成类型为自定义生成短码时必填。
| abCde |
返回参数
示例
正常返回示例
JSON格式
{
"Code": "OK",
"RequestId": "CC89A90C-978F-46AC-B80D-54738371E7CA",
"Success": true,
"Data": {
"CardTmpState": 0,
"NotMediaMobiles": "1390000****",
"CardPhoneNumbers": "[\\\"1390000****\\\",\\\"1370000****\\\"]",
"CardSmsLinks": "[\\\"mw2m.cn/LAaGGa\\\",\\\"mw2m.cn/LAAaes\\\"]",
"CardSignNames": "[\"阿里云\",\"阿里云2\"]"
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 200 | ForbiddenAction | Access to the account is denied. Please contact the administrator. | 没有访问权限，请联系管理员 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-09-09 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |