短信模板即接收方收到短信的詳細(xì)內(nèi)容，包括變量和模板內(nèi)容。您可以根據(jù)業(yè)務(wù)需要，申請驗證碼、通知短信或推廣短信，模板審核通過后才可以發(fā)送短信。
接口說明
-
新接口和原接口變更的公告詳情請參見關(guān)于短信服務(wù)更新簽名&模板接口的公告。
-
通過接口申請短信模板，建議每次申請至少間隔 30 秒。
-
通過接口申請的模板信息會同步在短信服務(wù)控制臺，在控制臺對模板的相關(guān)操作，請參見短信模板。
-
提交模板申請后，您可以通過 GetSmsTemplate 接口查詢模板審核狀態(tài)和詳情。也可以配置回執(zhí)消息，通過 TemplateSmsReport 獲取模板的審核狀態(tài)消息。
-
國內(nèi)短信模板與國際/港澳臺短信模板不通用（不能混用），請根據(jù)業(yè)務(wù)使用場景申請模板。
-
僅支持企業(yè)認(rèn)證用戶申請推廣短信和國際/港澳臺消息，個人用戶與企業(yè)用戶權(quán)益區(qū)別詳情請參見使用須知。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎ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:CreateSmsTemplate | none | *全部資源 * |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| TemplateName | string | 是 | 模板名稱，長度不超過 30 個字符。 | 驗證碼 |
| TemplateContent | string | 是 | 模板內(nèi)容，長度不超過 500 個字符。 模板內(nèi)容和變量內(nèi)容必須符合短信規(guī)范，否則模板會審核失敗。您也可以在申請模板頁面，查看常用模板示例。使用示例模板可提高審核效率和成功率。變量規(guī)范請參見 TemplateContent 參數(shù)變量規(guī)范。 | 您正在申請手機(jī)注冊，驗證碼為：${code}，5分鐘內(nèi)有效！ |
| Remark | string | 否 | 請描述您使用短信的業(yè)務(wù)場景或提供業(yè)務(wù)場景的線上鏈接，并提供短信完整示例（填入變量內(nèi)容），信息完整有助于提高模板審核通過率。如未按規(guī)范進(jìn)行填寫或不填寫，可能會影響您模板審核的通過。 | 申請驗證碼短信 |
| TemplateType | integer | 是 | 短信類型。取值：
說明
僅支持企業(yè)認(rèn)證用戶申請推廣短信和國際/港澳臺消息。個人用戶與企業(yè)用戶權(quán)益區(qū)別詳情請參見使用須知。
| 0 |
| RelatedSignName | string | 否 | 模板需要關(guān)聯(lián)的簽名名稱。關(guān)聯(lián)的短信簽名必須為審核通過的簽名。 當(dāng) TemplateType 參數(shù)為 0、1、2 時，此參數(shù)必填。 注意 關(guān)聯(lián)簽名可以提升審核效率，此處關(guān)聯(lián)的簽名和短信發(fā)送時選擇的簽名無關(guān)。 | 驗證碼簽名 |
| TemplateRule | string | 否 | 模板變量規(guī)則。 變量規(guī)則的填寫，請參見示例文檔。 | {"code":"characterWithNumber"} |
| MoreData | array | 否 | 更多資料，您可以補(bǔ)充上傳業(yè)務(wù)證明文件或業(yè)務(wù)截圖，有助于審核人員了解您的業(yè)務(wù)詳情。 此參數(shù)非必填，請根據(jù)實(shí)際需要填寫。 | |
| string | 否 | 上傳到 OSS 的文件信息。 文件上傳操作，請參見 OSS 上傳文件。 | 10098689758*****/1234qwe.png | |
| ApplySceneContent | string | 否 | 如有應(yīng)用場景可進(jìn)行填寫。 | http://www.aliyun.com/ |
| IntlType | integer | 否 | 國際/港澳臺模板類型。當(dāng) TemplateType 參數(shù)為 3 時，國際/港澳臺模板需要設(shè)置此參數(shù)，取值：
| 0 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
"Code": "OK",
"Message": "successful",
"TemplateName": "驗證碼",
"TemplateCode": "SMS_10000****",
"OrderId": "2005020****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | ForbiddenAction | Access to the account is denied. Please contact the administrator. | 沒有訪問權(quán)限，請聯(lián)系管理員 |
| 400 | AssocSignUnapproved | Associated signature must be approved. | 關(guān)聯(lián)簽名需使用審核通過簽名。 |
| 400 | InvalidTemplateRule.Format | The parameter TemplateRule format must be JSON. | 模板變量規(guī)則格式必須為json格式。 |
| 400 | InvalidTemplateRule.Format | The template variable does not conform to the specification, please check the http://bestwisewords.com/zh/sms/user-guide/message-template-specifications/. | 模版變量不符合規(guī)范，請查看http://bestwisewords.com/zh/sms/ user-guide/message-template-specifications/ |
| 400 | InvalidMoreData | Specified parameter MoreData is not valid. | 上傳的更多資料無效。 |
| 400 | TemplateVarLimitExceeded | The verification code template only supports one variable. | 驗證碼模板僅支持1個變量。 |
| 400 | InvalidTemplateContent.Format | Invalid template content format. | 模板內(nèi)容格式不正確。 |
| 400 | InvalidTemplateRule | The template variable format is non-standard. Please refer to the variable format specifications in the help documentation. | 模版變量不符合規(guī)范，請查看http://bestwisewords.com/zh/sms/ user-guide/message-template-specifications/ |
| 400 | ServiceNotOpened | This product service is not opened. | 產(chǎn)品服務(wù)未開通 |
| 404 | MissingTemplateName | The template name cannot be empty. | 模板名稱不能為空。 |
| 404 | SmsSignatureNotFound | The associated SMS signature does not exist. | 關(guān)聯(lián)的短信簽名不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|