共享（Share）API接口

共享API，主要涉及共享相关的控制，通过API，您可以实现取消会前投屏/会中窗口共享/打开投屏说明/获取共享信息等功能。

1. 查询共享信息 (Query Share)

1.1 查询共享所有信息

接口说明

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

2）引入版本： 3.8.10

3）调用方式（method）：Query

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

输入参数（params）

参数名称	是否必选	参数类型	参数描述
path	是	array	模块名

输出参数（data）

参数名称	参数类型	参数描述
share_info	object	共享信息，详见共享信息表
cast_code	string	投屏码
capture_device_list	array	可共享的采集设备列表

共享信息表（share_info）

参数名称	参数类型	参数描述
is_sharing	bool	是否正在共享： true：是 false：否
quick_casting_state	int	会前投屏状态： 0：未开始 1：准备中 2：共享中
share_user_info	object	共享用户信息表，只在有人共享时返回

共享用户信息表（share_user_info）

参数名称	参数类型	参数描述
app_uid	string	账号id
app_id	string	企业id
user_id	string	会中用户id
host	bool	是否主持人： true：是 false：否
co_host	bool	是否联席主持人： true：是 false：否
instance_id	int	应用类型id
user_type	int	用户类型： 1：普通用户 2：PSTN用户
is_creator	bool	是否会议创建者： true：是 false：否
role_type	int	角色类型：0：未知 1：主持人 2：联席主持人 3：普通用户 4：内部嘉宾 5：外部嘉宾 6：外部嘉宾 7：外部嘉宾 8：同声传译用户
video_on	bool	是否开启视频： true：开启 false：关闭
audio_on	bool	是否开启音频： true：开启 false：关闭
screen_sharing	bool	是否开启屏幕共享： true：开启 false：关闭
screen_share_type	int	屏幕共享类型： 0：屏幕共享 1：白板共享
web_sharing	bool	是否文档共享： true：是 false：否
nickname	string	用户名称

请求示例

request

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

response

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "message": "",
        "data": {
            "share": {
                "share_info": {
                    "is_sharing": true,
                    "quick_casting_state": 0,
                    "share_user_info": {
                        "app_uid": "",
                        "app_id": "",
                        "user_id": "",
                        "host": true,
                        "co_host": true,
                        "instance_id": 0,
                        "user_type": 0,
                        "is_creator": true,
                        "role_type": 0,
                        "video_on": true,
                        "audio_on": true,
                        "screen_sharing": true,
                        "screen_share_type": 0,
                        "web_sharing": true,
                        "nickname": ""
                    }
                },
                "cast_code": "",
                "capture_device_list": ["xxx"]
            }
        }
    }
}

1.2 查询共享部分信息

接口说明

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

2）引入版本： 3.8.10

3）调用方式（method）：Query

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

输入参数（path）

详见1.1 查询共享所有信息

输出参数（data）

详见1.1 查询共享所有信息

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Query",
    "params": {
        "path": ["Share", "CastCode"] // 查询Share模块下的投屏码
    }
}

response

{
    "jsonrpc": "2.0",
    "method": "Query",
    "id": "xxx",
    "result": {
        "error_code": 0,
        "message": "成功",
        "data": {
            "cast_code": "xxx"
        }
    }
}

2. 结束会前投屏 (EndQuickShare)

接口说明

1）接口解释：用于结束会前投屏，（推荐使用 9. 停止共享 (StopShare) 接口）

2）引入版本： 3.10.160

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

4）调用名（action）：EndQuickShare

5）前置依赖：
a. Rooms需要在会中
b. Rooms用户当前正在共享中

输入参数（action_params）

参数名称	是否必选	参数类型	参数描述
meeting_type	否	string	固定字段

输出参数（data）

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

请求示例

request

{
    "jsonrpc":"2.0",
    "id":"xxx",
    "method":"Call/Share",
    "params":{
        "action":"EndQuickShare",
        "meeting_type":"castMeeting"
    }
}

response

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

3. 取消会前投屏 (CancelQuickShare)

接口说明

1）接口解释：用于取消会前投屏，（推荐使用 9. 停止共享 (StopShare) 接口）

