查詢單個號碼的短信發(fā)送記錄和發(fā)送狀態(tài)等信息。
接口說明
-
本接口主要用于查詢指定日期下，向某個手機(jī)號碼發(fā)送短信的記錄詳情。您也可以傳入發(fā)送流水號（BizId），查詢該號碼的指定發(fā)送記錄。
-
本接口僅支持查詢單個手機(jī)號碼發(fā)送詳情。如果需要批量查看短信發(fā)送詳情，您可以使用 QuerySendStatistics 接口，查詢短信發(fā)送統(tǒng)計詳情；或登錄控制臺發(fā)送記錄查詢頁面，查詢發(fā)送詳情。
QPS 限制
本接口的單用戶 QPS 限制為 5000/秒。超過限制，API 調(diào)用將會被限流，請合理使用。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| dysms:QuerySendDetails | get | *全部資源 * |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PhoneNumber | string | 是 | 需要查詢的手機(jī)號碼。格式：
說明
只能傳入一個手機(jī)號碼。
| 1390000**** |
| BizId | string | 否 | 發(fā)送回執(zhí) ID。即發(fā)送流水號，調(diào)用 SendSms 或 SendBatchSms 發(fā)送短信時，返回值中的 BizId 字段。 說明
只能傳入一個 Bizid 的值，無法傳入多個 Bizid。
| 134523^435**** |
| SendDate | string | 是 | 短信發(fā)送日期，支持查詢最近 30 天的記錄。 格式：yyyyMMdd，例如 20181225。 | 20181228 |
| PageSize | long | 是 | 每頁顯示的短信記錄數(shù)量，供分頁查看發(fā)送記錄使用。 取值范圍為 1~50。 | 10 |
| CurrentPage | long | 是 | 發(fā)送記錄的當(dāng)前頁碼，供分頁查看發(fā)送記錄使用。 | 1 |
您可以訪問 OpenAPI 門戶，查看各語言 SDK 請求示例。
返回參數(shù)
示例
正常返回示例
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
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-09-09 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標(biāo)記 | 查看變更詳情 |