有奖:语音产品征文挑战赛火热进行中> HOT

接口描述

描述:待开始的会议,会议创建者可以设置统一虚拟背景,并设置生效范围。如果企业未开启虚拟背景开关,则该企业下会议不可进行该设置。支持云会议和 Webinar 会议,其中 Webinar 会议仅对嘉宾生效,且不能指定具体成员。异步上传方式,您可以订阅 异步任务结果 事件获取上传结果。
请求方式:POST
鉴权方式:JWT 鉴权,OAuth2.0 鉴权
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/virtual-background

输入参数

参数名称
必选
参数类型
参数描述
meeting_id
String
会议 ID。
operator_id
String
操作者 ID。
operator_id_type
Integer
操作者 ID 类型。
1:userid
2:open_id
instanceid
Integer
用户的终端设备类型:
0:PSTN
1:PC
2:Mac
3:Android
4:iOS
5:Web
6:iPad
7:Android Pad
8:小程序
9:voip、sip 设备
10:Linux
20:Rooms for Touch Windows
21:Rooms for Touch MacOS
22:Rooms for Touch Android
30:Controller for Touch Windows
32:Controller for Touch Android
33:Controller for Touch iOS
image
String
背景图片 url,尺寸大小为1920*1080,小于10M,jpg/png/jpeg 格式。不传则不变,传空为取消背景。
type
Integer
背景生效类型。
0:全部用户
1:部分用户
users
String[]
userid 数组

输出参数

参数名称
参数类型
参数描述
job_id
String
异步任务 ID

错误码列表

状态码
错误码
错误描述
400
190004
参数非法,请对照接口文档检查您的参数。
400
190457
会议不存在, 请核对 meeting_id。
500
500034
设置虚拟背景失败。
500
500033
没有权限设置虚拟背景。
500
190001
存在未注册的用户。

示例

输入示例

POST
{
"operator_id":"user1",
"operator_id_type":1,
"instanceid":1,
"image":"https://www.abc.com/image/image1.png",
"type":0
}

输出示例

{
"job_id":"11223344"
}