有奖捉虫:行业应用 & 管理与支持文档专题 HOT

接口描述

描述:修改指定的网络研讨会信息,只有网络研讨会的创建者才有权限修改。
注意:
商业版账号:购买账号数不足10个,无法使用该接口。
企业版、教育版账号:购买虚拟会议室数不足10个,无法使用该接口。
请求方式:PUT
接口请求域名
https://api.meeting.qq.com/v1/webinars/{meeting_id}

输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明
参数名称
必选
参数类型
参数描述
meeting_id
String
网络研讨会唯一标识。
userid
String
调用方用于标示用户的唯一 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。
企业唯一用户标识说明:
1:企业对接 SSO 时使用的员工唯一标识 ID。
2:企业调用创建用户接口时传递的 userid 参数。
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
subject
String
网络研讨会主题(1~255位字符长度)。
sponsor
String
主办方名称(1~40位字符长度)。
start_time
String
会议开始时间戳(单位秒),需大于当前时间,与结束时间需同时传入或同时不传。
end_time
String
会议结束时间戳(单位秒),需大于开始时间。
admission_type
Integer
观众观看限制类型:
0:公开
1:报名
2:密码
hosts
User 对象数组
会议指定主持人的用户 ID,如果无指定,主持人将被设定为参数 userid 的用户,即 API 调用者。
注意:仅授权用户账号为腾讯会议商业版、企业版、教育版可指定主持人。 修改时传入,则会覆盖原有设置。
password
String
观众观看密码(4~6位数字),当 admission_type = 2 时必传,且仅当 admission_type = 2 时才生效。
cover_url
String
封面图片 URL,图片仅支持 PNG 和 JPEG 格式,分辨率需大于640360,推荐使用1280720的高清图片,文件需控制在 5 MB 以内。
该参数需要开启活动页配置(activity_page)。
接口上传封面方式为异步上传,您可以通过订阅 素材上传结果 获得上传结果通知。
description
String
网络研讨会描述详情,仅支持纯文本,1~5000位字符长度。
该参数需要开启活动页配置(activity_page)。
enable_guest_invite_link
Boolean
是否开启通过邀请链接自动成为嘉宾:
true:开启
false:不开启,默认 false
media_setting
MediaSetting 对象
媒体参数配置。
enable_qa
Boolean
是否开启问答:
true:开启
false:不开启,默认 true
sensitive_words
String 数组
聊天敏感词,包含敏感词的观众公共聊天将不会出现在您的会议中,最多可添加50个敏感词,单个敏感词限制10个中文字符长度。
enable_manual_check
Boolean
是否开启人工审核:
true:开启
false:不开启,默认 false
activity_page
Boolean
活动页开启配置:
true:开启活动页,默认开启
false:不开启活动页
查询时返回默认值 true。
display_number_of_participants
Integer
活动页展示已报名或已预约人数:
0:不展示
1:展示,默认开启。
该参数需要开启活动页配置(activity_page)。
playback_for_audience
Boolean
允许观众观看回放。
true:允许
false:不允许,默认值为 false
开启本选项时必须开启云录制,即 auto_record_type 的值必须为 cloud。
preparation_mode
Boolean
是否开启准备模式:
true:开启
false:关闭

User 对象

参数名称
必选
参数类型
参数描述
userid
String
用户 ID。
企业唯一用户标识说明: 企业对接 SSO 时使用的员工唯一标识 ID,企业调用创建用户接口时传递的 userid 参数。
open_id
String
OAuth2.0 授权用户 ID。仅支持与会议创建者(即授权的用户)同企业,个人用户无法指定主持人。OAuth 鉴权仅使用 open_id。

MediaSetting 对象

参数名称
必选
参数类型
参数描述
mute_enable_join
Boolean
嘉宾入会时静音。默认值为 true。
true:开启
false:不开启
allow_unmute_self
Boolean
允许嘉宾取消静音。默认值为 true。
true:开启
false:不开启
allow_in_before_host
Boolean
是否允许嘉宾在主持人进会前加入会议,默认值为 true。
true:允许
false:不允许
allow_screen_shared_watermark
Boolean
是否开启屏幕共享水印,默认值为 false。
true:开启
false:不开启
water_mark_type
Integer
水印样式,默认为单排。当屏幕共享水印参数为开启时,此参数才生效。
0:单排
1:多排
only_enterprise_user_allowed
Boolean
是否仅企业内部成员可入会,默认值为 false。
true:仅企业内部用户可入会
false:所有人可入会
auto_record_type
String
自动会议录制类型:
none:禁用,表示不开启自动会议录制。
local:本地录制,表示主持人入会后自动开启本地录制。
cloud:云录制,表示主持人入会后自动开启云录制。
说明:
该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。
仅客户端2.7.0及以上版本可生效。
participant_join_auto_record
Boolean
当有参会成员入会时立即开启云录制,默认值为 false 关闭:
关闭时:主持人入会自动开启云录制。
开启时:参会成员入会自动开启云录制。
说明:
该参数必须 auto_record_type 设置为 cloud 时才生效,该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。
仅客户端2.7.0及以上版本生效。
enable_host_pause_auto_record
Boolean
允许主持人暂停或者停止云录制,默认值为 true 开启:
开启时:主持人允许暂停和停止云录制。
关闭时:主持人不允许暂停和关闭云录制。
说明:
该参数必须 auto_record_type 设置为“cloud”时才生效,该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。
仅客户端2.7.0及以上版本生效。

输出参数

参数名称
参数类型
参数描述
meeting_id
String
网络研讨会唯一标识。
meeting_code
String
会议 App 的呼入号码。

错误码列表

状态码
错误码
错误描述
400
190004
参数非法,请对照接口文档检查您的参数。
400
190001
存在未注册的用户。
500
21401
主办方名称或描述详情中包含敏感词。
500
9042
无权限进行该操作,建议检查操作者身份或资源归属。
500
14151
会议已开始,不能修改会议信息。
500
9003
MEETING NOT EXIST。
500
10001
参数异常。
500
202001
请对照接口文档检查您的参数。

示例

输入示例

POST
https://api.meeting.qq.com/v1/webinars/7976035087704477330
{
"start_time":"1631589648",
"end_time":"1631589649",
"media_setting":{
"mute_enable_join":true,
"allow_unmute_self":true,
"allow_in_before_host":true,
"allow_screen_shared_watermark":true,
"water_mark_type":1,
"only_enterprise_user_allowed":false,
"auto_record_type":"cloud",
"participant_join_auto_record":true,
"enable_host_pause_auto_record":true
},
"instanceid":1,
"admission_type":2,
"password":"1234",
"sponsor":"564ggg",
"description":"111",
"userid":"aaa",
"subject":"webinar 2",
"enable_guest_invite_link":true,
"enable_manual_check":true
}

输出示例

{
"meeting_id":"7976035087704477330",
"meeting_code":"887228671"
}