文档

DescribeQoeMetricData - 单次通信中下行体验质量指标

更新时间:

本接口用于获取单次通信中用户的下行体验质量指标。

接口说明

使用说明

本接口用于获取单次通信中用户的下行体验质量指标。例如:您可以获取影响通信体验的指标类型、音视频指标趋势图等信息。

QPS 限制

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

调试

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

授权信息

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

请求参数

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

APP ID。

testappid
ChannelIdstring

频道 ID。

testid
CreatedTslong

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

1614936817
DestroyedTslong

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

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

用户 ID。

testuserid

返回参数

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

视频数据。

Typestring

影响通信体验的指标类型。取值:

  • VIDEO_CAMERA:摄像头码率。
  • VIDEO_SCREEN_SHARE:共享屏幕流码率。
  • VIDEO_STUCK_CAMERA:摄像头卡顿。
  • VIDEO_STUCK_SCREEN_SHARE:屏幕共享卡顿。
  • VIDEO_VAGUE_CAMERA:摄像头模糊。
  • VIDEO_VAGUE_SCREEN_SHARE:屏幕共享模糊。
VIDEO_CAMERA
UserIdstring

用户 ID

testuserid2
Nodesobject []

视频指标趋势图坐标点列表。

Xstring

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

1548670256
Ystring

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

123
AudioDataobject []

音频数据。

Typestring

通信体验。取值:

  • AUDIO:音频码率。
  • AUDIO_STUCK:音频下行卡顿。
AUDIO
UserIdstring

用户 ID。

testuserid2
Nodesobject []

音频指标趋势图坐标点列表。

Xstring

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

1548670256
Ystring

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

123
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "VideoData": [
    {
      "Type": "VIDEO_CAMERA",
      "UserId": "testuserid2",
      "Nodes": [
        {
          "X": "1548670256",
          "Y": "123"
        }
      ]
    }
  ],
  "AudioData": [
    {
      "Type": "AUDIO",
      "UserId": "testuserid2",
      "Nodes": [
        {
          "X": "1548670256",
          "Y": "123"
        }
      ]
    }
  ],
  "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.服务器内部错误

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