飞书开放平台 Server API 文档

主题

设置会议室配置 ​

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

请求 ​

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

请求头 ​

名称类型必填描述
Authorizationstring是tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Typestring是固定值："application/json; charset=utf-8"

查询参数 ​

名称类型必填描述
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
数据校验规则：
- 长度范围：0 ～ 10 字符
当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体 ​

名称类型必填描述
scope_typeint是查询节点范围
示例值：1
可选值有：
- 1: 会议室层级 - 2: 会议室
scope_idstring是查询节点ID：如果scope_type为1，则为层级ID，如果scope_type为2，则为会议室ID
示例值："omm_608d34d82d531b27fa993902d350a307"
scope_configroom_config否节点配置
  └ room_backgroundstring否飞书会议室背景图
示例值："https://lf1-ttcdn-tos.pstatp.com/obj/xxx"
  └ display_backgroundstring否飞书签到板背景图
示例值："https://lf1-ttcdn-tos.pstatp.com/obj/xxx"
  └ digital_signageroom_digital_signage否飞书会议室数字标牌
    └ if_cover_child_scopeboolean否是否覆盖子层级及会议室
示例值：true
    └ enableboolean否是否开启数字标牌功能
示例值：true
    └ muteboolean否是否静音播放
示例值：true
    └ start_displayint否在会议结束n分钟后开始播放，取值1~720（仅对飞书会议室数字标牌生效）
示例值：3
    └ stop_displayint否在日程会议开始前n分钟停止播放，取值1~720（仅对飞书会议室数字标牌生效）
示例值：3
    └ materialsroom_digital_signage_material\[\]否素材列表
      └ idstring否素材ID，当设置新素材时，无需传递该字段
示例值："7847784676276"
      └ namestring否素材名称
示例值："name"
      └ material_typeint否素材类型
示例值：0
可选值有：
- 1: 图片 - 2: 视频 - 3: GIF
      └ urlstring否素材url
示例值："url"
      └ durationint否播放时长（单位sec），取值1~43200
示例值：15
      └ coverstring否素材封面url
示例值："url"
      └ md5string否素材文件md5
示例值："md5"
      └ vidstring否素材文件vid
示例值："vid"
      └ sizestring否素材文件大小（单位byte）
示例值："100"
  └ room_box_digital_signageroom_digital_signage否飞书投屏盒子数字标牌
    └ if_cover_child_scopeboolean否是否覆盖子层级及会议室
示例值：true
    └ enableboolean否是否开启数字标牌功能
示例值：true
    └ muteboolean否是否静音播放
示例值：true
    └ start_displayint否在会议结束n分钟后开始播放，取值1~720（仅对飞书会议室数字标牌生效）
示例值：3
    └ stop_displayint否在日程会议开始前n分钟停止播放，取值1~720（仅对飞书会议室数字标牌生效）
示例值：3
    └ materialsroom_digital_signage_material\[\]否素材列表
      └ idstring否素材ID，当设置新素材时，无需传递该字段
示例值："7847784676276"
      └ namestring否素材名称
示例值："name"
      └ material_typeint否素材类型
示例值：0
可选值有：
- 1: 图片 - 2: 视频 - 3: GIF
      └ urlstring否素材url
示例值："url"
      └ durationint否播放时长（单位sec），取值1~43200
示例值：15
      └ coverstring否素材封面url
示例值："url"
      └ md5string否素材文件md5
示例值："md5"
      └ vidstring否素材文件vid
示例值："v039b2g10000ca89uj3c77u5pfdkfvpg"
      └ sizestring否素材文件大小（单位byte）
示例值："100"
  └ room_statusroom_status否会议室状态
    └ statusboolean是是否启用会议室
示例值：true
    └ schedule_statusboolean否会议室未来状态为启用或禁用（请忽略，该字段用于查询接口的返回值）
示例值：true
    └ disable_start_timestring否禁用开始时间（unix时间，单位sec）
示例值："1652356050"
    └ disable_end_timestring否禁用结束时间（unix时间，单位sec，数值0表示永久禁用）
示例值："1652442450"
    └ disable_reasonstring否禁用原因
示例值："测试占用"
    └ contact_idsstring\[\]否联系人列表，id类型由user_id_type参数决定
示例值：["ou_3ec3f6a28a0d08c45d895276e8e5e19b"]
    └ disable_noticeboolean否是否在禁用时发送通知给预定了该会议室的员工
示例值：true
    └ resume_noticeboolean否是否在恢复启用时发送通知给联系人
示例值：true

请求体示例 ​

json
{
    "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
        }
    }
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码 ​

HTTP状态码错误码描述排查建议
500121001internal error服务器内部错误，如果重试无效可联系管理员
400121002not support暂不支持该功能
400121003param error参数错误，检查参数的取值范围（请按照上面字段说明自查）
404121004data not exist无效的请求体，请确保请求方法、请求信息、请求数据格式等是正确的
404121005no permission无权限进行该操作，建议检查token类型、操作者身份以及资源的归属
404121006data conflict通常由于CAS机制导致，可在更新数据后重试

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

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