获取电子白板授权Code
POST /server/v1/white-board/grant-code
鉴权:需要(见概览)
获取电子白板的授权码。白板是独立于频道的协作画板,多个用户用同一个 board
就进入同一块白板。
典型时序与频道 token 类似:业务后端确认权限 → 调本接口拿 auth_code 和 addr →
下发给客户端 → 客户端打开白板。授权码有有效期,每次打开白板都重新获取,不要缓存。
白板首次被授权时自动创建,无需预先创建。
请求参数
string
必填
板子ID,字符集限制同频道名。常见做法是直接用频道名,这样会议与白板一一对应(长度 64 字节以内,仅支持大小写字母、数字、下划线 _ 与连字符 -)
示例:
firestring
必填
第三方用户ID,用于显示协作者光标与操作者(仅支持大小写字母、数字、下划线 _ 与连字符 -)(最大长度 100)
示例:
1001string
第三方用户名称
示例:
张三string
网络线路,取值是中文线路名;留空则由服务端选择
示例:
内网string
服务分组
string
白板授权码,下发给客户端用于打开白板
示例:
wb_co63jg6g54hu3b0xhtiestring
白板服务地址,与授权码配合使用
检测白板是否存在
POST /server/v1/white-board/exist
鉴权:需要(见概览)
检测白板是否存在,即是否已被创建且未销毁。
用于判断”这个会议有没有留下白板内容”—— 比如会议结束后决定要不要展示
“查看白板记录”入口。
请求参数
string
必填
板子ID(长度 64 字节以内,仅支持大小写字母、数字、下划线 _ 与连字符 -)
示例:
fireboolean
白板是否存在(已创建且未销毁)
销毁电子白板
POST /server/v1/white-board/destroy
鉴权:需要(见概览)
销毁白板。板上内容会被清除,不可恢复,正在白板中的用户会被断开。
白板不会随频道销毁而自动清除 —— 这是有意的,会议结束后白板内容仍可查看。
所以需要清理时要显式调用本接口。
请求参数
string
必填
板子ID(长度 64 字节以内,仅支持大小写字母、数字、下划线 _ 与连字符 -)
示例:
firestring
操作者ID,用于审计
示例:
1001string
操作者名称
示例:
张三data 为 null
响应示例: