查询会议室配置

查询一个范围内的会议室配置。

Warning: 根据查询范围传入对应的参数

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/vc/v1/room_configs/query
HTTP Method	GET
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	vc:room:readonly 获取视频会议室信息
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

查询参数

名称	类型	必填	描述
scope	int	是	查询节点范围 示例值：5 可选值有： - 1: 租户 - 2: 国家/地区 - 3: 城市 - 4: 建筑 - 5: 楼层 - 6: 会议室
country_id	string	否	国家/地区ID scope为2，3时需要此参数 示例值："086"
district_id	string	否	城市ID scope为3时需要此参数 示例值："001"
building_id	string	否	建筑ID scope为4，5时需要此参数 示例值："22"
floor_name	string	否	楼层 scope为5时需要此参数 示例值："4"
room_id	string	否	会议室ID scope为6时需要此参数 示例值："6383786266263"
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

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	room_config	-
└ room_background	string	飞书会议室背景图
└ display_background	string	飞书签到板背景图
└ digital_signage	room_digital_signage	飞书会议室数字标牌
└ enable	boolean	是否开启数字标牌功能
└ mute	boolean	是否静音播放
└ start_display	int	在会议结束n分钟后开始播放，取值1~720（仅对飞书会议室数字标牌生效）
└ stop_display	int	在日程会议开始前n分钟停止播放，取值1~720（仅对飞书会议室数字标牌生效）
└ materials	room_digital_signage_material\[\]	素材列表
└ id	string	素材ID，当设置新素材时，无需传递该字段
└ name	string	素材名称
└ material_type	int	素材类型 可选值有： - 1: 图片 - 2: 视频 - 3: GIF
└ url	string	素材url
└ duration	int	播放时长（单位sec），取值1~43200
└ cover	string	素材封面url
└ md5	string	素材文件md5
└ vid	string	素材文件vid
└ size	string	素材文件大小（单位byte）
└ room_box_digital_signage	room_digital_signage	飞书投屏盒子数字标牌
└ enable	boolean	是否开启数字标牌功能
└ mute	boolean	是否静音播放
└ start_display	int	在会议结束n分钟后开始播放，取值1~720（仅对飞书会议室数字标牌生效）
└ stop_display	int	在日程会议开始前n分钟停止播放，取值1~720（仅对飞书会议室数字标牌生效）
└ materials	room_digital_signage_material\[\]	素材列表
└ id	string	素材ID，当设置新素材时，无需传递该字段
└ name	string	素材名称
└ material_type	int	素材类型 可选值有： - 1: 图片 - 2: 视频 - 3: GIF
└ url	string	素材url
└ duration	int	播放时长（单位sec），取值1~43200
└ cover	string	素材封面url
└ md5	string	素材文件md5
└ vid	string	素材文件vid
└ size	string	素材文件大小（单位byte）
└ 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	是否在恢复启用时发送通知给联系人

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "room_background": "https://lf1-ttcdn-tos.pstatp.com/obj/xxx",
        "display_background": "https://lf1-ttcdn-tos.pstatp.com/obj/xxx",
        "digital_signage": {
            "enable": true,
            "mute": true,
            "start_display": 3,
            "stop_display": 3,
            "materials": [
                {
                    "id": "7847784676276",
                    "name": "name",
                    "material_type": 0,
                    "url": "url",
                    "duration": 15,
                    "cover": "url",
                    "md5": "md5",
                    "vid": "vid",
                    "size": "100"
                }
            ]
        },
        "room_box_digital_signage": {
            "enable": true,
            "mute": true,
            "start_display": 3,
            "stop_display": 3,
            "materials": [
                {
                    "id": "7847784676276",
                    "name": "name",
                    "material_type": 0,
                    "url": "url",
                    "duration": 15,
                    "cover": "url",
                    "md5": "md5",
                    "vid": "vid",
                    "size": "100"
                }
            ]
        },
        "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
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	121001	internal error	服务器内部错误，如果重试无效可联系管理员
400	121002	not support	暂不支持该功能
400	121003	param error	参数错误，检查参数的取值范围（请按照上面字段说明自查）
404	121004	data not exist	无效的请求体，请确保请求方法、请求信息、请求数据格式等是正确的