获取电子白板授权Code
POST /server/v1/white-board/grant-code
鉴权:需要(见概览)
获取电子白板的授权码。白板是独立于频道的协作画板,多个用户用同一个 board
就进入同一块白板。
典型时序与频道 token 类似:业务后端确认权限 → 调本接口拿 auth_code 和 addr →
下发给客户端 → 客户端把二者拼成 {addr}?code={auth_code} 打开(白板是一个 H5 页面,
用 iframe 或 WebView 内嵌)。授权码 1 小时内有效且连接后即失效,每次打开白板都重新
获取,不要缓存。
白板首次被授权时自动创建,无需预先创建。
频道内的用户还有更省事的一条路:加入频道的响应里已经带了拼好的白板地址(字段
white_board,授权码就是该用户的 sid),直接内嵌即可,不必再调本接口。本接口是给
「不在频道里的人也要用白板」以及「白板独立于频道使用」的场景准备的。完整对接说明
见《电子白板》。
请求参数
string
必填
板子ID,字符集限制同频道名。常见做法是直接用频道名,这样会议与白板一一对应(长度 64 字节以内,仅支持大小写字母、数字、下划线 _ 与连字符 -)
示例:
firestring
必填
第三方用户ID,用于显示协作者光标与操作者(仅支持大小写字母、数字、下划线 _ 与连字符 -)(最大长度 100)
示例:
1001string
第三方用户名称
示例:
张三string
网络线路,取值是中文线路名;留空则由服务端选择
示例:
内网string
服务分组
string
白板授权码,下发给客户端用于打开白板
示例:
wb-co63jg6g54hu3b0xhtiestring
白板页面地址,与授权码拼成 {addr}?code={auth_code} 使用
示例:
https://api.example.com/white-board/检测白板是否存在
POST /server/v1/white-board/exist
鉴权:需要(见概览)
检测白板是否存在,即是否已被创建且未销毁。
用于判断”这块板子上还有没有内容”—— 比如决定要不要展示”进入白板”入口,
或确认销毁是否已经生效。
请求参数
string
必填
板子ID(长度 64 字节以内,仅支持大小写字母、数字、下划线 _ 与连字符 -)
示例:
fireboolean
白板是否存在(已创建且未销毁)
销毁电子白板
POST /server/v1/white-board/destroy
鉴权:需要(见概览)
销毁白板。板上内容会被清除,不可恢复,正在白板中的用户会被断开。
白板另有两条自动销毁的路径,本接口用于在此之前主动清理(比如会中”关闭白板”):
- 频道销毁时,会连带销毁同名的白板。频道无人 2 小时后自动销毁,所以按推荐做法 (board 取频道名)用的白板,也会在会议散场 2 小时后一起消失。要让白板内容长期 留存,board 就不能取频道名。
- 白板超过 25 小时无人写入,由定时任务清理。
string
必填
板子ID(长度 64 字节以内,仅支持大小写字母、数字、下划线 _ 与连字符 -)
示例:
firestring
操作者ID,用于审计
示例:
1001string
操作者名称
示例:
张三data 为 null
响应示例: