创建网络研讨会
接口描述
描述:预定一个网络研讨会。企业 secert 鉴权用户可创建该用户所属企业下的网络研讨会,OAuth2.0 鉴权用户只能创建该企业下 OAuth2.0 应用的网络研讨会。用户必须是注册用户,请求头部 X-TC-Registered 字段必须传入为1。
注:
1. 商业版账号:按年购买高级账号数不足20个,无法使用该接口。
2. 企业版、教育版账号:购买虚拟会议室数不足10个,无法使用该接口。
调用方式:POST
接口请求域名:
https://api.meeting.qq.com/v1/webinars
输入参数
HTTP 请求头公共参数请参见签名验证章节的 公共参数说明。
参数名称 | 必选 | 参数类型 | 参数描述 |
---|---|---|---|
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:小程序 <br>创建会议时 userid 对应的设备类型,不影响入会时使用的设备类型,缺省可填1。 |
subject | 是 | String | 网络研讨会主题(1~255位字符长度)。 |
sponsor | 否 | String | 主办方名称(1~40位字符长度)。 |
start_time | 是 | String | 会议开始时间戳(单位秒),不能少于当前时间戳半小时以上。 |
end_time | 是 | String | 会议结束时间戳(单位秒)。 |
admission_type | 是 | Integer | 观众观看限制类型:<br>0:公开<br>1:报名<br>2:密码 |
password | 否 | String | 观众观看密码(4~6位数字),当 admission_type = 2 时必传,且仅当 admission_type = 2 时才生效。 |
cover_url | 否 | String | 封面图片 URL,图片仅支持 PNG 和 JPEG 格式,分辨率需大于640*360,推荐使用1280*720的高清图片,文件需控制在 5 MB 以内。 |
description | 否 | String | 网络研讨会描述详情,仅支持纯文本,1~5000位字符长度。 |
enable_guest_invite_link | 否 | Boolean | 是否开启通过邀请链接自动成为嘉宾:<br>true:开启<br>false:不开启,默认 false。 |
media_setting | 否 | 媒体参数配置。 | |
enable_qa | 否 | Boolean | 是否开启问答:<br>true:开启<br>false:不开启,默认 true。 |
sensitive_words | 否 | String 数组 | 聊天敏感词,包含敏感词的观众公共聊天将不会出现在您的会议中,最多可添加50个敏感词,单个敏感词限制10个中文字符长度。 |
enable_manual_check | 否 | Boolean | 是否开启人工审核:<br>true:开启<br>false:不开启,默认 false。 |
参数名称 | 必选 | 参数类型 | 参数描述 |
---|---|---|---|
mute_enable_join | 否 | Boolean | 入会时静音,默认值为 true。 <br>true:开启 <br>false:不开启 |
allow_unmute_self | 否 | Boolean | 允许参会者取消静音,默认值为 true。 <br>true:开启 <br>false:不开启 |
allow_in_before_host | 否 | Boolean | 是否允许嘉宾在主持人进会前加入会议,默认值为 true。<br>true:允许 <br>false:不允许 |
allow_screen_shared_watermark | 否 | Boolean | 是否开启屏幕共享水印,默认值为 false。<br>true:开启<br>false:不开启 |
water_mark_type | 否 | Integer | 水印样式,默认为单排。当屏幕共享水印参数为开启时,此参数才生效。<br>0:单排<br>1:多排 |
only_enterprise_user_allowed | 否 | Boolean | 是否仅企业内部成员可入会,默认值为 false。true:仅企业内部用户可入会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及以上版本生效。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
---|---|---|
subject | String | 网络研讨会主题。 |
meeting_id | String | 网络研讨会唯一标识。 |
meeting_code | String | 会议 App 的呼入号码。 |
start_time | String | 会议开始时间戳(单位秒)。 |
end_time | String | 会议结束时间戳(单位秒)。 |
admission_type | Integer | 观众观看限制类型:<br>0:公开<br>1:报名<br>2:密码 |
password | String | 观众观看密码(4~6位数字)。 |
audience_join_link | String | 观众入会链接。 |
guest_join_link | String | 嘉宾入会链接。如果 enable_guest_invite_link = true,通过此链接入会的成员自动成为嘉宾,否则和观众入会链接功能一致。 |
manual_check_link | String | 人工审核链接。 |
manual_check_password | String | 人工审核密码。 |
示例
输入示例
POST
https://api.meeting.qq.com/v1/webinars
{
"start_time":"1631589648",
"end_time":"1631589649",
"media_setting":{
"mute_enable_join":true,
"allow_unmute_self":true,
"allow_in_before_host":true,
"allow_screen_shared_watermark":true,
"water_mark_type":1,
"only_enterprise_user_allowed":false,
"auto_record_type":"cloud",
"participant_join_auto_record":true,
"enable_host_pause_auto_record":true
},
"instanceid":1,
"admission_type":0,
"sponsor":"564ggg",
"description":"ni hao",
"userid":"aaa",
"subject":"webinar 1",
"sensitive_words":[
"123",
"abc",
],
"enable_guest_invite_link":true,
"enable_manual_check":true
}
输出示例
{
"subject":"webinar 1",
"meeting_id":"17305428542504531991",
"meeting_code":"933581085",
"start_time":"1631589648",
"end_time":"1631589649",
"admission_type":0,
"audience_join_link":"https://xxx.tencentmeeting.com/dw/xxxxxxJd7Dc",
"guest_join_link":"https://xxx.tencentmeeting.com/s/xxxxxxUy5V",
"manual_check_link":"https://xxx.txmeeting.tencent.com/webinar-audit/xxxxxxpNd",
"manual_check_password":"oVBN2P"
}