获取卡片短信短链。
接口说明
目前卡片短信在内部邀约阶段,请联系您的阿里云商务经理申请开通或联系阿里云售前咨询。
QPS 限制
本接口的单用户 QPS 限制为 1000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dysms:GetCardSmsLink |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| CardTemplateCode |
string |
是 |
卡片短信模板 Code。请在控制台卡片短信>模板管理页面选择已通过审核的卡片短信模板 Code。 |
CARD_SMS_**** |
| OutId |
string |
否 |
外部流水扩展字段。 |
BC20220608102511660860762**** |
| PhoneNumberJson |
string |
否 |
手机号码、用户 ID 或系统内部标识。 说明
|
[\"1390000**** \",\"1370000**** \"] |
| SignNameJson |
string |
是 |
短信签名名称。 请在控制台国内消息>签名管理页签下签名名称一列查看。也可通过 QuerySmsSignList 接口查看的短信签名名称。 说明
必须是已添加、并通过审核的短信签名;且短信签名的个数必须与手机号码的个数相同、内容一一对应。 |
[\"阿里云\", \"阿里云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 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| Code |
string |
请求状态码。取值:
|
OK |
| RequestId |
string |
请求 ID。 |
CC89A90C-978F-46AC-B80D-54738371E7CA |
| Success |
boolean |
接口调用是否成功。取值:
|
true |
| Data |
object |
返回数据。 |
|
| CardTmpState |
integer |
卡片短信模板审核状态。取值:
说明
未审核通过的短信走回落流程。 |
0 |
| NotMediaMobiles |
string |
不支持卡片短信的手机号。 |
1390000**** |
| CardPhoneNumbers |
string |
支持卡片短信的手机号码。 |
[\"1390000****\",\"1370000****\"] |
| CardSmsLinks |
string |
卡片短信短链。 |
[\"mw2m.cn/LAaGGa\",\"mw2m.cn/LAAaes\"] |
| CardSignNames |
string |
用于申请卡片短信短链的短信签名,在发送时签名、接收号码、卡片短信短链要一一对应。 |
["阿里云","阿里云2"] |
示例
正常返回示例
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. | 没有访问权限,请联系管理员。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。