更新禁用状态变更通知
更新禁用状态变更通知
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/vc/v1/reserve_configs/:reserve_config_id/disable_inform |
| HTTP Method | PATCH |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | vc:room 更新视频会议室信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
reserve_config_id | string | 会议室或层级ID,可通过会议室或层级相关查询接口获取 示例值:"omm_3c5dd7e09bac0c1758fcf9511bd1a771" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
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 |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
scope_type | int | 是 | 1表示会议室层级,2表示会议室 示例值:2 数据校验规则: - 取值范围: 1 ~ 2 |
disable_inform | disable_inform_config | 是 | 禁用通知配置 |
└ if_cover_child_scope | boolean | 否 | 是否覆盖子层级及会议室 示例值:true |
└ if_inform | boolean | 是 | 禁用状态变更通知开关 示例值:false 默认值: false |
└ informed_users | subscribe_user\[\] | 否 | 通知成员列表 |
└ user_id | string | 是 | 预定管理员ID 示例值:"ou_a27b07a9071d90577c0177bcec98f856" |
└ informed_depts | subscribe_department\[\] | 否 | 通知部门列表 |
└ department_id | string | 是 | 预定管理部门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"
}
]
}
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 121001 | internal error | 服务器内部错误,如果重试无效可联系管理员 |
| 400 | 121002 | not support | 暂不支持该功能 |
| 400 | 126001 | invalid room or level id, check itself or whether the scope_type corresponds to it | 不存在该会议室或层级ID,或者检查scope_type是否对应 |
| 400 | 126012 | updated sum of userIDs and deptIDs exceed 500 | 用户部门ID总数目超过了500 |
| 400 | 126013 | some userIDs you put is invalid | 存在无效的用户ID |
| 400 | 126014 | some deptIDs you put is invalid | 存在无效的部门ID |
| 400 | 121003 | param error | 参数错误,检查参数的取值范围(请按照上面字段说明自查) |
| 404 | 121004 | data not exist | 无效的请求体,请确保请求方法、请求信息、请求数据格式等是正确的 |
| 403 | 121005 | no permission | 无权限进行该操作,建议检查token类型、操作者身份以及资源的归属 |
