跳到主要内容

预定画布会议

更新时间 2025/02/22 07:19:43

英飞画布服务端支持基于 REST API 向指定画布中预定一场画布会议，并反馈画布会议的 ID。

英飞业务下，画布会议 ID 统一会使用 meetingId 进行标记。

前提条件​

请求路径​

https://developer.infi.cn/infi/api/v1/boards/meetings

请求参数​

字段
类型
描述
必填
recordId
string
画布 ID
是
meeting
Object
对象数据结构，详情见下方会议信息结构说明
是

会议信息结构说明​

字段
类型
描述
必填
title
string
会议名称
是
host
string
会议主持人 loginName
是
coHosts
Array<string>
会议联席主持人 loginName
否
planJoiners
Array<string>
会议计划参会成员 loginName
是
planStart
integer
会议开始时间戳
是
planEnd
integer
会议结束时间戳, 会议最大持续时间为 24 小时
是
defaultForceFollow
boolean
入会后是否强制跟随主讲人
是
defaultPerm
0 / 1 / 2 / 3
用户入会后的默认操作权限，详见下方说明
是
lockState
0 / 1
会议是否锁定，详见下方说明
是

说明：

  • defaultPerm 数值含义
    • 0: 成员入会后，保持入会前的画布操作权限不变
    • 1: 成员入会后，开放画布编辑权限
    • 2: 成员入会后，仅持有画布评论权限
    • 3: 成员入会后，仅持有画布只读权限
  • lockState：为 0 时表会议未锁定；为 1 时表会议锁定。锁定状态下，非 planJoiners 用户无法加入会议。

请求参数示例​

{
  "recordId": "SAMPLE_RECORD_ID",
  "meeting": {
    "title": "SAMPLE_MEETING_TITLE",
    "host": "HOST_LOGIN_NAME",
    "planStart": 1717041600000,
    "planEnd": 1717066800000,
    "coHosts": ["CO_HOST_LOGIN_NAME"],
    "planJoiners": ["SAMPLE_MEMBER_LOGIN_NAME"],
    "defaultPerm": 1,
    "defaultForceFollow": 1,
    "lockState": 1
  }
}

请求 curl 示例​

curl --location --request POST \
      --header 'token: YOUR_ACCESS_TOKEN' \
      --header 'Content-Type: application/json' \
      --data '{ PAYLOADS_HERE }' \
      https://developer.infi.cn/infi/api/v1/boards/meetings

注意：请确保将 PAYLOADS_HERE 替换为请求参数中列举的数据。

请求成功情况​

响应的 Http 状态码为 200 时表示请求成功，并会带有新预订的会议 ID。 请求成功返回数据示例如下:

{
  "meetingId": "SAMPLE_MEETING_ID"
}

请求失败情况​

响应的 Http 状态码不为 200 时表示请求失败，如需更多信息请参考请求错误说明文档。