REST API 控制

更新时间 2024/11/18 12:57:03

通过REST API控制画布会议，您可以在无需手动操作画布或打开应用的情况下，便捷地进行会议管理。这种方式使得会议创建和调度能够轻松嵌入到现有的业务流程中，尤其适用于自动化系统或需要提前规划的场景。

利用REST API集成的优势包括但不限于：

• 自动化操作: 提前自动化设置会议，无需等待用户手动创建。
• 外部系统对接: 与企业内部其他系统（如日历、任务管理工具）无缝集成，增强工作流的连贯性。
• 后台管理: 管理员可以在后台直接处理所有会议相关的配置，而不影响用户当前的工作状态。 以下是使用REST API进行画布会议管理的主要步骤：

创建会议

开发者可以通过REST API创建画布会议，通过传递必要的参数来定制会议的详细信息，包括但不限于：

• 会议标题：用于概述会议的目的或主要讨论点，帮助参与者快速了解会议内容。
• 会议主持人：主持人拥有最高画布会议权限，包括控制参与者权限、结束会议等控制，且会默认成为为画布会议的主持人。
• 参会人员名单：此次会议的参与人员。他们将在画布内收到会议通知，并获得加入会议的权限。
• 预定的开始和结束时间：预计会议的开始时间。参与者可以早于会议开始时间提前加入会议做准备，如上传材料、测试设备等。
• 联席主持人选项：可选项，指定一个或多个联席主持人，他们将辅助会议主持人管理会议进程，权限同会议主持人。
• 是否启用自动视野跟随：可选项，设置是否强制参会者在其画布视图上跟随主讲人。启用后，所有用户将无法自行解除跟随主讲人视野的状态。
• 默认的画布权限设置：可选项，定义参与者加入会议时所拥有的画布操作权限，如果不特别指定，则用户进入会议后会保留进入前在画布内的权限状态。

成功创建会议后，API将返回一个唯一的会议ID，该ID用于之后更新或删除会议的操作。接口详情及参数说明请参考创建会议 REST API 说明文档。

修改会议

通过REST API还可对已创建的会议进行修改，允许更新大部分会议属性。然而，基于以下条件，系统将限制对正在进行或即将开始的会议的修改：

• 会议已经开始
• 已有用户提前加入会议
• 会议已处于无效状态（比如被删除或已结束）

请在进行任何会议更新操作前确定满足上述条件，以避免引起用户混淆或数据错误。 接口详情及参数说明请参考更新会议 REST API 说明文档。

删除会议

如果需要取消预定会议，开发者可通过提供的会议ID执行删除操作。类似于更新操作，删除也受到会议状态限制，确保不会意外移除正在活跃的会议。 接口详情及参数说明请参考删除会议 REST API 说明文档。