2）引入版本： 3.10.160

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

4）调用名（action）：CancelQuickShare

5）前置依赖：
a. Rooms需要在会中
b. Rooms用户当前正在共享中

输入参数（action_params）

参数名称	是否必选	参数类型	参数描述
meeting_type	否	string	固定字段

输出参数（data）

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

请求示例

request

{
    "jsonrpc":"2.0",
    "id":"xxx",
    "method":"Call/Share",
    "params":{
        "action":"CancelQuickShare",
        "meeting_type":"castMeeting"
    }
}

response

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

4. 开启窗口共享 (StartWindowShare)

接口说明

1）接口解释：用于开启窗口共享，（推荐使用 8. 启动共享 (StartShare) 接口）

2）引入版本： 3.11.170

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

4）调用名（action）：StartWindowShare

5）前置依赖：
a. Rooms需要在会中

输入参数（action_params）

参数名称	是否必选	参数类型	参数描述
share_voice	是	bool	是否同时共享桌面声音： true：是 false：否
fluency_first	是	bool	是否视频流畅度优先： true：是 false：否
select_index	否	int	窗口索引，可选，默认0是共享桌面

输出参数（data）

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

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "StartWindowShare",
        "action_params": {
            "share_voice": true,
            "fluency_first": true, 
            "select_index": 0 
        }
    }
}

response

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

5. 结束窗口共享 (StopWindowShare)

接口说明

1）接口解释：用于结束窗口共享，（推荐使用 9. 停止共享 (StopShare) 接口）

2）引入版本： 3.11.170

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

4）调用名（action）：StopWindowShare

5）前置依赖：
a. Rooms需要在会中
b. Rooms当前正在共享中

输入参数（action_params）

无输入参数

输出参数（data）

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

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "StopWindowShare"
    }
}

response

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

6. 打开投屏说明 (OpenShareGuide)

接口说明

1）接口解释：用于打开投屏说明

2）引入版本： 3.13.190

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

4）调用名（action）：OpenShareGuide

输入参数（action_params）

无输入参数

输出参数（data）

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

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "OpenShareGuide"
    }
}

response

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

7. 关闭投屏说明 (CloseShareGuide)

接口说明

1）接口解释：用于关闭投屏说明

2）引入版本： 3.13.190

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

4）调用名（action）：CloseShareGuide

输入参数（action_params）

无输入参数

输出参数（data）

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

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "CloseShareGuide"
    }
}

response

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

8. 启动共享 (StartShare)

接口说明

1）接口解释：用于启动共享

2）引入版本： 3.13.190

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

4）调用名（action）：StartShare

5）前置依赖：
a. Rooms需要在会中

输入参数（action_params）

参数名称	是否必选	参数类型	参数描述
share_type	是	int	共享类型： 0：共享本地窗口 1：共享采集设备
share_voice	否	bool	是否同时共享声音，share_type = 0和1 时有效： true：是 false：否
fluency_first	是	bool	是否视频流畅度优先： true：是 false：否
select_index	否	int	窗口索引，可选，默认0是共享桌面
device_id	否	string	采集设备ID，可选，默认使用第一个采集设备，share_type = 1 时有效

输出参数（data）

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

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "StartShare",
        "action_params":{
            "share_type": 0, 
            "share_voice": true, 
            "fluency_first": true, 
            "select_index": 0,
            "device_id": "" 
        }
    }
}

response

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

9. 停止共享 (StopShare)

接口说明

1）接口解释：用于停止共享

2）引入版本： 3.13.190

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

4）调用名（action）：StopShare

5）前置依赖：
a. Rooms需要在会中

输入参数（action_params）

无输入参数

输出参数（data）

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

请求示例

request

{
    "jsonrpc": "2.0",
    "id": "xxx",
    "method": "Call/Share",
    "params": {
        "action": "StopShare"
    }
}

response

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

下载共享（Share）.pdf

文章内容是否对您有帮助？

有帮助

无帮助

能否告知我们这篇文章的问题？（选填）

操作步骤描述不清晰/看不懂这个功能不好用找不到描述的入口没找到我想要了解的信息

0 / 150