發(fā)送卡片短信。
接口說明
- 卡片短信超時時間建議設(shè)置為≥3S;發(fā)生超時失敗的情況時,建議查看回執(zhí)狀態(tài)后再判斷是否重試。同時建議您在調(diào)用此接口時,不要開啟 SDK 重試邏輯,否則可能會造成多次發(fā)送的情況。超時和重試的相關(guān)設(shè)置,請參見超時機制、重試機制。
- 國內(nèi)短信、國際短信及多媒體短信目前均不支持冪等的能力,請您做好冪等控制,防止因多次重試而導(dǎo)致的重復(fù)操作問題。
- 發(fā)送卡片短信前需添加卡片短信模板且模板審核通過。本接口在發(fā)送短信時,會校驗號碼是否支持卡片短信。如果該手機號不支持發(fā)送卡片短信,可在接口中設(shè)置是否接受數(shù)字短信和文本短信的回落,提升發(fā)送的觸達率。
QPS 限制
本接口的單用戶 QPS 限制為 1000 次/秒。超過限制,API 調(diào)用會被限流,這可能會影響您的業(yè)務(wù),請合理調(diào)用。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dysms:SendCardSms | get | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CardObjects | array<object> | 是 | 卡片短信對象。 | |
object | 是 | 卡片短信對象。 | ||
customUrl | string | 否 | 渲染失敗后跳轉(zhuǎn)鏈接。 | https://alibaba.com |
dyncParams | string | 否 | 動態(tài)參數(shù)。動參變量不需要${} | {\"param3\":\"李四3\",\"param1\":\"李四\",\"param2\":\"李四2\"} |
mobile | string | 否 | 手機號碼。 | 1390000**** |
SignName | string | 是 | 短信簽名名稱。請在控制臺國內(nèi)消息頁面中的簽名管理頁簽下簽名名稱一列查看。 說明
必須是通過審核的短信簽名。
| 阿里云 |
CardTemplateCode | string | 是 | 卡片短信模板 Code。請在控制臺國內(nèi)消息頁面中的模板管理頁簽下模板 CODE一列查看。 說明
必須是已添加、并通過審核的卡片短信模板。
| CARD_SMS_70 |
SmsTemplateCode | string | 是 | 回落文本短信的模板 Code。請在控制臺國內(nèi)消息頁面中的模板管理頁簽下模板 CODE一列查看。 說明
必須是已添加、并通過審核的短信模板。FallbackType 為 SMS 時為必填。
| SIER_TEST_01 |
SmsUpExtendCode | string | 否 | 上行短信擴展碼。上行短信,指發(fā)送給通信服務(wù)提供商的短信,用于定制某種服務(wù)、完成查詢,或是辦理某種業(yè)務(wù)等,需要收費的,按運營商普通短信資費進行扣費。 說明
無上述需求的用戶請忽略此字段。
| 1 |
FallbackType | string | 是 | 回落類型。取值:
| SMS |
DigitalTemplateCode | string | 否 | 回落數(shù)字短信的模板 Code。請在控制臺國內(nèi)消息頁面中的模板管理頁簽下模板 CODE一列查看。 說明
必須是已添加、并通過審核的短信模板。
| SMS_003 |
OutId | string | 否 | 預(yù)留給調(diào)用方使用的 ID。 | 38d76c9b-4a9a-4c89-afae-61fd8e0e**** |
SmsTemplateParam | string | 否 | 回落文本短信的模板變量對應(yīng)的實際值。 說明
如果 JSON 中需要帶換行符,請參照標準的 JSON 協(xié)議處理。
| {\"jifen\":\"回落參數(shù)\"} |
DigitalTemplateParam | string | 否 | 回落數(shù)字短信的模板變量對應(yīng)的實際值。 說明
如果 JSON 中需要帶換行符,請參照標準的 JSON 協(xié)議處理。
| {\"msg\",\"xxxd\"} |
TemplateCode | string | 否 | 文本短信模板 CODE。 請在控制臺國內(nèi)消息或國際/港澳臺消息頁面中的模板管理頁簽下模板 CODE一列查看。 說明
必須是已添加、并通過審核的模板 CODE;且發(fā)送國際/港澳臺消息時,請使用國際/港澳臺短信模版。
| SMS_2322**** |
TemplateParam | string | 否 | 短信模板變量對應(yīng)的實際值,JSON 格式。 說明
如果 JSON 中需要帶換行符,請參照標準的 JSON 協(xié)議處理。
| { \"code\": \"1111\" } |
返回參數(shù)
示例
正常返回示例
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. | 沒有訪問權(quán)限,請聯(lián)系管理員 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-09-09 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |