接口描述
描述:查询指定的网络研讨会详细信息,支持通过会议 ID 或会议 Code 方式查询,只有网络研讨会的创建者才有权限查询。
请求方式:GET
接口请求域名:
https://api.meeting.qq.com/v1/webinars?meeting_id={meeting_id}&userid={userid}&instanceid={instanceid}
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
meeting_id | 否 | String | 网络研讨会唯一标识,meeting_id 和 meeting_code 二者必须送一个,二者都送时以 meeting_id 为准。 |
meeting_code | 否 | String | 会议 App 的呼入号码,meeting_id 和 meeting_code 二者必须送一个,二者都送时以 meeting_id 为准。 |
userid | 是 | String | 调用方用于标示用户的唯一 ID(企业内部请使用企业唯一用户标识;OAuth 2.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 | 网络研讨会主题。 |
meeting_id | String | 网络研讨会唯一标识。 |
meeting_code | String | 会议 App 的呼入号码。 |
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 | 会议结束时间戳(单位秒)。 |
time_zone | String | |
admission_type | Integer | 观众观看限制类型: 0:公开 1:报名 2:密码 |
hosts | User 对象数组 | 会议指定主持人的用户 ID,如果无指定,主持人将被设定为参数 userid 的用户,即 API 调用者。 注意:仅授权用户账号为腾讯会议商业版、企业版、教育版可指定主持人。 修改时传入,则会覆盖原有设置。 |
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 | Boolean | 是否开启通过邀请链接自动成为嘉宾: true:开启 false:不开启 |
audience_join_link | String | 观众入会链接。 |
guest_join_link | String | 嘉宾入会链接。如果 enable_guest_invite_link = true,通过此链接入会的成员自动成为嘉宾;否则和观众入会链接功能一致。 |
media_setting | MediaSetting 对象 | 媒体参数配置。 |
enable_qa | Boolean | 是否开启问答: true:开启 false:不开启 |
manual_check_link | String | 人工审核链接。 |
manual_check_password | String | 人工审核密码。 |
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。 |
playback_url | String | 回放地址。 |
sync_to_wework | Boolean | 会议是否同步至企业微信,该字段仅支持创建会议时设置,创建后无法修改。该配置仅支持与企业微信关联的企业。 true:同步,默认同步 false:不同步 |
preparation_mode | Boolean | 是否开启准备模式: 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_participants_invite_others | Boolean | 允许参会者在暖场中邀请成员。 true:允许,默认允许。 false:不允许。 |
User 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
userid | 是 | String | 用户 ID。 企业唯一用户标识说明: 企业对接 SSO 时使用的员工唯一标识 ID,企业调用创建用户接口时传递的 userid 参数。 |
open_id | 是 | String | OAuth 2.0授权用户 ID。仅支持与会议创建者(即授权的用户)同企业,个人用户无法指定主持人。OAuth 鉴权仅使用 open_id。 |
MediaSetting 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
mute_enable_join | 否 | Boolean | 嘉宾入会时静音。默认值为 false。 |
allow_unmute_self | 否 | Boolean | 允许嘉宾取消静音。默认值为 false。 |
allow_in_before_host | 否 | Boolean | 是否允许嘉宾在主持人进会前加入会议,默认值为 true。 |
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及以上版本生效。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
500 | 9003 | MEETING NOT EXIST。 |
400 | 190001 | 存在未注册的用户。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
500 | 190308 | 查询 tinyID 失败。 |
500 | 202001 | 请对照接口文档检查您的参数。 |
500 | 190001 | 存在未注册的用户。 |
500 | 41 | 网络错误,请稍后重试。 |
500 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
示例
输入示例
GEThttps://api.meeting.qq.com/v1/webinars?userid=aaa&meeting_code=887228671&instanceid=1&meeting_id=7976035087704477330
输出示例
{"subject":"webinar 2","meeting_id":"7976035087704477330","meeting_code":"887228671","status":"MEETING_STATE_INIT","sponsor":"564ggg","start_time":"1631589648","end_time":"1631589649","time_zone":"Asia/Shanghai","admission_type":2,"password":"1234","description":"PHA+ZmEgbHVuIGdvbmc8L3A+","enable_guest_invite_link":true,"audience_join_link":"https://xxx.tencentmeeting.com/dw/xxxxxxJd7Dc","guest_join_link":"https://xxx.tencentmeeting.com/s/xxxxxxUy5V","media_setting":{"mute_enable_join":true,"allow_unmute_self":true,"allow_in_before_host":true,"allow_screen_shared_watermark":true,"only_enterprise_user_allowed":false,"auto_record_type":"local","water_mark_type":1},"enable_qa":true,"manual_check_link":"https://xxx.txmeeting.tencent.com/webinar-audit/xxxxxxpNd","manual_check_password":"exNIPU"}