白板（Whiteboard）API接口

白板API，主要涉及白板相关的控制，通过API，您可以实现关闭白板/获取白板信息 等功能。

1. 查询白板信息 (Query Whiteboard)

1.1 查询白板所有信息

接口说明

1）接口解释：用于查询白板模块的相关信息

2）引入版本： 3.10.160

3）调用方式（method）：Query

4）调用结果：同步返回调用结果

输入参数（params）

输出参数（data）

白板信息表（whiteboard_info）

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Query",
    "params": {
        "path": ["Whiteboard"]
    }
}

response

{
    "jsonrpc":"2.0",
    "method":"Query",
    "id":"KHH2X4SQ1LBUFD6",
    "result":{
        "error_code":0,
        "message":"成功",
        "data":{
            "whiteboard":{
                "whiteboard_info":
                {
                    "is_local_saved":true,
                    "is_has_content":true,
                    "is_support_save":true,
                    "is_open":true
                }
            }
        }
    }
}

2. 关闭白板 (CloseWhiteboard)

接口说明

1）接口解释：用于关闭白板

2）引入版本： 3.10.160

3）调用方式（method）：Call/Whiteboard

4）调用名（action）：CloseWhiteboard

输入参数（action_params）

无输入参数

输出参数（data）

成功返回空消息，失败返回错误信息，错误码详见 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "9GY8UHWN481XDXU",
    "method": "Call/Whiteboard",
    "params": {
        "action": "CloseWhiteboard"
    }
}

response

{
    "jsonrpc": "2.0",
    "id":"9GY8UHWN481XDXU",
    "method":"Call/Whiteboard",
    "result":{
        "error_code":0,
        "message":"",
        "action":"CloseWhiteboard"
    }
}

3. 打开白板 (OpenWhiteboard)

接口说明

1）接口解释：用于会前、会中场景打开白板

2）引入版本： 3.21.250

3）调用方式（method）：Call/Whiteboard

4）调用名（action）：OpenWhiteboard

输入参数（action_params）

无输入参数

输出参数（data）

成功返回空消息，失败返回错误信息，错误码详见 5 错误码定义

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Whiteboard",
    "params": {
        "action": "OpenWhiteboard"
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Call/Whiteboard",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "action": "OpenWhiteboard",
        "message": ""
    }
}