接口描述
描述:查询企业的会议室告警信息,告警的阈值依赖 企业管理后台设置。
请求方式: GET
自建应用权限点:查看企业会议室详细信息,管理企业会议室详细信息。
接口请求域名:
https://api.meeting.qq.com/v1/meeting-rooms-monitor/monitor-info
输入参数
参数名称 | 是否必须 | 参数类型 | 参数描述 |
operator_id | 否 | String | 操作者 ID。 operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 |
operator_id_type | 否 | Integer | 操作者 ID 的类型: 3:rooms_id 5:meeting_room_id |
page | 否 | Integer | 当前页,大于等于1,默认为1。 |
page_size | 否 | Integer | 分页大小,默认为20,最大为50。 |
输出参数
参数名称 | 必选 | 参数类型 | 参数描述 |
current_page | 是 | Number | 当前页数。 |
total_page | 是 | Number | 总页数。 |
current_size | 是 | Number | 当前页实际大小。 |
total_count | 是 | Number | 总数据条数。 |
monitor_info_list | 是 | MonitorInfoList 对象数组 | 告警信息。 |
MonitorInfoList 对象
参数名称 | 是否必须 | 参数类型 | 参数描述 |
rooms_id | 必须 | String | Rooms ID。 |
meeting_room_id | 必须 | Number | 会议室 ID。 |
bool_is_support_screen_touch | 必须 | Boolean | 设备类型。 true:触屏 false:非触屏 |
device_model | 必须 | String | 型号。 |
app_version | 必须 | String | 应用程序版本。 |
health_status | 必须 | Integer | 健康状态。 1:代表普通警告 2:代表严重警告 |
str_device_connect_status | 必须 | String | 设备状态。 ONLINE:在线 OFFLINE:离线 |
alarm_info_list | 必须 | AlarmInfoList 对象数组 | - |
AlarmInfoList 对象
参数名称 | 是否必须 | 参数类型 | 参数描述 |
health_desc | 必须 | String | 问题描述。 |
create_time | 必须 | String | 问题时间。 |
health_code | 必须 | String | display_refresh_too_low:显示器刷新率过低。 cpu_occupancy_rate_overtop:CPU 占用过高。 speaker_volume_too_low:扬声器音量过低。 controller_power_too_low:控制器电量过低。 device_temperature_overtop:设备温度过高。 controller_disconnect:控制器断开连接。 no_available_mic:无可用麦克风。 no_available_speaker:无可用扬声器。 no_available_camera:无可用摄像头。 device_off_line:设备掉线。 memory_occupancy_rate_overtop:内存占用过高。 screen_disconnect:会议室显示器断开连接。 ethernet_changed:有线网络断开连接。 device_token_expire:设备登录态即将过期。 upstream_packet_loss_overtop:上行丢包率过高。 downstream_packet_loss_overtop:下行丢包率过高。 network_delay_overtop:网络延迟过高。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
500 | 190310 | 每分钟总接口调用次数超过限制。 |
示例
输入示例
GEThttps://api.meeting.qq.com/v1/meeting-rooms-monitor/monitor-info?operator_id=14411xxxxxxxxxx002&operator_id_type=3&page=1&page_size=20
输出示例
{"total_count": 1,"current_page": 1,"current_size": 1,"total_page": 1,"monitor_info_list": [{"rooms_id": "14411xxxxxxxxxxxxx002","bool_is_support_screen_touch": false,"device_model": "","app_version": "x.x.x.x","health_status": 2,"str_device_connect_status": "OFFLINE","alarm_info_list": [{"health_desc": "登录态:设备登录态即将过期","create_time": "2022-04-16T06:00:25+08:00","health_code": "device_token_expire"},{"health_desc": "连接:设备掉线","create_time": "2022-02-22T11:18:00+08:00","health_code": "device_off_line"}],"meeting_room_id": "xxxxx"}]}