飞书开放平台 Server API 文档

主题

查询会议室配置 ​

该接口可以用来查询某个会议层级范围下或者某个会议室的配置。

请求 ​

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

请求头 ​

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

查询参数 ​

名称类型必填描述
scope_typeint是查询节点范围
示例值：1
可选值有：
- 1: 会议室层级 - 2: 会议室
scope_idstring是查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID
示例值：omm_608d34d82d531b27fa993902d350a307
user_id_typestring否用户 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

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ current_configscope_config当前节点的配置，根据层级顺序从底向上进行合并计算后的结果；如果当前节点某个值已配置，则取该节点的值，否则会从该节点的父层级节点获取，如果父节点依然未配置，则继续向上递归获取；若所有节点均未配置，则该值返回为空
    └ scope_typeint查询节点范围
可选值有：
- 1: 会议室层级 - 2: 会议室
    └ scope_idstring查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID
    └ scope_configroom_config节点配置
      └ room_backgroundstring飞书会议室背景图
      └ display_backgroundstring飞书签到板背景图
      └ digital_signageroom_digital_signage飞书会议室数字标牌
        └ if_cover_child_scopeboolean是否覆盖子层级及会议室
        └ enableboolean是否开启数字标牌功能
        └ muteboolean是否静音播放
        └ start_displayint在会议结束n分钟后开始播放，取值1~720（仅对飞书会议室数字标牌生效）
        └ stop_displayint在日程会议开始前n分钟停止播放，取值1~720（仅对飞书会议室数字标牌生效）
        └ materialsroom_digital_signage_material\[\]素材列表
          └ idstring素材ID，当设置新素材时，无需传递该字段
          └ namestring素材名称
          └ material_typeint素材类型
可选值有：
- 1: 图片 - 2: 视频 - 3: GIF
          └ urlstring素材url
          └ durationint播放时长（单位sec），取值1~43200
          └ coverstring素材封面url
          └ md5string素材文件md5
          └ vidstring素材文件vid
          └ sizestring素材文件大小（单位byte）
      └ room_box_digital_signageroom_digital_signage飞书投屏盒子数字标牌
        └ if_cover_child_scopeboolean是否覆盖子层级及会议室
        └ enableboolean是否开启数字标牌功能
        └ muteboolean是否静音播放
        └ start_displayint在会议结束n分钟后开始播放，取值1~720（仅对飞书会议室数字标牌生效）
        └ stop_displayint在日程会议开始前n分钟停止播放，取值1~720（仅对飞书会议室数字标牌生效）
        └ materialsroom_digital_signage_material\[\]素材列表
          └ idstring素材ID，当设置新素材时，无需传递该字段
          └ namestring素材名称
          └ material_typeint素材类型
可选值有：
- 1: 图片 - 2: 视频 - 3: GIF
          └ urlstring素材url
          └ durationint播放时长（单位sec），取值1~43200
          └ coverstring素材封面url
          └ md5string素材文件md5
          └ vidstring素材文件vid
          └ sizestring素材文件大小（单位byte）
      └ room_statusroom_status会议室状态
        └ statusboolean是否启用会议室
        └ schedule_statusboolean会议室未来状态为启用或禁用
        └ disable_start_timestring禁用开始时间（unix时间，单位sec）
        └ disable_end_timestring禁用结束时间（unix时间，单位sec，数值0表示永久禁用）
        └ disable_reasonstring禁用原因
        └ contact_idsstring\[\]联系人列表，id类型由user_id_type参数决定
        └ disable_noticeboolean是否在禁用时发送通知给预定了该会议室的员工
        └ resume_noticeboolean是否在恢复启用时发送通知给联系人
  └ origin_configsscope_config\[\]所有节点的原始配置，按照层级顺序从底向上返回；如果某节点某个值未配置，则该值返回为空
    └ scope_typeint查询节点范围
