Skip to content

查询会议室预定数据

查询会议室预定数据,具体权限要求请参考「资源介绍」。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/vc/v1/resource_reservation_list
HTTP MethodGET
接口频率限制100 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用vc:room:readonly 获取视频会议室信息

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

查询参数

名称类型必填描述
room_level_idstring层级ID,如传递非omb前缀的异常ID时,会默认使用租户层级进行兜底
示例值:omb_57c9cc7d9a81e27e54c8fabfd02759e7
need_topicboolean是否展示会议主题
示例值:true
start_timestring查询开始时间(unix时间,单位sec)
示例值:1655276858
end_timestring查询结束时间(unix时间,单位sec)
示例值:1655276858
room_idsstring\[\]待筛选的会议室ID列表;如需要传递多个会议室ID,需要通过room_ids=aaaa&room_ids=bbbb&room_ids=cccc的形式传递
示例值:omm_eada1d61a550955240c28757e7dec3af
is_excludeboolean默认为false;若为false,则获取room_ids字段传入的会议室列表预定数据;若为true,则根据room_level_id字段获取层级下的会议室列表,并过滤掉room_ids范围的会议室,获取剩余会议室的预定数据
示例值:false
page_sizeint分页尺寸大小
示例值:20
默认值20
数据校验规则
- 取值范围:20100
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:20

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ room_reservation_listroom_meeting_reservation\[\]会议室预定列表
    └ room_idstring会议室ID
    └ room_namestring会议室名称
    └ event_titlestring会议标题
    └ reserverstring预定人
    └ reserver_user_idstring预定人ID
    └ department_of_reserverstring预定人所属部门
    └ guests_numberstring邀约人数
    └ accepted_numberstring接受人数
    └ event_start_timestring会议开始时间
    └ event_end_timestring会议结束时间
    └ event_durationstring会议时长
    └ reservation_statusstring会议室预定状态
    └ check_in_devicestring签到设备
    └ room_check_in_statusstring会议室签到状态
    └ check_in_timestring会议室签到时间
    └ is_release_earlystring是否提前释放
    └ releasing_personstring释放人
    └ releasing_timestring释放时间
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "room_reservation_list": [
            {
                "room_id": "omm_4de32cf10a4358788ff4e09e37ebbf9b",
                "room_name": "VIP Meeting Room",
                "event_title": "飞书邀请的日程",
                "reserver": "kehan",
                "reserver_user_id": "ou_1234567(UserID);cli_123123(BotID)",
                "department_of_reserver": "development",
                "guests_number": "5",
                "accepted_number": "2",
                "event_start_time": "2022.12.17 21:00:00 (GMT+08:00)",
                "event_end_time": "2022.12.17 22:00:00 (GMT+08:00)",
                "event_duration": "1:00:00",
                "reservation_status": "预定成功",
                "check_in_device": "签到板",
                "room_check_in_status": "已签到",
                "check_in_time": "2022.12.09 13:35:30 (GMT+08:00)",
                "is_release_early": "已释放(手动释放)",
                "releasing_person": "kehan",
                "releasing_time": "2022.12.20 11:25:15 (GMT+08:00)"
            }
        ],
        "page_token": "20",
        "has_more": true
    }
}

错误码

HTTP状态码错误码描述排查建议
500121001internal error服务器内部错误,如果重试无效可联系管理员
400121002not support暂不支持该功能
400121003param error参数错误,检查参数的取值范围(请按照上面字段说明自查)
400126005start time error (cannot larger than now or smaller than 0)开始时间不能大于当前时间或者小于0
400126006end time cannot exceed start time for one day or smaller than start time结束时间不能超过开始时间一天或者小于开始时间
404121004data not exist无效的请求体,请确保请求方法、请求信息、请求数据格式等是正确的
403121005no permission无权限进行该操作,建议检查token类型、操作者身份以及资源的归属

内容来源:飞书开放平台 · 自动爬取整理