接口描述
描述:查询已结束会议的会议及参会成员的健康度,付费开通该服务的企业管理员、超管可以查询,与是否为会议创建者、主持人或联席主持人无关。
请求方式:GET
鉴权方式:支持 JWT 鉴权和 Oauth 鉴权
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/quality
输入参数
参数名称 | 是否必须 | 参数描述 |
operator_id | 是 | 操作者 ID。 operator_id 必须与 operator_id_type 配合使用根据 operator_id_type 的值,operator_id 代表不同类型。 角色校验:付费开通该服务的企业管理员/超管可以查询健康度。 |
operator_id_type | 是 | 操作者 ID 的类型: 1:企业内用户 userid 2:open_id 4:ms_open_id |
instanceid | 否 | 用户的终端设备类型: 0:PSTN 1:PC 2:Mac 3:Android 4:iOS 5:Web 6:iPad 7:Android Pad 8:小程序 9:voip、sip 设备 10:linux 20:Rooms for Touch Windows 21:Rooms for Touch MacOS 22:Rooms for Touch Android 30:Controller for Touch Windows 32:Controller for Touch Android 33:Controller for Touch iOS |
sub_meeting_id | 否 | 周期性会议子会议 ID。 说明:可通过查询用户的会议列表、查询会议接口获取返回的子会议 ID,即 current_sub_meeting_id;如果是周期性会议,此参数必传。 |
page_size | 是 | 分页大小,最大50。 |
page | 是 | 当前页,页码起始值为1。 |
start_time | 是 | 参会时间过滤起始时间,UNIX 时间戳(单位秒),可查询的时间区间为过去7天到现在。 返回 meeting_id 对应会议房间下,开始时间大于等于 start_time 且离 start_time 最近的一个媒体房间数据(从第一个人入会到会中成员全部离开会议形成一个媒体房间,若同一会议号下再次有人入会则形成新的媒体房间)。 如果同一会议号下有多个媒体房间,请先使用“获取账户级已结束会议列表”接口查询,获知需查询的媒体房间的 start_time。 |
输出参数
参数名称 | 参数类型 | 是否必须 | 参数描述 |
meeting_id | String | 必须 | 会议的唯一 ID。 |
quality | Integer | 必须 | 健康度: 0:无数据 1:健康 2:告警 |
audio_quality | Integer | 必须 | 音频质量: 0:无数据 1:好 2:较好 3:中 4:差 |
video_quality | Integer | 必须 | 视频质量: 0:无数据 1:好 2:较好 3:中 4:差 |
screen_share_quality | Integer | 必须 | 共享屏幕质量: 0:无数据 1:好 2:较好 3:中 4:差 |
network_quality | Integer | 非必须 | 网络质量: 0:无数据 1:好 2:较好 3:中 4:差 |
problems | String [] | 必须 | 告警的具体问题。 |
participants | Participant 对象数组 | 必须 | 参会人员健康度对象数组(按成员入会时间正序排列,入会越早的在越上面;成员使用不同端入会时平铺返回数据,instanceid 不同)。 |
current_page | Integer | 必须 | 分页查询返回当前页码。 |
current_size | Integer | 必须 | 分页查询返回单页数据条数。| |
total_count | Integer | 必须 | 分页查询返回数据总数。 |
total_page | Integer | 必须 | 分页查询返回分页总数。 |
Participant 对象
参数名称 | 参数类型 | 是否必须 | 参数描述 |
userid | String | 必须 | 企业内部请使用企业唯一用户标识; 其他企业、个人和小程序没有。 |
open_id | String | 必须 | OAuth2.0 鉴权用户请使用 open_id。 |
ms_open_id | String | 必须 | 当场会议的用户临时 ID,可用于会控操作,适用于所有用户。 |
instanceid | String | 必须 | 用户的终端设备类型: 0:PSTN 1:PC 2:Mac 3:Android 4:iOS 5:Web 6:iPad 7:Android Pad 8:小程序 9:voip、sip 设备 10:Linux 20:Rooms for Touch Windows 21:Rooms for Touch MacOS 22:Rooms for Touch Android 30:Controller for Touch Windows 32:Controller for Touch Android 33:Controller for Touch iOS |
quality | Integer | 必须 | 用户健康度: 0:无数据 1:健康 2:告警 |
audio_quality | Integer | 必须 | 音频质量: 0:无数据 1:好 2:较好 3:中 4:差 |
video_quality | Integer | 必须 | 视频质量: 0:无数据 1:好 2:较好 3:中 4:差 |
screen_share_quality | Integer | 必须 | 共享屏幕质量: 0:无数据 1:好 2:较好 3:中 4:差 |
network_quality | Integer | 非必须 | 网络质量: 0:无数据 1:好 2:较好 3:中 4:差 |
problems | Sring [] | 必须 | 告警的具体问题。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 9042 | 无权限操作。 |
400 | 190301 | 请求重放错误,请求头里的 X-TC-Timestamp 和 X-TC-Nonce 每次请求时需重新生成,不能使用和过去五分钟内相同的 timestamp 和 nonce。 |
400 | 9003 | 会议信息不存在。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
500 | 190001 | 存在未注册的用户。 |
500 | 41 | 网络错误,请稍后重试。 |
500 | 190310 | 每分钟总接口调用次数超过限制。 |
示例
输入示例
GET https://api.meeting.qq.com/v1/meetings/100001/quality?operator_id_type=2&operator_id=xeKgO2E0K903KW&instanceid=2&start_time=1678939200&page=1&page_size=20
输出示例
{"meeting_id": "100001","quality": 1,"audio_quality": 0,"video_quality": 0,"screen_share_quality": 0,"network_quality": 0,"problems": [],"participants": [{"userid": "abcd","open_id": "abcd","ms_open_id": "FImM5EqqmQGB9I/jppr0tjaCaQcyEjQsd0dVYY+6qCin","user_name": "test user","instanceid": "2","quality": 1,"audio_quality": 0,"video_quality": 0,"screen_share_quality": 0,"network_quality": 0,"problems": []}],"total_count": 1,"total_page": 1,"current_page": 1,"current_size": 1}