短信模板即接收方收到短信的詳細(xì)內(nèi)容,包括變量和模板內(nèi)容。您可以根據(jù)業(yè)務(wù)需要,申請(qǐng)驗(yàn)證碼、通知短信或推廣短信,模板審核通過(guò)后才可以發(fā)送短信。
接口說(shuō)明
-
根據(jù)工信部規(guī)定與運(yùn)營(yíng)商相關(guān)要求,阿里云進(jìn)行了模板相關(guān) API 的功能改造。為提升您模板的審核效率和審核通過(guò)率,請(qǐng)您使用新接口CreateSmsTemplate-申請(qǐng)短信模板。
-
通過(guò)接口申請(qǐng)短信模板,一個(gè)自然日最多可以提交 100 次短信模板申請(qǐng)。建議每次申請(qǐng)至少間隔 30 秒。通過(guò)控制臺(tái)申請(qǐng)短信模板,提交次數(shù)無(wú)限制。
-
通過(guò)接口申請(qǐng)的模板信息會(huì)同步在短信服務(wù)控制臺(tái),在控制臺(tái)對(duì)模板的相關(guān)操作,請(qǐng)參見短信模板。
-
提交模板申請(qǐng)后,您可以通過(guò) QuerySmsTemplate 接口查詢模板審核狀態(tài)和詳情。也可以配置回執(zhí)消息,通過(guò) TemplateSmsReport 獲取模板的審核狀態(tài)消息。
-
國(guó)內(nèi)短信模板與國(guó)際/港澳臺(tái)短信模板不通用(不能混用),請(qǐng)根據(jù)業(yè)務(wù)使用場(chǎng)景申請(qǐng)模板。
-
僅支持企業(yè)認(rèn)證用戶申請(qǐng)推廣短信和國(guó)際/港澳臺(tái)消息,個(gè)人用戶與企業(yè)用戶權(quán)益區(qū)別詳情請(qǐng)參見使用須知。
QPS 限制
本接口的單用戶 QPS 限制為 1000 次/秒。超過(guò)限制,API 調(diào)用會(huì)被限流,這可能會(huì)影響您的業(yè)務(wù),請(qǐng)合理調(diào)用。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dysms:AddSmsTemplate | create | *全部資源 * |
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TemplateType | integer | 是 | 短信類型。取值:
說(shuō)明
僅支持企業(yè)認(rèn)證用戶申請(qǐng)推廣短信和國(guó)際/港澳臺(tái)消息。個(gè)人用戶與企業(yè)用戶權(quán)益區(qū)別詳情請(qǐng)參見使用須知。
| 0 |
TemplateName | string | 是 | 模板名稱,長(zhǎng)度不超過(guò) 30 個(gè)字符。 | 驗(yàn)證碼 |
TemplateContent | string | 是 | 模板內(nèi)容,長(zhǎng)度不超過(guò) 500 個(gè)字符。 模板內(nèi)容和變量?jī)?nèi)容必須符合短信規(guī)范,否則模板會(huì)審核失敗。您也可以在申請(qǐng)模板頁(yè)面,查看常用模板示例。使用示例模板可提高審核效率和成功率。 | 您正在申請(qǐng)手機(jī)注冊(cè),驗(yàn)證碼為:${code},5分鐘內(nèi)有效! |
Remark | string | 是 | 短信模板申請(qǐng)說(shuō)明,長(zhǎng)度不超過(guò) 100 個(gè)字符。 模板審核的參考信息,完善申請(qǐng)說(shuō)明有助于審核人員理解您的業(yè)務(wù)場(chǎng)景,提高審核效率。填寫指導(dǎo):
| 申請(qǐng)驗(yàn)證碼短信 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
"TemplateCode": "SMS_46817****"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | TemplateParameterCountIllegal | The verification code template only supports 1 verification code as a variable | 驗(yàn)證碼模板僅支持1個(gè)驗(yàn)證碼作為變量 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-09-03 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |