查詢單個號碼的短信發送記錄和發送狀態等信息。
接口說明
-
本接口主要用于查詢指定日期下,向某個手機號碼發送短信的記錄詳情。您也可以傳入發送流水號(BizId),查詢該號碼的指定發送記錄。
-
本接口僅支持查詢單個手機號碼發送詳情。如果需要批量查看短信發送詳情,您可以使用 QuerySendStatistics 接口,查詢短信發送統計詳情;或登錄控制臺發送記錄查詢頁面,查詢發送詳情。
QPS 限制
本接口的單用戶 QPS 限制為 5000/秒。超過限制,API 調用將會被限流,請合理使用。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dysms:QuerySendDetails | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PhoneNumber | string | 是 | 需要查詢的手機號碼。格式:
說明
只能傳入一個手機號碼。
| 1390000**** |
BizId | string | 否 | 發送回執 ID。即發送流水號,調用 SendSms 或 SendBatchSms 發送短信時,返回值中的 BizId 字段。 說明
只能傳入一個 Bizid 的值,無法傳入多個 Bizid。
| 134523^435**** |
SendDate | string | 是 | 短信發送日期,支持查詢最近 30 天的記錄。 格式:yyyyMMdd,例如 20181225。 | 20181228 |
PageSize | long | 是 | 每頁顯示的短信記錄數量,供分頁查看發送記錄使用。 取值范圍為 1~50。 | 10 |
CurrentPage | long | 是 | 發送記錄的當前頁碼,供分頁查看發送記錄使用。 | 1 |
您可以訪問 OpenAPI 門戶,查看各語言 SDK 請求示例。
返回參數
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "819BE656-D2E0-4858-8B21-B2E477085AAF",
"TotalCount": "1",
"SmsSendDetailDTOs": {
"SmsSendDetailDTO": [
{
"ErrCode": "DELIVERED",
"TemplateCode": "SMS_12231****",
"OutId": "123",
"ReceiveDate": "2019-01-08 16:44:13",
"SendDate": "2019-01-08 16:44:10",
"PhoneNum": "1390000****",
"Content": "【阿里云】驗證碼為:123,您正在登錄,若非本人操作,請勿泄露",
"SendStatus": 3
}
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-09 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標記 | 查看變更詳情 |