調用DescribeCallList分頁查詢時間范圍內創建的通信信息。
接口說明
使用說明
本接口用于查詢時間范圍內創建的通信信息。例如：您可以查詢通訊時長、狀態、用戶數等信息。
QPS 限制
本接口的單用戶 QPS 限制為 5 次/秒。超過限制，API 調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| rtc:DescribeCallList | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | APP ID。 | testappid |
| StartTs | long | 是 | 查詢的開始時間，使用 UNIX 時間戳表示，單位：秒。 | 1615806196 |
| EndTs | long | 是 | 查詢的結束時間，使用 UNIX 時間戳表示，單位：秒。 | 1615892596 |
| ChannelId | string | 否 | 頻道 ID。 | 311 |
| UserId | string | 否 | 用戶 ID。 | c906531af5f9**** |
| CallStatus | string | 否 | 通信狀態。取值：
| OUT |
| OrderBy | string | 否 | 排序字段。取值：
| BAD_EXP_USER_COUNT_DESC |
| QueryMode | string | 否 | 查詢模式。取值：
| ALL |
| PageNo | integer | 是 | 頁碼。最小 1， 最大 200。 | 1 |
| PageSize | integer | 是 | 每頁數量，最小 1， 最大 200。 | 10 |
返回參數
示例
正常返回示例
JSON格式
{
"PageNo": 1,
"PageSize": 10,
"TotalCnt": 1,
"CallList": [
{
"AppId": "testappid",
"ChannelId": "311",
"CallStatus": "OUT",
"CreatedTs": 1615806196,
"DestroyedTs": 1615806296,
"Duration": 100,
"UserCnt": 5,
"BadExpUserCnt": 0
}
],
"RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | ApiParamError | API %s. | Api參數錯誤 |
| 403 | BizAppError | A business application permission error occurred. | 業務應用權限錯誤 |
| 403 | BizUidError | A business UID error occurred. | 業務主賬號錯誤 |
| 500 | ServerInternalError | An internal error occurred. | 服務器內部錯誤 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-12-28 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |