發送短信驗證碼。
接口說明
請確保在使用該接口前，已充分了解號碼認證服務產品的收費方式和價格。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dypns:SendSmsVerifyCode | none |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SchemeName | string | 否 | 方案名稱，如果不填則為“默認方案”。最多不超過 20 個字符。 | 測試方案 |
| CountryCode | string | 否 | 號碼國家編碼。默認為 86，目前也僅支持國內號碼發送。 | 86 |
| PhoneNumber | string | 是 | 手機號。 | 130****0000 |
| SignName | string | 是 | 簽名名稱。 | 阿里云 |
| TemplateCode | string | 是 | 短信模板 CODE。 您可以登錄短信服務控制臺，選擇國內消息或國際/港澳臺消息，在模板管理頁面查看模板 CODE。 說明
必須是已添加、并通過審核的短信模板；且發送國際/港澳臺消息時，請使用國際/港澳臺短信模板。
| azsq_***** |
| TemplateParam | string | 是 | 短信模板變量填寫的參數值。驗證碼位置使用"##code##"替代。 示例：如模板內容為：“您的驗證碼是${authCode}，5 分鐘內有效，請勿告訴他人。”。此時，該字段傳入：{"authCode":"##code##"} 注意 上文中的 authCode 請替換成您實際申請的驗證碼模板中的參數名稱 說明
| {"code":"##code##"} |
| SmsUpExtendCode | string | 否 | 上行短信擴展碼。上行短信指發送給通信服務提供商的短信，用于定制某種服務、完成查詢，或是辦理某種業務等，需要收費，按運營商普通短信資費進行扣費。 說明
擴展碼是生成簽名時系統自動默認生成的，不支持自行傳入。無特殊需要此字段的用戶請忽略此字段。如需使用，請聯系您的商務經理。
| 1213123 |
| OutId | string | 否 | 外部流水號。 | 外部流水號（透傳） |
| CodeLength | long | 否 | 驗證碼長度支持 4～8 位長度，默認是 4 位。 | 4 |
| ValidTime | long | 否 | 驗證碼有效時長，單位秒，默認為 300 秒。 | 300 |
| DuplicatePolicy | long | 否 | 核驗規則，當有效時間內對同場景內的同號碼重復發送驗證碼時，舊驗證碼如何處理。
| 1 |
| Interval | long | 否 | 時間間隔，單位：秒。即多久間隔可以發送一次驗證碼，用于頻控，默認 60 秒。 | 60 |
| CodeType | long | 否 | 生成的驗證碼類型。取值：
| 1 |
| ReturnVerifyCode | boolean | 否 | 是否返回驗證碼。取值：
| true |
返回參數
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "無",
"Message": "成功 ",
"Model": {
"VerifyCode": "4232",
"RequestId": "a3671ccf-0102-4c8e-8797-a3678e091d09",
"OutId": "1231231313",
"BizId": "112231421412414124123^4"
},
"Code": "OK",
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史