屏幕分享授权

功能说明

第三方开发者可以集成该API实现对会中参数成员的屏幕共享权限的设置或禁用。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

PUT https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/{callNumber}/content/authShare?enterpriseId=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	v1
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得
signature	String	Query	是	签名鉴权1.0（旧）：是签名鉴权2.0：否	API签名，参见签名规则
callNumber	String	Path	是	无	当前会议的云会议号	3.9
isAll	boolean	Body	否	false	是否为全部，取值true／false	3.9
device	Json	Body	否	无	被分享的设备列表	3.9
└ id	long	Body	是	无	设备id,可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	3.9
└ type	int	Body	是	无	设备类型,可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	3.9
└participantNumber	String	Body	是	无	参会者设备号，设备类型为H.323/SIP终端时必须传。可以从“主持会议 - 查看全体成员的会议状态”API查询： participantNumber表示参会者设备号	3.9
devices	List<Json>	Body	否	无	被分享的设备列表（支持批量）	3.9
└ id	long	Body	是	无	设备id,可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	3.9
└ type	int	Body	是	无	设备类型,可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	3.9
└participantNumber	String	Body	是	无	参会者设备号，设备类型为H.323/SIP终端时必须传。可以从“主持会议 - 查看全体成员的会议状态”API查询： participantNumber表示参会者设备号	3.9

注：

1.请求参数中的isAll=true时视为全局允许，即会中所有成员允许共享权限

2.请求参数中的isAll=false且device参数为空时视为全局禁止，即会中所有成员禁止共享权限

3.请求参数中的isAll=false且device参数非空时视为部分允许，即device参数中指定的设备允许共享权限

4.若操作单一设备推荐使用请求示例1用法，若操作多台设备推荐使用请求示例2用法

示例代码

请求消息体示例1（Json）

{
    "isAll": false,
    "device": {
        "id": "xxxxxx",
        "type": 1,
        "participantNumber": "xxxxxx"
    }
}

请求消息体示例2（Json）

{
    "isAll": false,
    "devices": [
        {
            "id": "xxxxxx",
            "type": 1,
            "participantNumber": "xxxxxx"
        }
    ]
}

返回结果示例：

成功时返回200，失败时返回小鱼RESTAPI错误码

2024-04-08 10:55:50

导出PDF文档