可选值有：
- 1: 会议室层级 - 2: 会议室
    └ scope_idstring查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID
    └ scope_configroom_config节点配置
      └ room_backgroundstring飞书会议室背景图
      └ display_backgroundstring飞书签到板背景图
      └ digital_signageroom_digital_signage飞书会议室数字标牌
        └ if_cover_child_scopeboolean是否覆盖子层级及会议室
        └ enableboolean是否开启数字标牌功能
        └ muteboolean是否静音播放
        └ start_displayint在会议结束n分钟后开始播放，取值1~720（仅对飞书会议室数字标牌生效）
        └ stop_displayint在日程会议开始前n分钟停止播放，取值1~720（仅对飞书会议室数字标牌生效）
        └ materialsroom_digital_signage_material\[\]素材列表
          └ idstring素材ID，当设置新素材时，无需传递该字段
          └ namestring素材名称
          └ material_typeint素材类型
可选值有：
- 1: 图片 - 2: 视频 - 3: GIF
          └ urlstring素材url
          └ durationint播放时长（单位sec），取值1~43200
          └ coverstring素材封面url
          └ md5string素材文件md5
          └ vidstring素材文件vid
          └ sizestring素材文件大小（单位byte）
      └ room_box_digital_signageroom_digital_signage飞书投屏盒子数字标牌
        └ if_cover_child_scopeboolean是否覆盖子层级及会议室
        └ enableboolean是否开启数字标牌功能
        └ muteboolean是否静音播放
        └ start_displayint在会议结束n分钟后开始播放，取值1~720（仅对飞书会议室数字标牌生效）
        └ stop_displayint在日程会议开始前n分钟停止播放，取值1~720（仅对飞书会议室数字标牌生效）
        └ materialsroom_digital_signage_material\[\]素材列表
          └ idstring素材ID，当设置新素材时，无需传递该字段
          └ namestring素材名称
          └ material_typeint素材类型
可选值有：
- 1: 图片 - 2: 视频 - 3: GIF
          └ urlstring素材url
          └ durationint播放时长（单位sec），取值1~43200
          └ coverstring素材封面url
          └ md5string素材文件md5
          └ vidstring素材文件vid
          └ sizestring素材文件大小（单位byte）
      └ room_statusroom_status会议室状态
        └ statusboolean是否启用会议室
        └ schedule_statusboolean会议室未来状态为启用或禁用
        └ disable_start_timestring禁用开始时间（unix时间，单位sec）
        └ disable_end_timestring禁用结束时间（unix时间，单位sec，数值0表示永久禁用）
        └ disable_reasonstring禁用原因
        └ contact_idsstring\[\]联系人列表，id类型由user_id_type参数决定
        └ disable_noticeboolean是否在禁用时发送通知给预定了该会议室的员工
        └ resume_noticeboolean是否在恢复启用时发送通知给联系人

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "current_config": {
            "scope_type": 1,
            "scope_id": "omm_608d34d82d531b27fa993902d350a307",
            "scope_config": {
                "room_background": "https://lf1-ttcdn-tos.pstatp.com/obj/xxx",
                "display_background": "https://lf1-ttcdn-tos.pstatp.com/obj/xxx",
                "digital_signage": {
                    "if_cover_child_scope": true,
                    "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": {
                    "if_cover_child_scope": true,
                    "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": "v039b2g10000ca89uj3c77u5pfdkfvpg",
                            "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
                }
            }
        },
        "origin_configs": [
            {
                "scope_type": 1,
                "scope_id": "omm_608d34d82d531b27fa993902d350a307",
                "scope_config": {
                    "room_background": "https://lf1-ttcdn-tos.pstatp.com/obj/xxx",
                    "display_background": "https://lf1-ttcdn-tos.pstatp.com/obj/xxx",
                    "digital_signage": {
                        "if_cover_child_scope": true,
                        "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": {
                        "if_cover_child_scope": true,
                        "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": "v039b2g10000ca89uj3c77u5pfdkfvpg",
                                "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状态码错误码描述排查建议
500121001internal error服务器内部错误，如果重试无效可联系管理员
400121002not support暂不支持该功能
400121003param error参数错误，检查参数的取值范围（请按照上面字段说明自查）
404121004data not exist无效的请求体，请确保请求方法、请求信息、请求数据格式等是正确的
404121005no permission无权限进行该操作，建议检查token类型、操作者身份以及资源的归属
404121006data conflict通常由于CAS机制导致，可在更新数据后重试

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

本镜像仅供学习与查阅，文档版权归飞书所有