批量發送卡片短信。
接口說明
- 卡片短信超時時間建議設置為≥3S；發生超時失敗的情況時，建議查看回執狀態后再判斷是否重試。同時建議您在調用此接口時，不要開啟 SDK 重試邏輯，否則可能會造成多次發送的情況。超時和重試的相關設置，請參見超時機制、重試機制。
- 國內短信、國際短信及多媒體短信目前均不支持冪等的能力，請您做好冪等控制，防止因多次重試而導致的重復操作問題。
- 發送卡片短信前需添加卡片短信模板且模板審核通過。本接口在發送短信時，會校驗號碼是否支持卡片短信。如果該手機號不支持發送卡片短信，可在接口中設置是否接受數字短信和文本短信的回落，提升發送的觸達率。
- 批量發送卡片短信，每個號碼可以使用不同的簽名，不同的回落。在一次請求中，最多可以向 100 個手機號碼分別發送卡片短信。
QPS 限制
本接口的單用戶 QPS 限制為 1000 次/秒。超過限制，API 調用會被限流，這可能會影響您的業務，請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dysms:SendBatchCardSms | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CardTemplateCode | string | 是 | 卡片短信模板 Code。請在控制臺國內消息頁面中的模板管理頁簽下模板 CODE一列查看。 說明
必須是已添加、并通過審核的卡片短信模板。
| CARD_SMS_3245 |
| SmsTemplateCode | string | 是 | 回落文本短信的模板 Code。請在控制臺國內消息頁面中的模板管理頁簽下模板 CODE一列查看。 說明
必須是已添加、并通過審核的短信模板。
| SMS_234251075 |
| FallbackType | string | 是 | 回落類型。取值：
| SMS |
| DigitalTemplateCode | string | 否 | 回落數字短信的模板 Code。請在控制臺國內消息頁面中的模板管理頁簽下模板 CODE一列查看。 說明
必須是已添加、并通過審核的短信模板。
| DIGITAL_SMS_234080176 |
| OutId | string | 否 | 預留給調用方使用的 ID。 | 16545681783595370 |
| PhoneNumberJson | string | 是 | 接收短信的手機號碼。 | [\"1390000****\",\"1370000****\"]" |
| SignNameJson | string | 是 | 短信簽名名稱。 請在控制臺國內消息頁面中的簽名管理頁簽下簽名名稱一列查看。 說明
必須是已添加、并通過審核的短信簽名；且短信簽名的個數必須與手機號碼的個數相同、內容一一對應。
| [\"阿里云\",\"阿里巴巴\"] |
| CardTemplateParamJson | string | 否 | 卡片短信模板參數對應的實際值。 | [{\"customurl\":\"http://www.alibaba.com\",\"dyncParams\":\"{\\\"a\\\":\\\"hello\\\",\\\"b\\\":\\\"world\\\"}\"}] |
| SmsTemplateParamJson | string | 否 | 文本短信模板參數對應的實際值。 | [{"a":1,"b":2},{"a":9,"b":8}] |
| DigitalTemplateParamJson | string | 否 | 數字短信模板參數對應的實際值。 | [{"a":1,"b":2},{"a":9,"b":8}] |
| SmsUpExtendCodeJson | string | 否 | 上行短信擴展碼。 | [\"6\",\"6\"] |
| TemplateCode | string | 否 | 短信模板 CODE。 您可以登錄短信服務控制臺，選擇國內消息或國際/港澳臺消息，在模板管理頁面查看模板 CODE。 說明
必須是已添加、并通過審核的短信模板；且發送國際/港澳臺消息時，請使用國際/港澳臺短信模板。
| SMS_20375**** |
| TemplateParamJson | string | 否 | 短信模板變量對應的實際值。 說明
如果 JSON 中需要帶換行符，請參照標準的 JSON 協議處理；且模板變量值的個數必須與手機號碼、簽名的個數相同、內容一一對應，表示向指定手機號碼中發對應簽名的短信，且短信模板中的變量參數替換為對應的值。
| [{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}] |
返回參數
示例
正常返回示例
JSON格式
{
"Code": "OK",
"RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
"Success": true,
"Data": {
"MediaMobiles": "1390000****",
"BizCardId": "123",
"BizDigitalId": "3214",
"CardTmpState": 0,
"NotMediaMobiles": "1390000****",
"BizSmsId": "3256"
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 200 | ForbiddenAction | Access to the account is denied. Please contact the administrator. | 沒有訪問權限，請聯系管理員 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-09-09 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |