獲取短信發送統計數據，可按指定條件獲取分類別詳細數據。
接口說明
獲取 [開始日期, 結束日期] 閉區間內的數據，返回數據按日期升序排列，發送統計為空的日期不返回。
發送數據在 48 小時內會隨實際短信發送狀態不斷更新，最終數據以 48 小時后數據為準。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求語法
GET /api/v2/messages/metrics
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| EndDate | string | 是 | 結束日期，格式 20220102。 | 20210321 |
| GroupId | string | 否 | 關聯人群 ID。 | 10ed87f5-3ca8-4a43-9d83-b30519be7241 |
| PageNumber | integer | 否 | 分頁數，從 1 開始，默認為 1。 | 1 |
| PageSize | integer | 否 | 分頁大小，默認為 10。 | 10 |
| ScheduleId | string | 否 | 關聯觸達計劃 ID。 | 08d19262-bd76-48fd-80e8-6a225ac388c1 |
| Signature | string | 否 | 簽名名稱。 | PAI通知 |
| SignatureId | string | 否 | 簽名 ID，同時只能指定簽名名稱或簽名 ID 其中之一。 | b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3 |
| StartDate | string | 是 | 開始日期，格式 20220102。 | 20210321 |
| TemplateCode | string | 否 | 模板號。 | SMS_123456 |
| TemplateId | string | 否 | 模板 ID，同時只能指定模板 Code 或模板 ID 其中之一。 | 5480e3e7-f578-42d2-8ce8-217dec75f2e6 |
| TemplateType | integer | 否 | 模板類型。
| 2 |
返回參數
示例
正常返回示例
JSON格式
{
"Data": {
"Metrics": [
{
"Date": "20210321",
"Fail": 0,
"Pending": 0,
"Rate": 0.8,
"Success": 0,
"Total": 0
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 0
},
"ErrorCode": 0,
"ErrorMessage": "OK",
"RequestId": "f8651828-609d-4de8-ab49-ab781d7fd85a"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 | ||
|---|---|---|---|---|
| 2024-06-18 | API 內部配置變更，不影響調用 | 看變更集 | ||
| ||||
| 2022-03-01 | OpenAPI 返回結構發生變更 | 看變更集 | ||
| ||||
| 2022-03-01 | 新增 OpenAPI | 看變更集 | ||
| 2022-03-01 | OpenAPI 返回結構發生變更 | 看變更集 | ||
| ||||
| 2022-03-01 | OpenAPI 返回結構發生變更 | 看變更集 | ||
|