短信簽名作為短信發送方的一種標識,發送短信前,您需要先申請簽名和模板,系統會將已審核通過的短信簽名添加到短信內容的開頭,并與短信內容一起發送給接收方。
接口說明
-
新接口和原接口變更的公告詳情請參見關于短信服務更新簽名&模板接口的公告。
-
個人認證用戶,同一個阿里云賬號一個自然日支持申請一個正式簽名,企業認證用戶,目前無限制。個人用戶與企業用戶權益區別詳情請參見使用須知。
-
通過接口申請的簽名信息會同步在短信服務控制臺,在控制臺對簽名的相關操作,請參見短信簽名。
-
提交簽名申請后,您可以通過 GetSmsSign 接口查詢簽名審核狀態和詳情。也可以配置回執消息,通過 SignSmsReport 獲取簽名的審核狀態消息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dysms:CreateSmsSign | none | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SignName | string | 是 | 簽名名稱,簽名名稱請遵守簽名規范。 說明
| 阿里云驗證碼 |
Remark | string | 否 | 短信簽名場景說明,長度不超過 200 個字符。 說明
場景說明是簽名審核的參考信息之一。請詳細描述已上線業務的使用場景,并提供可以驗證這些業務的網站鏈接、已備案域名地址、應用市場下載鏈接、公眾號或小程序全稱等信息。對于登錄場景,還需提供測試賬號密碼。信息完善的申請說明會提高簽名、模板的審核效率。短信場景填寫可參考簽名來源表格中應用場景的填寫。如未按規范進行填寫或不填寫,可能會影響您簽名審核的通過。
| 登錄場景使用驗證碼 |
SignType | integer | 否 | 簽名類型。取值:
說明
建議使用默認值:通用。
| 1 |
MoreData | array | 否 | 更多資料,補充上傳業務證明文件或業務截圖,有助于審核人員了解您的業務詳情。 此參數非必填,請您根據實際需要填寫。 | |
string | 否 | 上傳到 OSS 的文件信息。 文件上傳操作,請參見 OSS 上傳文件。 | 10098689758*****/1234qwe.png | |
QualificationId | long | 是 | 8563** | |
ApplySceneContent | string | 否 | 請根據關聯的簽名來源填寫不同的應用場景鏈接,填寫說明如下:
| http://www.aliyun.com/ |
SignSource | integer | 是 | 1 | |
ThirdParty | boolean | 否 | 選擇申請的簽名為自用或他用。
| false |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "CCA2BCFF-2BA7-427C-90EE-AC6994748607",
"Code": "OK",
"Message": "successful",
"SignName": "阿里云驗證碼",
"OrderId": "2004415****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ForbiddenAction | Access to the account is denied. Please contact the administrator. | 沒有訪問權限,請聯系管理員 |
400 | ParameterMismatch.ThirdParty | The type of signature, whether for personal use or for a third party, should be consistent with the qualifications. | 簽名是否第三方使用應和資質保持一致。 |
400 | SignName.Exists | Sorry, this signature already exists and cannot be applied for again. | 抱歉,此簽名已經存在,不可重復申請。 |
400 | InvalidQualification | The qualification should be approved. | 無效的資質,資質應審核通過。 |
400 | InvalidSignName | The signature cannot contain spaces, special symbols, or all numbers. | 簽名不能包含簡體中文、英文、數字之外的空格等特殊字符,且不能為全數字。 |
400 | InvalidApplySceneContent | For certain signature sources, the applySceneContent should be an HTTP or HTTPS link. | 無效的應用場景,在某些簽名來源下, 應用場景應是http或者https的鏈接。 |
400 | MissApplySceneContent | In some signature sources, the applySceneContent is required. | 在某些簽名來源下,應用場景必填 |
400 | MissingSignName | The signature name cannot be empty. | 簽名名稱不能為空 |
404 | QualificationNotFound | Qualification does not exist. | 資質不存在。 |
訪問錯誤中心查看更多錯誤碼。