首页 音视频通信 开发参考 API参考 API目录 数据服务 通信监测 DescribeCallList - 分页查询时间范围内通信信息

DescribeCallList - 分页查询时间范围内通信信息

更新时间: 2024-11-08 17:32:43

调用DescribeCallList分页查询时间范围内创建的通信信息。

接口说明

使用说明

本接口用于查询时间范围内创建的通信信息。例如:您可以查询通讯时长、状态、用户数等信息。

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rtc:DescribeCallList
  • 全部资源
    *

请求参数

名称类型必填描述示例值
AppIdstring

APP ID。

testappid
StartTslong

查询的开始时间,使用 UNIX 时间戳表示,单位:秒。

1615806196
EndTslong

查询的结束时间,使用 UNIX 时间戳表示,单位:秒。

1615892596
ChannelIdstring

频道 ID。

311
UserIdstring

用户 ID。

c906531af5f9****
CallStatusstring

通信状态。取值:

  • IN:进行中。
  • OUT:已结束。
OUT
OrderBystring

排序字段。取值:

  • BAD_EXP_USER_COUNT_DESC:按体验欠佳人数降序。
  • BAD_EXP_USER_COUNT_ASC:按体验欠佳人数升序。
BAD_EXP_USER_COUNT_DESC
QueryModestring

查询模式。取值:

  • ALL:全部通话。
  • FOLLOW:关注通话。
ALL
PageNointeger

页码。最小 1, 最大 200。

1
PageSizeinteger

每页数量,最小 1, 最大 200。

10

返回参数

名称类型描述示例值
object
PageNointeger

页码。

1
PageSizeinteger

每页数量。

10
TotalCntinteger

总数量。

1
CallListarray<object>

通信列表。

CallListItemobject
AppIdstring

App ID。

testappid
ChannelIdstring

频道 ID。

311
CallStatusstring

通信状态。取值:

  • IN:进行中。
  • OUT:已结束。
OUT
CreatedTslong

通信的创建时间戳,使用 UNIX 时间戳表示,单位:秒。

1615806196
DestroyedTslong

通信的释放时间戳,使用 UNIX 时间戳表示,单位:秒。

1615806296
Durationlong

通信持续时长,单位:秒。

100
UserCntinteger

通信用户数。

5
BadExpUserCntinteger

通信体验差的用户数。

0
RequestIdstring

请求 ID。

231470C1-ACFB-4C9F-844F-4CFE1E3804C5

示例

正常返回示例

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错误码错误信息描述
400ApiParamErrorAPI %s.Api参数错误
403BizAppErrorA business application permission error occurred.业务应用权限错误
403BizUidErrorA business UID error occurred.业务主账号错误
500ServerInternalErrorAn internal error occurred.服务器内部错误

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-28OpenAPI 错误码发生变更查看变更详情
上一篇: 通信监测 下一篇: DescribeCall - 查询单次通信详情
阿里云首页 音视频通信 相关技术圈