企业内部开发
基础
连接微信
办公
会议
会议统计管理
企业内部开发
服务端API
会议
网络研讨会 (Webinar) 管理
创建网络研讨会
创建网络研讨会
最后更新:2023/04/26

网络研讨会适用于沙龙、圆桌会议、行业峰会等场景,支持最高5w人同时参会,会中可展开丰富的互动及管理。此接口用于预定一场网络研讨会。

请求方式: POST(HTTPS
请求地址: https://qyapi.weixin.qq.com/cgi-bin/meeting/webinar/create?access_token=ACCESS_TOKEN

请求包体:

{
	"admin_userid": "USERID",
	"title": "TITLE",
	"sponsor": "SPONSOR",
	"start_time": "166666666",
	"end_time": "177777777",
	"admission_type": 0,
	"hosts": [
		{
			"userid": "USERID"
		}
	],
	"password": "PASSWORD",
	"cover_url": "URL",
	"description": "description",
	"enable_guest_invite_link": false,
	"media_setting": {
		"enable_enter_mute": false,
		"allow_unmute_self": false,
		"allow_enter_before_host": false,
		"enable_screen_watermark": false,
		"watermark_type": 0,
		"allow_external_user": false,
		"auto_record_type": "none",
		"attendee_join_auto_record": false,
		"enable_host_pause_auto_record": false
	},
	"enable_qa": false,
	"sensitive_words": [
		"WORD1"
	],
	"enable_manual_check": false,
	"activity_page": false,
	"display_number_of_attendees": 0,
	"playback_for_audience": true,
	"preparation_mode": false
}

参数说明:

参数必须类型说明
access_tokenstring调用接口凭证。获取方法查看“获取access_token
admin_useridstring网络研讨会管理员userid。
titlestring网络研讨会主题(1~255位字符长度)。
sponsorstring主办方名称(1~40位字符长度)。
start_timestring会议开始时间戳(单位秒),不能少于当前时间戳半小时以上。
end_timestring会议结束时间戳(单位秒)。
admission_typeuint32观众观看限制类型:
0:公开
1:报名
2:密码
hostsobject[]主持人的成员 ID,默认为网络研讨会管理员admin_userid。 注意:修改时传入,则会覆盖原有设置。详见HostInfo 。
passwordstring观众观看密码(4~6位数字),当 admission_type = 2 时必传,且仅当 admission_type = 2 时才生效。
cover_urlstring封面图片 URL,图片仅支持 PNG 和 JPEG 格式,分辨率需大于640360,推荐使用1280720的高清图片,文件需控制在 5 MB 以内。
该参数需要开启活动页配置(activity_page)。
接口上传封面方式为异步上传,可通过订阅 素材上传结果 获得上传结果通知。
descriptionstring网络研讨会描述详情,仅支持纯文本,1~5000位字符长度。
该参数需要开启活动页配置(activity_page)。
enable_guest_invite_linkbool是否开启通过邀请链接自动成为嘉宾:
true:开启
false:不开启,默认 false。
media_settingobject媒体参数配置。详见MediaSetting。
enable_qabool是否开启问答:
true:开启
false:不开启,默认 true。
sensitive_wordsstring[]聊天敏感词,包含敏感词的观众公共聊天将不会出现在您的会议中,最多可添加50个敏感词,单个敏感词限制10个中文字符长度。
enable_manual_checkbool是否开启人工审核:
true:开启
false:不开启,默认 false。
activity_pagebool活动页开启配置:
true:开启活动页,默认开启。
false:不开启活动页。
查询时返回默认值true。
display_number_of_attendeesuint32活动页展示已报名或已预约人数:
0:不展示
1:展示,默认开启。
该参数需要开启活动页配置(activity_page)。
playback_for_audiencebool允许观众观看回放。
true:允许
false:不允许,默认值为 false
开启本选项时必须开启云录制,即 auto_record_type 的值必须为 cloud。
preparation_modebool是否开启准备模式:
true:开启
false:关闭

HostInfo说明

参数必须类型说明
useridstring主持人userid

MediaSetting说明

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

 

权限说明

  • 仅配置在“可调用接口的应用”列表中的自建应用可调用
  • 成员需要在应用的可见范围内

 

返回结果:

{
	"errcode": 0,
	"errmsg": "ok",
	"title": "TITLE",
	"meetingid": "MEETINGID",
	"meeting_code": "CODE",
	"start_time": "166666666",
	"end_time": "177777777",
	"admission_type": 0,
	"password": "PASSWORD",
	"audience_join_link": "LINK",
	"guest_join_link": "LINK",
	"manual_check_link": "LINK",
	"manual_check_password": "PASSWORD"
}

参数说明

参数类型说明
errcodeint32返回码
errmsgstring对返回码的文本描述内容
titlestring网络研讨会主题。
meetingidstring网络研讨会ID。
meeting_codestring网络研讨会的会议号。
start_timestring会议开始时间戳(单位秒)。
end_timestring会议结束时间戳(单位秒)。
admission_typeuint32观众观看限制类型:
0:公开
1:报名
2:密码
passwordstring观众观看密码(4~6位数字)。
audience_join_linkstring观众入会链接。
guest_join_linkstring嘉宾入会链接。如果 enable_guest_invite_link = true,通过此链接入会的成员自动成为嘉宾,否则和观众入会链接功能一致。
manual_check_linkstring人工审核链接。 enable_manual_check开启后返回该字段。
manual_check_passwordstring人工审核密码。 enable_manual_check开启后返回该字段。

 

上一篇结束会议投票
下一篇修改网络研讨会
    本节内容
服务端API
基础
连接微信
办公
会议
会议统计管理
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们