创建网络研讨会 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

企业内部开发

快速入门服务端API 客户端API 附录更新日志联系我们

企业内部开发服务端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_token	是	string	调用接口凭证。获取方法查看“获取access_token”
admin_userid	是	string	网络研讨会管理员userid。
title	是	string	网络研讨会主题（1~255位字符长度）。
sponsor	否	string	主办方名称（1~40位字符长度）。
start_time	是	string	会议开始时间戳（单位秒），不能少于当前时间戳半小时以上。
end_time	是	string	会议结束时间戳（单位秒）。
admission_type	是	uint32	观众观看限制类型： 0：公开 1：报名 2：密码
hosts	否	object[]	主持人的成员 ID，默认为网络研讨会管理员admin_userid。注意：修改时传入，则会覆盖原有设置。详见HostInfo 。
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	否	bool	是否开启通过邀请链接自动成为嘉宾： true：开启 false：不开启，默认 false。
media_setting	否	object	媒体参数配置。详见MediaSetting。
enable_qa	否	bool	是否开启问答： true：开启 false：不开启，默认 true。
sensitive_words	否	string[]	聊天敏感词，包含敏感词的观众公共聊天将不会出现在您的会议中，最多可添加50个敏感词，单个敏感词限制10个中文字符长度。
enable_manual_check	否	bool	是否开启人工审核： true：开启 false：不开启，默认 false。
activity_page	否	bool	活动页开启配置： true：开启活动页，默认开启。 false：不开启活动页。查询时返回默认值true。
display_number_of_attendees	否	uint32	活动页展示已报名或已预约人数： 0：不展示 1：展示，默认开启。该参数需要开启活动页配置（activity_page）。
playback_for_audience	是	bool	允许观众观看回放。 true：允许 false：不允许，默认值为 false 开启本选项时必须开启云录制，即 auto_record_type 的值必须为 cloud。
preparation_mode	否	bool	是否开启准备模式： true：开启 false：关闭

HostInfo说明

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

MediaSetting说明

参数名称	必选	参数类型	参数描述
enable_enter_mute	否	bool	入会时静音，默认值为 true。 true：开启 false：不开启
allow_unmute_self	否	bool	允许参会者取消静音，默认值为 true。 true：开启 false：不开启
allow_enter_before_host	否	bool	是否允许嘉宾在主持人进会前加入会议，默认值为 true。 true：允许 false：不允许
enable_screen_watermark	否	bool	是否开启屏幕共享水印，默认值为 false。 true：开启 false：不开启
watermark_type	否	uint32	水印样式，默认为单排。当屏幕共享水印参数为开启时，此参数才生效。 0：单排 1：多排
allow_external_user	否	bool	是否仅企业内部成员可入会，默认值为 True。 false：仅企业内部成员可入会 true：所有人可入会
auto_record_type	否	string	自动会议录制类型： none：禁用，表示不开启自动会议录制。 local：本地录制，表示主持人入会后自动开启本地录制。 cloud：云录制，表示主持人入会后自动开启云录制。说明：该参数依赖企业账户设置，当企业强制锁定后，该参数必须与企业配置保持一致。仅客户端2.7.0及以上版本可生效。
attendee_join_auto_record	否	bool	当有参会成员入会时立即开启云录制，默认值为 false 关闭：关闭时，主持人入会自动开启云录制。开启时，则有参会成员入会自动开启云录制。说明：该参数必须 auto_record_type 设置为“cloud”时才生效，该参数依赖企业账户设置，当企业强制锁定后，该参数必须与企业配置保持一致。仅客户端2.7.0及以上版本生效。
enable_host_pause_auto_record	否	bool	允许主持人暂停或者停止云录制，默认值为 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"
}

参数说明

参数	类型	说明
errcode	int32	返回码
errmsg	string	对返回码的文本描述内容
title	string	网络研讨会主题。
meetingid	string	网络研讨会ID。
meeting_code	string	网络研讨会的会议号。
start_time	string	会议开始时间戳（单位秒）。
end_time	string	会议结束时间戳（单位秒）。
admission_type	uint32	观众观看限制类型： 0：公开 1：报名 2：密码
password	string	观众观看密码（4~6位数字）。
audience_join_link	string	观众入会链接。
guest_join_link	string	嘉宾入会链接。如果 enable_guest_invite_link = true，通过此链接入会的成员自动成为嘉宾，否则和观众入会链接功能一致。
manual_check_link	string	人工审核链接。 enable_manual_check开启后返回该字段。
manual_check_password	string	人工审核密码。 enable_manual_check开启后返回该字段。

结束会议投票

修改网络研讨会

本节内容

创建网络研讨会