批量查询会议室详情
该接口可以使用会议室 ID 批量查询会议室详情。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/vc/v1/rooms/mget |
| HTTP Method | POST |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | vc:room 更新视频会议室信息 vc:room:readonly 获取视频会议室信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id_type | string | 否 | 用户 ID 类型 示例值:open_id 可选值有: - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
room_ids | string\[\] | 是 | 会议室id列表 示例值:["omm_32864aa53cad6fc3c866aeb0d15cd0cc"] |
请求体示例
json
{
"room_ids": [
"omm_32864aa53cad6fc3c866aeb0d15cd0cc"
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | room\[\] | 会议室列表 |
└ room_id | string | 会议室ID |
└ name | string | 会议室名称 |
└ capacity | int | 会议室能容纳的人数 |
└ description | string | 会议室的相关描述 |
└ display_id | string | 会议室的展示ID |
└ custom_room_id | string | 自定义的会议室ID |
└ room_level_id | string | 层级ID |
└ path | string\[\] | 层级路径 |
└ room_status | room_status | 会议室状态 |
└ status | boolean | 是否启用会议室 |
└ schedule_status | boolean | 会议室未来状态为启用或禁用 |
└ disable_start_time | string | 禁用开始时间(unix时间,单位sec) |
└ disable_end_time | string | 禁用结束时间(unix时间,单位sec,数值0表示永久禁用) |
└ disable_reason | string | 禁用原因 |
└ contact_ids | string\[\] | 联系人列表,id类型由user_id_type参数决定 |
└ disable_notice | boolean | 是否在禁用时发送通知给预定了该会议室的员工 |
└ resume_notice | boolean | 是否在恢复启用时发送通知给联系人 |
└ device | device\[\] | 设施信息列表 |
└ name | string | 设施名称 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"room_id": "omm_4de32cf10a4358788ff4e09e37ebbf9b",
"name": "测试会议室",
"capacity": 10,
"description": "测试会议室描述",
"display_id": "LM134742334",
"custom_room_id": "1234",
"room_level_id": "omb_4ad1a2c7a2fbc5fc9570f38456931293",
"path": [
"omb_8d020b12fe49e82847c2af3c193d5754"
],
"room_status": {
"status": true,
"schedule_status": true,
"disable_start_time": "1652356050",
"disable_end_time": "1652442450",
"disable_reason": "测试占用",
"contact_ids": [
"ou_3ec3f6a28a0d08c45d895276e8e5e19b"
],
"disable_notice": true,
"resume_notice": true
},
"device": [
{
"name": "电话"
}
]
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 121001 | internal error | 服务器内部错误,如果重试无效可联系管理员 |
| 400 | 121002 | not support | 暂不支持该功能 |
| 400 | 121003 | param error | 参数错误,检查参数的取值范围(请按照上面字段说明自查) |
| 404 | 121004 | data not exist | 请求的数据不存在 |
| 404 | 121005 | no permission | 无权限进行该操作,建议检查token类型、操作者身份以及资源的归属 |
| 404 | 121006 | data conflict | 通常由于CAS机制导致,可在更新数据后重试 |
