获取网络研讨会详情 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

企业内部开发

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

企业内部开发服务端API 会议网络研讨会 (Webinar) 管理获取网络研讨会详情

获取网络研讨会详情

最后更新：2023/04/26

获取指定的网络研讨会详细信息，支持通过会议 ID 或会议 Code 方式查询。

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

请求包体：

{
	"meetingid": "MEETINGID",
	"meeting_code": "MEETINGCODE"
}

参数说明：

参数	必须	类型	说明
access_token	是	string	调用接口凭证。获取方法查看“获取access_token”
meetingid	否	string	网络研讨会ID，meetingid 和 meeting_code 二者必须送一个，二者都送时以 meetingid 为准。
meeting_code	否	string	网络研讨会的会议号，meetingid 和 meeting_code 二者必须送一个，二者都送时以 meetingid 为准。

权限说明

仅配置在“可调用接口的应用”列表中的自建应用可调用
仅允许获取该应用创建的网络研讨会的数据
仅返回在应用可见范围内的成员

返回结果：

{
	"meetingid": "MEETINGID",
	"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,
	"audience_join_link": "LINK",
	"guest_join_link": "LINK",
	"media_setting": {
		"mute_enable_join": 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,
	"manual_check_link": "LINK",
	"manual_check_password": "PASSWORD",
	"activity_page": false,
	"display_number_of_attendees": 0,
	"playback_for_audience": true,
	"playback_url": "URL",
	"preparation_mode": false,
	"warm_up_picture": "URL",
	"warm_up_video": "URL",
	"allow_attendees_invite_others": false
}

参数说明

参数	类型	说明
subject	string	网络研讨会主题。
meetingid	string	网络研讨会ID。
meeting_code	string	网络研讨会的会议号。
status	string	当前会议状态：- MEETING_STATE_INVALID：非法或未知的会议状态，错误状态。 - MEETING_STATE_INIT：会议待开始。会议预定后的初始状态，即会议预定开始时间之前的状态。 - MEETING_STATE_CANCELLED：会议已取消。主持人主动取消会议，待开始的会议才能取消，且取消的会议无法再进入。 - MEETING_STATE_STARTED：会议已开始。会议中有人则表示会议进行中。 - MEETING_STATE_ENDED：会议已删除。会议已过预定结束时间且尚无人进会时，主持人删除会议，已删除的会议无法再进入。 - MEETING_STATE_ABOUT_TO_START：会议即将开始，已过会以预定开始时间，且未到会议结束时间，会中无人状态。 - MEETING_STATE_RECYCLED：会议已回收。会议已过预定结束时间且会中无人，则会议号将被后台回收，无法再进入。
sponsor	string	主办方名称。
start_time	string	会议开始时间戳（单位秒）。
end_time	string	会议结束时间戳（单位秒）。
admission_type	uint32	观众观看限制类型： 0：公开 1：报名 2：密码
hosts	object[]	主持人的成员 ID，默认为网络研讨会管理员admin_userid。注意：修改时传入，则会覆盖原有设置。
password	string	观众观看密码（4~6位数字）。
cover_url	string	封面图片 URL，图片仅支持 PNG 和 JPEG 格式，分辨率需大于640360，推荐使用1280720的高清图片，文件需控制在5MB 以内。该参数需要开启活动页配置（activity_page）。
description	string	网络研讨会描述详情，仅支持纯文本，1~5000位字符长度。该参数需要开启活动页配置（activity_page）。
enable_guest_invite_link	bool	是否开启通过邀请链接自动成为嘉宾： true：开启 false：不开启
audience_join_link	string	观众入会链接。
guest_join_link	string	嘉宾入会链接。如果 enable_guest_invite_link = true，通过此链接入会的成员自动成为嘉宾；否则和观众入会链接功能一致。
media_setting	object	媒体参数配置。详见MediaSetting
enable_qa	bool	是否开启问答： true：开启 false：不开启
manual_check_link	string	人工审核链接。 enable_manual_check开启后返回该字段。
manual_check_password	string	人工审核密码。 enable_manual_check开启后返回该字段。
activity_page	bool	活动页开启配置： true：开启活动页，默认开启。 false：不开启活动页。查询时返回默认值 true。
display_number_of_attendees	string	活动页展示已报名或已预约人数： 0：不展示 1：展示，默认开启。该参数需要开启活动页配置（activity_page）。
playback_for_audience	bool	允许观众观看回放。 true：允许 false：不允许，默认值为 false 开启本选项时必须开启云录制，即 auto_record_type 的值必须为 cloud。
playback_url	string	回放地址。
preparation_mode	bool	是否开启准备模式： true：开启 false：关闭
warm_up_picture	string	暖场图片地址。暖场图片与暖场视频只能选择一个，如果同时传入图片和视频，以图片为准。图片推荐 1280*720 尺寸，支持 png/jpg 格式，大小不超过 5M。会议开始前 15 分钟进入的观众可观看暖场，仅支持 3.3.0 及以上版本客户端观看。
warm_up_video	string	暖场视频地址。暖场图片与暖场视频只能选择一个。推荐 1280*720 尺寸，支持 mp4 格式，大小不超过 1G。会议开始前 15 分钟进入的观众可观看暖场，仅支持 3.3.0 及以上版本客户端观看。
allow_attendees_invite_others	bool	允许参会者在暖场中邀请成员。 true：允许，默认允许。 false：不允许。

HostInfo说明

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

MediaSetting说明

参数	类型	说明
enable_enter_mute	bool	嘉宾入会时静音。默认值为 false。
allow_unmute_self	bool	允许嘉宾取消静音。默认值为 false。
allow_enter_before_host	bool	是否允许嘉宾在主持人进会前加入会议，默认值为 true。
enable_screen_watermark	bool	是否开启屏幕共享水印，默认值为 false： true：开启 false：不开启
watermark_type	uint32	水印样式，默认为单排。当屏幕共享水印参数为开启时，此参数才生效。 0：单排 1：多排
allow_external_user	bool	是否仅企业内部成员可入会，默认值为 false： true：仅企业内部成员可入会 false：所有人可入会
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及以上版本生效。

取消网络研讨会

获取网络研讨会嘉宾列表

本节内容

获取网络研讨会详情