查询网络研讨会
接口描述
描述:查询指定的网络研讨会详细信息,支持通过会议 ID 或会议 Code 方式查询,只有网络研讨会的创建者才有权限查询。
调用方式:GET
接口请求域名:
https://api.meeting.qq.com/v1/webinars?meeting_id={meeting_id}&userid={userid}&instanceid={instanceid}
输入参数
HTTP 请求头公共参数请参见签名验证章节的 公共参数说明。
参数名称 | 必选 | 参数类型 | 参数描述 |
---|---|---|---|
meeting_id | 否 | String | 网络研讨会唯一标识,meeting_id 和 meeting_code 二者必须送一个,二者都送时以 meeing_id 为准。 |
meeting_code | 否 | String | 会议 App 的呼入号码,meeting_id 和 meeting_code 二者必须送一个,二者都送时以 meeing_id 为准。 |
userid | 是 | String | 调用方用于标示用户的唯一 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。<br>企业唯一用户标识说明:<br>1. 企业对接 SSO 时使用的员工唯一标识 ID;<br>2. 企业调用创建用户接口时传递的 userid 参数。 |
instanceid | 是 | Integer | 用户的终端设备类型: <br>1:PC <br>2:Mac<br>3:Android <br>4:iOS <br>5:Web <br>6:iPad <br>7:Android Pad <br>8:小程序 |
输出参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
subject | String | 网络研讨会主题。 |
meeting_id | String | 网络研讨会唯一标识。 |
meeting_code | String | 会议 App 的呼入号码。 |
status | String | 当前会议状态:<br><li>MEETING_STATE_INVALID:非法或未知的会议状态,错误状态。<br><li>MEETING_STATE_INIT:会议待开始。会议预定到预定结束时间前,会议尚无人进会。<br><li>MEETING_STATE_CANCELLED:会议已取消。主持人主动取消会议,待开始的会议才能取消,且取消的会议无法再进入。<br><li>MEETING_STATE_STARTED:会议已开始。会议中有人则表示会议进行中。<br><li>MEETING_STATE_ENDED:会议已删除。会议已过预定结束时间且尚无人进会时,主持人删除会议,已删除的会议无法再进入。<br><li>MEETING_STATE_ABOUT_TO_START:会议即将开始,转让会议预定时间前一小时的无人会议由 INIT 变此状态。<br><li>MEETING_STATE_ORDER_STARTED:到会议的预定开始时间,默认会议预定时间由 INIT 变更为此状态。<br><li>MEETING_STATE_NULL:会议无状态。会议已过预定结束时间,会议尚无人进会。<br><li>MEETING_STATE_RECYCLED:会议已回收。会议已过预定开始时间30天,则会议号将被后台回收,无法再进入。 |
sponsor | String | 主办方名称。 |
start_time | String | 会议开始时间戳(单位秒)。 |
end_time | String | 会议结束时间戳(单位秒)。 |
admission_type | Integer | 观众观看限制类型:<br>0:公开<br>1:报名<br>2:密码 |
password | String | 观众观看密码(4~6位数字)。 |
cover_url | String | 封面图片 URL(base64)。 |
description | String | 网络研讨会描述详情。(由于允许在 Web 端设置富文本和图片,故此处返回经 base64 编码的 html 内容)。 |
enable_guest_invite_link | Boolean | 是否开启通过邀请链接自动成为嘉宾:<br>true:开启<br>false:不开启 |
audience_join_link | String | 观众入会链接。 |
guest_join_link | String | 嘉宾入会链接。如果 enable_guest_invite_link = true,通过此链接入会的成员自动成为嘉宾;否则和观众入会链接功能一致。 |
media_setting | 媒体参数配置对象 | 媒体参数配置。 |
enable_qa | Boolean | 是否开启问答:<br>true:开启<br>false:不开启 |
manual_check_link | String | 人工审核链接。 |
manual_check_password | String | 人工审核密码。 |
参数名称 | 必选 | 参数类型 | 参数描述 |
---|---|---|---|
mute_enable_join | 否 | Boolean | 嘉宾入会时静音。默认值为 false。 |
allow_unmute_self | 否 | Boolean | 允许嘉宾取消静音。默认值为 false。 |
allow_in_before_host | 否 | Boolean | 是否允许嘉宾在主持人进会前加入会议,默认值为 true。 |
allow_screen_shared_watermark | 否 | Boolean | 是否开启屏幕共享水印,默认值为 false:<br>true:开启<br>false:不开启 |
water_mark_type | 否 | Integer | 水印样式,默认为单排。当屏幕共享水印参数为开启时,此参数才生效。<br>0:单排<br>1:多排 |
only_enterprise_user_allowed | 否 | Boolean | 是否仅企业内部成员可入会,默认值为 false:<br>true:仅企业内部用户可入会<br>false:所有人可入会 |
auto_record_type | 否 | String | 自动会议录制类型:<br>none:禁用,表示不开启自动会议录制。<br>local:本地录制,表示主持人入会后自动开启本地录制。<br>cloud:云录制,表示主持人入会后自动开启云录制。<br>**说明:**该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。仅客户端2.7.0及以上版本可生效。 |
participant_join_auto_record | 否 | Boolean | 当有参会成员入会时立即开启云录制,默认值为 false 关闭:<br>关闭时:主持人入会自动开启云录制。<br>开启时:参会成员入会自动开启云录制。<br>**说明:**该参数必须 auto_record_type 设置为“cloud”时才生效,该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。仅客户端2.7.0及以上版本生效。 |
enable_host_pause_auto_record | 否 | Boolean | 允许主持人暂停或者停止云录制,默认值为 true 开启:<br>开启时:主持人允许暂停和停止云录制。<br>关闭时:主持人不允许暂停和关闭云录制。<br> **说明:**该参数必须 auto_record_type 设置为“cloud”时才生效,该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。仅客户端2.7.0及以上版本生效。 |
示例
输入示例
GET
https://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",
"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"
}
下载 腾讯会议API查询网络研讨会-腾讯会议.pdf
文章内容是否对您有帮助?
有帮助
无帮助
能否告知我们这篇文章的问题?(选填)