查詢發送記錄
更新時間 2024-11-08 16:21:55
最近更新時間: 2024-11-08 16:21:55
分享文章
您可以調用QuerySendDetails接口查看短信發送記錄和發送狀態。
調用QuerySendDetails接口查看短信發送記錄和發送狀態。
通過調用QuerySendDetails接口，可以根據短信發送日期查看發送記錄和短信內容，也可以添加發送流水號，根據流水號查詢指定日期指定請求的發送詳情。如果指定日期短信發送量較大，可以分頁查看。指定每頁顯示的短信詳情數量和查看的頁數，即可分頁查看發送記錄。
請求參數
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| action | String | 是 | QuerySendDetails | 系統規定參數。取值：QuerySendDetails 。 |
| currentPage | Int | 是 | 1 | 分頁查看發送記錄，指定發送記錄的當前頁碼。 |
| pageSize | Int | 是 | 10 | 分頁查看發送記錄，指定每頁顯示的短信記錄數量。取值范圍為1~50。 |
| phoneNumber | String | 是 | 1890000**** | 接收短信的手機號碼。格式：國內短信：11位手機號碼，例如1590000****。 |
| sendDate | String | 是 | 2022-03-28 | 短信發送日期，支持查詢最近30天的記錄。格式為yyyy-MM-dd，例如2018-12-25。 |
| signName | String | 否 | 簽名 | 對應發送內容的簽名。 |
| templateCode | String | 否 | SMS73419576145 | 對應發送內容的模板編號。 |
| requestId | String | 否 | 49667481793 | 對用發送時返回的流水號。 |
返回數據
| 名稱 | 類型 | 示例值 | 描述 |
|---|---|---|---|
| code | String | 0 | 請求狀態碼。返回OK代表請求成功。其他錯誤碼，請參見錯誤碼列表。 |
| message | String | 成功 | 狀態碼的描述。 |
| requestId | String | mOiogcaBxn6YgaEQ | 請求ID。 |
| totalCount | Int | 10 | 列表數量。 |
| data | Array | 參考以下 | 短信發送明細。 |
| data.phone | String | 1890000**** | 手機號碼。 |
| data.templateCode | String | SMS81136825168 | 短信模板CODE。 |
| data.signName | String | 天翼云 | 簽名名稱。 |
| data.total | Int | 2 | 該記錄所屬短信的總發送記錄條數。 |
| data.index | Int | 1 | 該記錄在所屬短信的全部發送記錄中的編號。 |
| data.type | Int | 1 | 短信類型，1：驗證碼，2：短信通知。 |
| data.content | String | 您的驗證碼為123,有效期為5分鐘! | 短信內容。 |
| data.status | Int | 3 | 短信發送狀態，1：發送中，2：發送失敗，3：發送成功 |
| data.statusCode | String | DELIVRD | 短信的最終發送狀態。 |
| data.receiveTime | String | 2022-03-28T06:29:35.171Z | 接收到發送短信請求的時間。 |
| data.deliverTime | String | 2022-03-28T06:29:35.171Z | 下發短信時間。 |
| data.reportTime | String | 2022-03-28T06:29:35.171Z | 接收短信狀態報告時間。 |
| data.notifyTime | String | 2022-03-28T06:29:35.171Z | 回調時間。 |
示例
請求示例
{
"action": "QuerySendDetails",
"phoneNumber": "1890000****",
"sendDate": "2022-01-18",
"currentPage": 1,
"pageSize": 10,
"signName":"天翼云",
"templateCode":"SMS13889962005"，
}
正常返回示例
{
"code": 0,
"message": "成功",
"totalCount": 1,
"data": [
{
"_id":"65212dcb79e914605da641ef",
"phone": "1890000****",
"requestId": "TxxfZdCz0sbhddV8",
"templateCode": "SMS81136825168",
"signName": "天翼云",
"total": 0,
"index": 0,
"type": 0,
"content": "您的驗證碼為123,有效期為5分鐘!",
"status": 3,
"statusCode": "DELIVRD",
"receiveTime": "2022-03-28T06:29:34.819Z",
"deliverTime": "2022-03-28T06:29:34.824Z",
"reportTime": "2022-03-28T06:29:35.171Z",
"notifyTime": "2022-03-28T06:29:35.171Z"
}
],
"requestId": "dNFgPWV5Db14vg38"
}
錯誤碼
訪問錯誤碼列表查看更多錯誤碼。
