調(diào)用DescribeCallList分頁查詢時(shí)間范圍內(nèi)創(chuàng)建的通信信息。

使用說明

本接口用于查詢時(shí)間范圍內(nèi)創(chuàng)建的通信信息。例如：您可以查詢通訊時(shí)長、狀態(tài)、用戶數(shù)等信息。

QPS限制

本接口的單用戶QPS限制為10次/秒。超過限制，API調(diào)用會(huì)被限流，這可能會(huì)影響您的業(yè)務(wù)，請(qǐng)合理調(diào)用。更多信息，請(qǐng)參見QPS限制。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求頭

該接口使用公共請(qǐng)求頭，無特殊請(qǐng)求頭。請(qǐng)參見公共請(qǐng)求參數(shù)文檔。

請(qǐng)求語法

POST /api/call/describeCallList HTTP/1.1

請(qǐng)求參數(shù)

名稱 類型 位置 是否必選 示例值 描述
AppId String Query 是 9qb1****

App ID，可通過控制臺(tái)創(chuàng)建和查詢。
StartTs Long Query 是 1615806196

查詢的開始時(shí)間，支持查詢最近30天的數(shù)據(jù)。使用UNIX時(shí)間戳表示，單位：秒。
EndTs Long Query 是 1615892596

查詢的結(jié)束時(shí)間，使用UNIX時(shí)間戳表示，單位：秒。
ChannelId String Query 否 311

頻道ID。
UserId String Query 否 c906531af5f9****

查詢對(duì)應(yīng)此用戶ID的通信信息。
CallStatus String Query 否 OUT

通信狀態(tài)。取值：

  • IN：進(jìn)行中。
  • OUT：已結(jié)束。
OrderBy String Query 否 BAD_EXP_USER_COUNT_DESC

排序字段。取值：

  • BAD_EXP_USER_COUNT_DESC：按體驗(yàn)欠佳人數(shù)降序。
  • BAD_EXP_USER_COUNT_ASC：按體驗(yàn)欠佳人數(shù)升序
QueryMode String Query 否 ALL

查詢模式。取值：

  • ALL：全部通話。
  • FOLLOW：關(guān)注通話。
PageNo Integer Query 是 1

頁碼。
PageSize Integer Query 是 10

每頁數(shù)量。

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
PageNo Integer 2

頁碼。
PageSize Integer 10

每頁數(shù)量。
TotalCnt Integer 20

總數(shù)量。
CallList Array of CallListItem

通信列表。
AppId String 9qb1****

App ID。
ChannelId String 904

頻道ID。
CallStatus String OUT

通信狀態(tài)。
CreatedTs Long 1615885823

通信的創(chuàng)建時(shí)間戳，使用UNIX時(shí)間戳表示，單位：秒。
DestroyedTs Long 1615886028

通信的釋放時(shí)間戳，使用UNIX時(shí)間戳表示，單位：秒。
Duration Long 205

通信持續(xù)時(shí)長，單位：秒。
UserCnt Integer 2

通信用戶數(shù)。
BadExpUserCnt Integer 0

通信體驗(yàn)差的用戶數(shù)。
RequestId String 231470C1-ACFB-4C9F-844F-4CFE1E3804C5

請(qǐng)求ID。

示例

請(qǐng)求示例

POST api/call/describeCallList?AppId=9qb1****&StartTs=1615806196&EndTs=1615892596&PageNo=1&PageSize=10 HTTP/1.1 
Host: vdc.cn-shenzhen.aliyuncs.com 
Date: GMT Date

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCallListResponse>
<code>200</code>
<data>
    <CallList>
        <DestroyedTs>1615886028</DestroyedTs>
        <AppId>9qb1****</AppId>
        <BadExpUserCnt>0</BadExpUserCnt>
        <CallStatus>OUT</CallStatus>
        <Duration>205</Duration>
        <CreatedTs>1615885823</CreatedTs>
        <ChannelId>904</ChannelId>
        <UserCnt>2</UserCnt>
    </CallList>
    <CallList>
        <DestroyedTs>1615885133</DestroyedTs>
        <AppId>9qb1****</AppId>
        <BadExpUserCnt>0</BadExpUserCnt>
        <CallStatus>OUT</CallStatus>
        <Duration>845</Duration>
        <CreatedTs>1615884288</CreatedTs>
        <ChannelId>903</ChannelId>
        <UserCnt>11</UserCnt>
    </CallList>
    <RequestId>D8DFED63-7754-4CD6-95B6-9DB46A6578E0</RequestId>
    <TotalCnt>90</TotalCnt>
    <PageSize>10</PageSize>
    <PageNo>1</PageNo>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>D8DFED63-7754-4CD6-95B6-9DB46A6578E0</requestId>
<successResponse>true</successResponse>
</DescribeCallListResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "code" : "200",
  "data" : {
    "CallList" : [ {
      "DestroyedTs" : 1615886028,
      "AppId" : "9qb1****",
      "BadExpUserCnt" : 0,
      "CallStatus" : "OUT",
      "Duration" : 205,
      "CreatedTs" : 1615885823,
      "ChannelId" : "904",
      "UserCnt" : 2
    }, {
      "DestroyedTs" : 1615885133,
      "AppId" : "9qb1****",
      "BadExpUserCnt" : 0,
      "CallStatus" : "OUT",
      "Duration" : 845,
      "CreatedTs" : 1615884288,
      "ChannelId" : "903",
      "UserCnt" : 11
    } ],
    "RequestId" : "D8DFED63-7754-4CD6-95B6-9DB46A6578E0",
    "TotalCnt" : 90,
    "PageSize" : 10,
    "PageNo" : 1
  },
  "httpStatusCode" : "200",
  "requestId" : "D8DFED63-7754-4CD6-95B6-9DB46A6578E0",
  "successResponse" : true
}