Skip to content

更新禁用状态变更通知

更新禁用状态变更通知

请求

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

请求头

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

路径参数

名称类型描述
reserve_config_idstring会议室或层级ID,可通过会议室或层级相关查询接口获取
示例值:"omm_3c5dd7e09bac0c1758fcf9511bd1a771"

查询参数

名称类型必填描述
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

请求体

名称类型必填描述
scope_typeint1表示会议室层级,2表示会议室
示例值:2
数据校验规则
- 取值范围:12
disable_informdisable_inform_config禁用通知配置
  └ if_cover_child_scopeboolean是否覆盖子层级及会议室
示例值:true
  └ if_informboolean禁用状态变更通知开关
示例值:false
默认值false
  └ informed_userssubscribe_user\[\]通知成员列表
    └ user_idstring预定管理员ID
示例值:"ou_a27b07a9071d90577c0177bcec98f856"
  └ informed_deptssubscribe_department\[\]通知部门列表
    └ department_idstring预定管理部门ID,使用open_department_id
示例值:"od-47d8b570b0a011e9679a755efcc5f61a"

请求体示例

json
{
    "scope_type": 2,
    "disable_inform": {
        "if_cover_child_scope": true,
        "if_inform": false,
        "informed_users": [
            {
                "user_id": "ou_a27b07a9071d90577c0177bcec98f856"
            }
        ],
        "informed_depts": [
            {
                "department_id": "od-47d8b570b0a011e9679a755efcc5f61a"
            }
        ]
    }
}

响应

响应体

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

响应体示例

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

错误码

HTTP状态码错误码描述排查建议
500121001internal error服务器内部错误,如果重试无效可联系管理员
400121002not support暂不支持该功能
400126001invalid room or level id, check itself or whether the scope_type corresponds to it不存在该会议室或层级ID,或者检查scope_type是否对应
400126012updated sum of userIDs and deptIDs exceed 500用户部门ID总数目超过了500
400126013some userIDs you put is invalid存在无效的用户ID
400126014some deptIDs you put is invalid存在无效的部门ID
400121003param error参数错误,检查参数的取值范围(请按照上面字段说明自查)
404121004data not exist无效的请求体,请确保请求方法、请求信息、请求数据格式等是正确的
403121005no permission无权限进行该操作,建议检查token类型、操作者身份以及资源的归属

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