查询会议室预定限制

查询会议室预定限制。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/vc/v1/reserve_configs/reserve_scope
HTTP Method	GET
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	vc:room 更新视频会议室信息 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_id	string	是	会议室或层级id 示例值：omm_3c5dxxxbd1a771
scope_type	string	是	1 代表层级，2 代表会议室 示例值：2 数据校验规则： - 取值范围：1 ～ 2
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	\-	-
└ approve_config	approval_config	预定审批设置
└ approval_switch	int	预定审批开关：0 代表关闭，1 代表打开。 说明： - 未设置值时不更新原开关的值，但此时必填 approval_condition - 设置值为 1 时，必填 approval_condition - 设置值为 0 时整个 approval_config 其他字段均可省略。
└ approval_condition	int	预定审批条件：0 代表所有预定均需审批，1 代表满足条件的需审批 说明：为 1 时必填 meeting_duration
└ meeting_duration	number(float)	超过 meeting_duration 的预定需要审批（单位：小时，取值范围[0.1-99]） 说明： - 当 approval_condition 为 0 ，更新时如果未设置值，默认更新为 99 . - 传入的值小数点后超过 2 位，自动四舍五入保留两位。
└ approvers	subscribe_user\[\]	审批人列表，当打开审批开关时，至少需要设置一位审批人
└ user_id	string	预定管理员ID
└ time_config	time_config	预定时间设置
└ if_cover_child_scope	boolean	是否覆盖子层级及会议室
└ time_switch	int	预定时间开关：0 代表关闭，1 代表开启
└ days_in_advance	int	最早可提前 days_in_advance 预定会议室（单位：天，取值范围[1-730]） 说明：不填写时，默认更新为 365
└ opening_hour	string	开放当天可于 opening_hour 开始预定（单位：秒，取值范围[0,86400]） 说明： - 不填写时默认更新为 28800 - 如果填写的值不是 60 的倍数，则自动会更新为离其最近的 60 整数倍的值。
└ start_time	string	每日可预定时间范围的开始时间（单位：秒，取值范围[0,86400]） 说明： - 不填写时，默认更新为 0 ，此时填写的 end_time 不得小于 30。 - 当 start_time 与 end_time 均填写时， end_time 至少超过 start_time 30 。 - 如果填写的值不是 60 的倍数，则自动会更新为离其最近的 60 整数倍的值。
└ end_time	string	每日可预定时间范围结束时间（单位：秒，取值范围[0,86400]） 说明： - 不填写时，默认更新为 86400 ，此时填写的 start_time 不得大于等于 86370 。 - 当 start_time 与 end_time 均填写时， end_time 至少要超过 start_time 30。 - 如果填写的值不是 60 的倍数，则自动会更新为离其最近的 60 整数倍的值。
└ max_duration	int	单次会议室可预定时长上限（单位：小时，取值范围[1,99]） 说明：不填写时默认更新为 2
└ reserve_scope_config	reserve_scope_config	预定范围设置
└ if_cover_child_scope	boolean	是否覆盖子层级及会议室
└ allow_all_users	int	可预定成员范围：0 代表部分成员，1 代表全部成员。 说明： - 此值必填。 - 当设置为 0 时，至少需要 1 个预定部门或预定人
└ allow_users	subscribe_user\[\]	可预定成员列表
└ user_id	string	预定管理员ID
└ allow_depts	subscribe_department\[\]	可预定部门列表
└ department_id	string	预定管理部门ID，使用open_department_id

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "approve_config": {
            "approval_switch": 1,
            "approval_condition": 1,
            "meeting_duration": 3,
            "approvers": [
                {
                    "user_id": "ou_a27b0xxxc98f856"
                }
            ]
        },
        "time_config": {
            "if_cover_child_scope": true,
            "time_switch": 1,
            "days_in_advance": 30,
            "opening_hour": "27900",
            "start_time": "0",
            "end_time": "86400",
            "max_duration": 24
        },
        "reserve_scope_config": {
            "if_cover_child_scope": true,
            "allow_all_users": 0,
            "allow_users": [
                {
                    "user_id": "ou_a27bxxx8f856"
                }
            ],
            "allow_depts": [
                {
                    "department_id": "od-47d8b5xxxcc5f61a"
                }
            ]
        }
    }
}

错误码

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	121003	param error	参数错误，检查参数的取值范围（请按照上面字段说明自查）
404	121004	data not exist	请求的数据不存在
403	121005	no permission	无权限进行该操作，建议检查token类型、操作者身份以及资源的归属