接口描述
描述:查询企业下的可用设备列表,目前暂不支持 OAuth2.0 鉴权访问。
请求方式:GET
接口操作者权限点:需具备会议室管理的查看权限。
接口请求域名:
https://api.meeting.qq.com/v1/devices?page={page}&page_size={page_size}&meeting_room_name={meeting_room_name}&operator_id={operator_id}&operator_id_type={operator_id_type}
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
operator_id | 是 | String | 操作者 ID。 operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 |
operator_id_type | 是 | Integer | 操作者 ID 的类型: 1:userid |
page | 否 | Integer | 页码,从1开始,默认1。 |
page_size | 否 | Integer | 分页大小,从1开始,最大50,默认20。 |
meeting_room_name | 否 | String | 会议室名称(支持模糊匹配查找)。 |
输出参数
参数名称 | 必选 | 参数类型 | 参数描述 |
total_count | 是 | Integer | 分页查询返回数据总数。 |
current_size | 是 | Integer | 分页查询返回单页数据条数。 |
current_page | 是 | Integer | 分页查询返回当前页码。 |
total_page | 是 | Integer | 分页查询返回分页总数。 |
device_info_list | 否 | DeviceInfoList 对象数组 | 设备信息对象列表。 |
DeviceInfoList 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
meeting_room_id | 是 | String | 会议室 ID。 |
rooms_id | 是 | String | Rooms ID。 |
meeting_room_name | 是 | String | 会议室名称。 |
meeting_room_location | 是 | String | 会议室地址。 |
device_model | 否 | String | 设备型号。 |
app_version | 否 | String | 应用程序版本。 |
meeting_room_status | 是 | Integer | 会议室状态: 0:未激活 1:未绑定 2:空闲 3:使用中 4:离线 |
device_monitor_info | 是 | DeviceMonitorInfo 对象 | 设备健康列表。 |
DeviceMonitorInfo 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
camera_status | 是 | Boolean | 摄像头健康状态。 |
microphone_status | 是 | Boolean | 麦克风健康状态。 |
speaker_status | 是 | Boolean | 扬声器健康状态。 |
错误码列表
状态码 | 错误码 | 错误描述 |
500 | 190310 | 每分钟总接口调用次数超过限制。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
500 | 20201 | 查询会议室信息失败。 |
示例
输入示例
GEThttps://api.meeting.qq.com/v1/devices?page=1&page_size=2&meeting_room_name=会议室&operator_id=14411xxxxxxxxxx002&operator_id_type=1
输出示例
{"total_count":200,"total_page":100,"current_page":1,"current_size":2,"device_info_list":[{"meeting_room_id":"100001","rooms_id":"1445237896","meeting_room_name":"会议室测试1","meeting_room_location":"广州-大厦-10","device_model":"TT-IP65T","app_version":"999.999.999.999","meeting_room_status":4,"device_monitor_info":{"camera_status":true,"microphone_status":true,"speaker_status":true}},{"meeting_room_id":"100002","rooms_id":"1445336789","meeting_room_name":"会议室测试2","meeting_room_location":"西安-广场-19","device_model":"","app_version":"2.7.4.14","meeting_room_status":4,"device_monitor_info":{"camera_status":true,"microphone_status":true,"speaker_status":true}}]}