短信模板即接收方收到短信的詳細(xì)內(nèi)容,包括變量和模板內(nèi)容。您可以根據(jù)業(yè)務(wù)需要,申請驗(yàn)證碼、通知短信或推廣短信,模板審核通過后才可以發(fā)送短信。
接口說明
-
通過接口申請短信模板,一個自然日最多可以提交 100 次短信模板申請。建議每次申請至少間隔 30 秒。通過控制臺申請短信模板,提交次數(shù)無限制。
-
通過接口申請的模板信息會同步在短信服務(wù)控制臺,在控制臺對模板的相關(guān)操作,請參見短信模板。
-
提交模板申請后,您可以通過 QuerySmsTemplate 接口查詢模板審核狀態(tài)和詳情。也可以配置回執(zhí)消息,通過 TemplateSmsReport 獲取模板的審核狀態(tài)消息。
-
國內(nèi)短信模板與國際/港澳臺短信模板不通用(不能混用),請根據(jù)業(yè)務(wù)使用場景申請模板。
-
僅支持企業(yè)認(rèn)證用戶申請推廣短信和國際/港澳臺消息,個人用戶與企業(yè)用戶權(quán)益區(qū)別詳情請參見使用須知。
QPS 限制
本接口的單用戶 QPS 限制為 1000 次/秒。超過限制,API 調(diào)用會被限流,這可能會影響您的業(yè)務(wù),請合理調(diào)用。
調(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:AddSmsTemplate | create |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TemplateType | integer | 是 | 短信類型。取值:
說明
僅支持企業(yè)認(rèn)證用戶申請推廣短信和國際/港澳臺消息。個人用戶與企業(yè)用戶權(quán)益區(qū)別詳情請參見使用須知。
| 0 |
TemplateName | string | 是 | 模板名稱,長度不超過 30 個字符。 | 驗(yàn)證碼 |
TemplateContent | string | 是 | 您正在申請手機(jī)注冊,驗(yàn)證碼為:${code},5分鐘內(nèi)有效! | |
Remark | string | 是 | 短信模板申請說明,長度不超過 100 個字符。 模板審核的參考信息,完善申請說明有助于審核人員理解您的業(yè)務(wù)場景,提高審核效率。填寫指導(dǎo):
| 申請驗(yàn)證碼短信 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
"TemplateCode": "SMS_46817****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | TemplateParameterCountIllegal | The verification code template only supports 1 verification code as a variable | 驗(yàn)證碼模板僅支持1個驗(yàn)證碼作為變量 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-09-03 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |