文档

DescribeChannelOverallData - 查询频道概览数据

更新时间:

本接口用于查询频道概览数据。

接口说明

使用说明

本接口用于查询频道概览数据。例如:您可以查询通信基本信息、指标趋势图等信息。

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

APP ID。

testappid
ChannelIdstring

频道 ID。

testid
CreatedTslong

创建频道的时间戳,支持查询最近 30 天的数据。使用 UNIX 时间戳表示,单位:秒。

1615860711
DestroyedTslong

频道释放时间,使用 UNIX 时间戳表示,单位:秒。参数为空表示获取当前时间。

说明 如果传入的频道释放时间超过真实的释放时间,将返回从创建时间开始到真实释放时间之间的数据。
1615860811

返回参数

名称类型描述示例值
object
MetricDatasobject []

指标数据列表。

Typestring

指标类型。取值:

  • CALL_QUALITY:通信质量。
  • CONN_NUM:加入频道成功用时的区间分布。
CALL_QUALITY
Nodesobject []

指标趋势图坐标点列表。

Xstring

指标趋势图中 x 轴横坐标。

1612418625
Ystring

指标趋势图中 y 轴纵坐标。

123
Extobject

扩展数据。

OverallDataobject

概览数据。

ConnAvgTimefloat

平均通信连接的用时,单位:秒。

0.5
FiveSecJoinRatefloat

5 秒内连通成功率,用小数表示,例如 1.0 表示连通成功率为 100%。

0.91
TotalAudioStuckRatefloat

整体音频卡顿率,用小数表示,例如 0.02 表示音频卡顿率为 2%。

0.02
TotalVideoStuckRatefloat

整体视频卡顿率,用小数表示,例如 0.02 表示视频卡顿率为 2%。

0.02
TotalVideoVagueRatefloat

整体视频模糊率,用小数表示,例如 0.02 表示视频模糊率为 2%。

0.02
CallInfoobject

通信基本信息。

AppIdstring

应用 ID。

testappid
ChannelIdstring

频道 ID。

testid
CallStatusstring

通信状态。取值:

  • IN:进行中。

  • OUT:已结束。

IN
CreatedTslong

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

1615860711
DestroyedTslong

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

1615860811
Durationlong

频道时长,单位:秒。

100
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "MetricDatas": [
    {
      "Type": "CALL_QUALITY",
      "Nodes": [
        {
          "X": "1612418625",
          "Y": "123",
          "Ext": {
            "test": "test",
            "test2": 1
          }
        }
      ]
    }
  ],
  "OverallData": {
    "ConnAvgTime": 0.5,
    "FiveSecJoinRate": 0.91,
    "TotalAudioStuckRate": 0.02,
    "TotalVideoStuckRate": 0.02,
    "TotalVideoVagueRate": 0.02
  },
  "CallInfo": {
    "AppId": "testappid",
    "ChannelId": "testid",
    "CallStatus": "IN",
    "CreatedTs": 1615860711,
    "DestroyedTs": 1615860811,
    "Duration": 100
  },
  "RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}

错误码

HTTP status code错误码错误信息描述
400ApiParamErrorAPI %s.Api参数错误
403BizCreatedTsErrorA business CreatedTs error occurred.参数会议创建时间不准确。
403BizAppErrorA business application permission error occurred.业务应用权限错误
403BizUidErrorA business UID error occurred.业务主账号错误
500ServerInternalErrorAn internal error occurred.服务器内部错误

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