獲取卡片短信短鏈。
接口說明
調試
您可以在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 錯誤碼發生變更 | 查看變更詳情 |