会中权限设置

功能说明

使用本接口可以在会议过程中配置所有参会人员是否有发起录制、白板、共享、标注、聊天的权限，用于精确控制会议进程，防止重要会议因误操作而受影响，并支持终端遥控摄像头、会中改名权限的配置。如给指定终端配置某权限可以使用，但该终端不具备此功能入口，接口会返回调用成功（接口只负责会议中的权限配置，无论该终端是否具备此入口）。

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

实现方法

REST URL

POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/permission?enterpriseId=XXX&meetingRoomNumber=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	必须	默认值	说明	初始平台
version	String	Path	是	无	预留参数，填v1即可	3.9不支持该接口 6.0不支持该接口公有云不支持该接口
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	5.2 (2024-1220版本）
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参见签名规则	5.2 (2024-1220版本）
meetingRoomNumber	String	Query	是	无	会议室号	5.2 (2024-1220版本）
List	List	Body	是	无	权限列表注意：权限列表中的所有权限必须传递、不允许重复传递同一权限	5.2 (2024-1220版本）
└permissionKey	String	Body	是	无	权限名	5.2 (2024-1220版本）
└permissionValue	String	Body	是	无	权限值	5.2 (2024-1220版本）
└devices	List	Body	否	无	设备列表	5.2 (2024-1220版本）
└└id	Long	Body	是	无	设备id,可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	5.2 (2024-1220版本）
└└type	Integer	Body	是	无	设备类型,可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询	5.2 (2024-1220版本）
└└participantNumber	String	Body	是	无	参会者设备号，设备类型为H.323/SIP终端时必须传。可以从“主持会议 - 查看全体成员的会议状态”API查询： participantNumber表示参会者设备号	5.2 (2024-1220版本）

可控权限列表

权限名（permissionKey）	权限值（permissionValue）	备注
recording	ALLOW_ALL：所有终端均可录制 FORBID_ALL：所有终端禁止录制 SPECIFIED：指定终端可录制	录制权限
whiteboard	ALLOW_ALL：所有终端均可使用白板 FORBID_ALL：所有终端禁止使用白板 SPECIFIED：指定终端可使用白板	白板权限
content	ALLOW_ALL：所有终端均可共享 FORBID_ALL：所有终端禁止共享 SPECIFIED：指定终端可共享	共享权限
annotation	ALLOW_ALL：所有终端均可标注 FORBID_ALL：所有终端禁止标注 SPECIFIED：指定终端可标注 ONLY_SHARING_USER：仅共享终端允许标注（仅会中非多路共享会议室此权限可配置）	标注权限
imPermission	ALLOW_ALL：所有终端均可聊天 FORBID_ALL：所有终端禁止聊天 SPECIFIED：指定终端可聊天	聊天权限
privateChat	ALLOW_ALL：允许等候室成员私聊主持人（仅聊天权限为“所有终端均可聊天”时可配置此值） FORBID_ALL：禁止私聊主持人	私聊主持人权限
fecc	ALLOW_ALL：允许 FORBID_ALL：不允许	终端遥控远端摄像头
rename	ALLOW_ALL：允许 FORBID_ALL：不允许	终端会议中自己改名

示例代码

请求消息体示例（Json）

[
  {
    "permissionKey": "content",
    "permissionValue": "SPECIFIED",
    "devices": [
      {
        "id": 111,
        "type": 222,
        "participantNumber": "333"
     }
    ]
  },
  {
    "permissionKey": "recording",
    "permissionValue": "FORBID_ALL"
  },
  {
    "permissionKey": "whiteboard",
    "permissionValue": "FORBID_ALL"
  },
  {
    "permissionKey": "fecc",
    "permissionValue": "FORBID_ALL"
  },
  {
    "permissionKey": "rename",
    "permissionValue": "FORBID_ALL"
  },
  {
    "permissionKey": "annotation",
    "permissionValue": "ONLY_SHARING_USER"
  },
  {
    "permissionKey": "imPermission",
    "permissionValue": "FORBID_ALL"
  },
  {
    "permissionKey": "privateChat",
    "permissionValue": "FORBID_ALL"
  }
]

返回结果示例：

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

2024-12-06 15:15:24

导出PDF文档