企业内部开发
基础
连接微信
办公
会议
会议统计管理
企业内部开发
服务端API
会议
预约会议高级管理
获取会议健康度
获取会议健康度
最后更新:2023/05/12

获取已结束会议的会议及参会成员的健康度。

请求方式: POST(HTTPS
请求地址: https://qyapi.weixin.qq.com/cgi-bin/meeting/get_quality?access_token=ACCESS_TOKEN

请求包体:

{
	"meetingid": "MEETINGID",
	"sub_meetingid": "SUB_MEETING_ID",
	"start_time": 168888888,
	"cursor": "CURSOR",
	"limit": 20
}

参数说明:

参数必须类型说明
access_tokenstring调用接口凭证。获取方法查看“获取access_token
meetingidstring会议ID
sub_meetingidstring周期性子会议ID
说明:可通过查询成员的会议列表、查询会议接口获取返回的子会议 ID,即 current_sub_meetingid;如果是周期性会议,此参数必传。
start_timeint32参会时间过滤起始时间,UNIX 时间戳(单位秒),可查询的时间区间为过去7天到现在。
返回 meeting_id 对应会议房间下,开始时间大于等于 start_time 且离 start_time 最近的一个媒体房间数据(从第一个人入会到会中成员全部离开会议形成一个媒体房间,若同一会议号下再次有人入会则形成新的媒体房间)。
cursorstring分页查询用,将上一个请求返回的next_cursor字段传入。第一次查询时可不传值
limitint32分页大小,默认50,最大50

 

注意:
limit参数必须与首次调用获得cursor时传入的limit一致。

权限说明

  • 仅配置在“可调用接口的应用”列表中的自建应用可调用
  • 仅允许查询该应用创建的会议的数据
  • 仅返回在应用可见范围内的成员

 

返回结果:

{
	"errcode": 0,
	"errmsg": "ok",
	"quality": 0,
	"audio_quality": 1,
	"video_quality": 2,
	"screen_share_quality": 1,
	"network_quality": 1,
	"problems": [
		"PROBLEM1"
	],
	"attendees":[
		{
			"userid": "USERID",
			"tmp_openid": "TMP_OPENID",
			"instance_id": 1,
			"quality": 1,
			"audio_quality": 1,
			"video_quality": 1,
			"screen_share_quality": 1,
			"network_quality": 1,
			"problems":[
				"PROBLEM1"
			]
		}
	],
	"next_cursor": "NEXT_CURSOR",
	"has_more": true
}

参数说明

参数类型说明
errcodeint32返回码
errmsgstring对返回码的文本描述内容
qualityint32健康度:
0:无数据
1:健康
2:告警
audio_qualityint32音频质量:
0:无数据
1:好
2:较好
3:中
4:差
video_qualityint32视频质量:
0:无数据
1:好
2:较好
3:中
4:差
screen_share_qualityint32共享屏幕质量:
0:无数据
1:好
2:较好
3:中
4:差
network_qualityint32网络质量:
0:无数据
1:好
2:较好
3:中
4:差
problemsstring[]告警的具体问题列表
attendeesobject[]参会人员健康度列表(按成员入会时间正序排列,入会越早的在越上面;成员使用不同端入会时平铺返回数据,instance_id 不同)。详见Attendee。
next_cursorstring分页用,下一次拉取列表将该字段填入cursor字段
has_morebool是否还有待拉取的列表

 

Attendee说明

参数类型说明
useridstring成员userid
tmp_openidstring当场会议的成员临时 ID,可用于会控操作,适用于所有成员。
instance_idint32成员的终端设备类型:
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
qualityint32健康度:
0:无数据
1:健康
2:告警
audio_qualityint32音频质量:
0:无数据
1:好
2:较好
3:中
4:差
video_qualityint32视频质量:
0:无数据
1:好
2:较好
3:中
4:差
screen_share_qualityint32共享屏幕质量:
0:无数据
1:好
2:较好
3:中
4:差
network_qualityint32网络质量:
0:无数据
1:好
2:较好
3:中
4:差
problemsstring[]告警的具体问题列表

 

上一篇更新会议嘉宾列表
下一篇修改会议报名配置
    本节内容
服务端API
基础
连接微信
办公
会议
会议统计管理
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们