接口描述
描述:拥有企业会议列表 > 会控权限的成员,能够获取实时会议质量检测数据。 支持云会议和 Webinar 会议的数据。会议状态为进行中。
请求方式:GET
鉴权:JWT
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/qos
路径参数
参数名称 | 必选 | 参数类型 | 参数描述 |
meeting_id | 是 | String | 会议 ID。每场会议查询限频30次/min。 |
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
operator_id | 是 | String | 操作者 ID。 |
operator_id_type | 是 | Integer | 操作者 ID 类型。 1:userid |
page_size | 否 | Integer | 分页大小,20-100,默认20。 |
page | 否 | Integer | 页码,大于等于1,默认从1开始。 |
to_operator_id | 否 | String | 筛选的用户 ID。 |
to_operator_id_type | 否 | Integer | 筛选的用户 ID 类型。 4:ms_open_id |
key | 否 | String | 筛选指标。 格式:模块名_指标名,例如 video_upstream_bitrate |
min_value | 否 | String | 最小搜索值,搜索大于等于该值的数据。 |
max_value | 否 | String | 最大搜索值,搜索小于等于该值的数据。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
total_count | Integer | 总数据条数。 |
current_size | Integer | 当前页大小。 |
total_page | Integer | 总页数。 |
current_page | Integer | 当前页码。 |
participants | Participant 对象数组 | 成员质量列表。 |
Participant 对象
参数名称 | 参数类型 | 参数描述 |
ms_open_id | String | 成员会中 ID。 |
nick_name | String | 会中用户名。 |
qos_details | QosDetails 对象 | 质量检测数据。 |
QosDetails 对象
参数名称 | 参数类型 | 参数描述 |
instanceid | Integer | 设备 ID。 |
audio | Audio对象 | 音频质量对象。 |
video | Video对象 | 视频质量对象。 |
network | Network对象 | 网络质量对象。 |
share_screen | ShareScreen 对象 | 屏幕共享质量对象。 |
Audio 对象
参数名称 | 参数类型 | 参数描述 |
upstream_bitrate | String | 上行码率(kbps)。 |
downstream_bitrate | String | 下行码率(kbps)。 |
mic_volume | String | 麦克风采集音量(db)。 |
loudspeaker_volume | String | 扬声器播放音量(db)。 |
Video 对象
参数名称 | 参数类型 | 参数描述 |
upstream_bitrate | String | 上行码率(kbps)。 |
downstream_bitrate | String | 下行码率(kbps)。 |
upstream_framerate | String | 上行帧率(fps)。 |
downstream_framerate | String | 下行帧率(fps)。 |
upstream_resolution | String | 上行分辨率。 |
downstream_resolution | String | 下行分辨率。 |
Network 对象
参数名称 | 参数类型 | 参数描述 |
network_delay | String | 网络延迟(ms)。 |
upstream_packet_loss | String | 上行丢包(%)。 |
downstream_packet_loss | String | 下行丢包(%)。 |
upstream_bindwidth | String | 上行带宽(kbps)。 |
downstream_bindwidth | String | 下行带宽(kbps)。 |
ShareScreen对象
参数名称 | 参数类型 | 参数描述 |
upstream_framerate | String | 上行帧率(fps)。 |
downstream_framerate | String | 下行帧率(fps)。 |
upstream_bitrate | String | 上行码率(kbps)。 |
downstream_bitrate | String | 下行码率(kbps)。 |
upstream_resolution | String | 上行分辨率。 |
downstream_resolution | String | 下行分辨率。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
400 | 190457 | 会议不存在, 请核对 meeting_id。 |
400 | 550000 | 请求超时,请稍后再试。 |
400 | 190310 | 每分钟总接口调用次数超过限制。 |
400 | 190301 | 请求重放错误,请求头里的 X-TC-Timestamp 和 X-TC-Nonce 每次请求时需重新生成,不能使用和过去五分钟内相同的 timestamp 和 nonce。 |
400 | 500042 | 查询实时质量数据失败。 |
示例代码
输入示例
GET https://api.meeting.qq.com/v1/meetings/12345678/qos?operator_id=user1&operator_id_type=1&page_size=20&page=1
输出示例
{"total_count": 2,"current_size": 2,"total_page": 1,"current_page": 1,"participants": [{"ms_open_id": "5277x7UNN4FZujGOXXXXXXXXXXXXXXZCDkUDuqfNfdWCoJXP/r","nick_name": "testuser","qos_details": [{"instanceid": 9,"network": {"network_delay": "5","upstream_packet_loss": "0","downstream_packet_loss": "0","upstream_bindwidth": "1061","downstream_bindwidth": "6212"},"audio": {"upstream_bitrate": "50","downstream_bitrate": "58","mic_volume": "0","loudspeaker_volume": "61"},"video": {"upstream_bitrate": "760","downstream_bitrate": "0","upstream_framerate": "29","downstream_framerate": "0","upstream_resolution": "1280x720","downstream_resolution": "0x0"},"share_screen": {"upstream_framerate": "29","downstream_framerate": "29","upstream_bitrate": "760","downstream_bitrate": "760","upstream_resolution": "1280x720","downstream_resolution": "1280x720"}}]},{"ms_open_id": "5277x7UNN4FXXXXXXXXXXXXXwVDEiJJ+a9WmcadMgixyZ1a2xxlng==","nick_name": "testuser2","qos_details": [{"instanceid": 2,"network": {"network_delay": "50","upstream_packet_loss": "0","downstream_packet_loss": "0","upstream_bindwidth": "82","downstream_bindwidth": "114059"},"audio": {"upstream_bitrate": "64","downstream_bitrate": "64","mic_volume": "58","loudspeaker_volume": "67"},"video": {"upstream_bitrate": "0","downstream_bitrate": "795","upstream_framerate": "0","downstream_framerate": "29","upstream_resolution": "0x0","downstream_resolution": "1280x720"},"share_screen": {"upstream_framerate": "29","downstream_framerate": "29","upstream_bitrate": "700","downstream_bitrate": "800","upstream_resolution": "1280x720","downstream_resolution": "1280x720"}}]}]}