本產品(
短信服務/2017-05-25
)的OpenAPI采用RPC簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(78410016550),在專家指導下進行簽名對接。在使用API前,您需要準備好身份賬號及訪問密鑰(AccessKey),才能有效通過客戶端工具(SDK、CLI等)訪問API。細節請參見獲取AccessKey。
簽名管理
API | 標題 | API概述 |
---|---|---|
AddSmsSign | 申請短信簽名 | 一條完整的短信由短信簽名和短信內容組成,發送短信前,您需要先申請簽名和模板,系統會將已審核通過的短信簽名添加到短信內容的開頭,與短信內容一起發送給接收方。 |
QuerySmsSign | 查詢簽名審核狀態 | 申請簽名后,通過此接口查詢簽名審核詳情。 |
QuerySmsSignList | 查詢簽名列表詳情 | 可以通過此接口可以查詢您賬號下的所有簽名,方便您查看簽名詳情,包括簽名審核狀態、簽名類型、簽名名稱等。 |
ModifySmsSign | 修改短信簽名 | 修改未通過審核的簽名,修改完成后自動提交審核,簽名進入待審核狀態。 |
DeleteSmsSign | 刪除短信簽名 | 如果您不再使用某個短信簽名,需要刪除簽名時,調用此接口或在短信服務控制臺刪除短信簽名。 |
CreateSmsSign | 申請短信簽名(新接口) | 短信簽名作為短信發送方的一種標識,發送短信前,您需要先申請簽名和模板,系統會將已審核通過的短信簽名添加到短信內容的開頭,并與短信內容一起發送給接收方。 |
UpdateSmsSign | 修改短信簽名(新接口) | 修改未通過審核的簽名,修改完成后自動提交審核,簽名進入待審核狀態。 |
GetSmsSign | 查詢簽名詳情(新接口) | 申請簽名后,通過此接口查詢簽名審核詳情。 |
模板管理
API | 標題 | API概述 |
---|---|---|
AddSmsTemplate | 申請短信模板 | 短信模板即接收方收到短信的詳細內容,包括變量和模板內容。您可以根據業務需要,申請驗證碼、通知短信或推廣短信,模板審核通過后才可以發送短信。 |
QuerySmsTemplate | 查詢模板審核狀態 | 查詢單個短信模板的審核狀態,返回是否通過審核及模板審核備注等信息。 |
QuerySmsTemplateList | 查詢模板列表詳情 | 可以通過此接口查詢您賬號下的所有模板,方便您查看模板詳情,包括模板審核狀態、模板類型、模板內容等。 |
ModifySmsTemplate | 修改短信模板 | 修改未通過審核的模板,調用本接口修改后將自動提交審核。 |
DeleteSmsTemplate | 刪除短信模板 | 如果您不再使用某個短信模板,需要刪除模板時,調用此接口或在短信服務控制臺刪除短信模板。 |
CreateSmsTemplate | 申請短信模板(新接口) | 短信模板即接收方收到短信的詳細內容,包括變量和模板內容。您可以根據業務需要,申請驗證碼、通知短信或推廣短信,模板審核通過后才可以發送短信。 |
UpdateSmsTemplate | 修改短信模板(新接口) | 修改未通過審核的模板,調用本接口修改后將自動提交審核。 |
GetSmsTemplate | 查詢模板審核詳情(新接口) | 申請模板后,通過此接口查詢模板審核詳情,可查看模板審核狀態。 |
短信發送
API | 標題 | API概述 |
---|---|---|
SendSms | 發送短信 | 向指定的手機號碼發送短信。 |
SendBatchSms | 批量發送短信 | 調用此接口可以給不同的手機號碼,發送不同簽名、同一個模板(可以是不同模板變量)的短信。 |
發送查詢
API | 標題 | API概述 |
---|---|---|
QuerySendDetails | 查詢短信發送詳情 | 查詢單個號碼的短信發送記錄和發送狀態等信息。 |
QuerySendStatistics | 查詢短信發送量統計 | 查詢短信發送統計詳情,包括短信發送時間、短信發送成功條數、接收回執條數等。 |
卡片短信
API | 標題 | API概述 |
---|---|---|
GetOSSInfoForCardTemplate | 獲取OSS上傳信息 | 獲取卡片短信所屬OSS資源配置信息,此配置信息將用于后續OSS文件上傳操作。 |
GetMediaResourceId | 獲取媒體資源ID | 將用戶上傳到卡片短信OSS存儲的圖片、視頻轉換成(生成)資源數據統一管理,并返回資源ID,用戶可以對返回的資源ID自行管理。 |
CreateCardSmsTemplate | 創建卡片短信模板 | 創建卡片短信模板。 |
QueryCardSmsTemplate | 查詢卡片短信模板狀態 | 查詢卡片短信模板審核狀態,返回手機廠商審核相關信息。 |
CheckMobilesCardSupport | 檢查手機號是否支持卡片短信(舊接口) | 檢查手機號碼是否支持卡片短信。 |
QueryMobilesCardSupport | 查詢手機號是否支持卡片短信(新接口) | 查詢手機號是否支持卡片短信。 |
GetCardSmsLink | 獲取卡片短信短鏈 | 獲取卡片短信短鏈。 |
GetCardSmsDetails | 查詢單個號碼的卡片短信發送記錄和發送狀態等信息 | 查詢單個號碼的卡片短信發送記錄和發送狀態等信息。 |
QueryCardSmsTemplateReport | 查詢卡片短信指定模板的解析數據 | 查詢卡片短信指定模板的解析數據,解析數據包括短信解析回執成功數、消息曝光次數和消息點擊數等。 |
SendCardSms | 發送卡片短信 | 發送卡片短信。 |
SendBatchCardSms | 批量發送卡片短信 | 批量發送卡片短信。 |
獲取OSS上傳信息
API | 標題 | API概述 |
---|---|---|
GetOSSInfoForUploadFile | 文本短信獲取OSS上傳信息 | 獲取OSS資源配置信息,此配置信息將用于后續OSS文件上傳操作。 |
國內發國際短信轉化率
API | 標題 | API概述 |
---|---|---|
SmsConversionIntl | 國內發國際短信轉化反饋 | 將每一條消息ID(MessageId) 對應短信的接收情況反饋給阿里云國際短信平臺。 |
ConversionDataIntl | 國內發國際轉化率數據接入API | 將短信轉化率統計數據反饋給阿里云短信平臺。 |
標簽管理
API | 標題 | API概述 |
---|---|---|
ListTagResources | 查詢模板標簽 | 標簽是您為模板添加的標記,每個標簽都由一對鍵值對(Key-Value)組成。您可以查詢標簽鍵值對綁定的模板Code,也可以查詢某個模板已綁定的所有標簽。 |
TagResources | 添加模板標簽 | 標簽可以標記資源,允許企業或個人將同類型的模板進行資源歸類,便于搜索和資源聚合。調用本接口對短信模板進行標簽綁定。 |
UntagResources | 刪除模板標簽 | 標簽可以標記資源,允許企業或個人將同類型的模板進行資源歸類,便于搜索和資源聚合。如果模板不再適用于當前已綁定的標簽,可以從模板中解綁標簽。您可以刪除單個標簽,也可以批量刪除標簽。 |