腾讯会议 创建网络研讨会

这篇说说了腾讯云网络研讨会的预定接口,包括接口描述、输入参数、输出参数、错误码列表及示例。企业 secret 鉴权用户和 OAuth2.0 鉴权用户有不同的创建权限,且必须是注册用户。接口请求方式为 POST,请求域名为 企业 secret 鉴权用户可创建所属企业下的网络研讨会,OAuth2.0 鉴权用户只能创建对。

相关产品
腾讯会议 产品页,含版本规格、价格与购买入口。

一、接口描述

·描述:预定一个网络研讨会。企业 secret 鉴权用户可创建该用户所属企业下的网络研讨会,OAuth2.0 鉴权用户只能创建该企业下 OAuth2.0 应用的网络研讨会。用户必须是注册用户,请求头部 X-TC-Registered 字段必须传入为1。

注意:原 SaaS 版企业版、原 SaaS 版教育版账号:购买虚拟会议室数不足10个,无法使用该接口。

·请求方式:POST

·接口请求域名:

https://api.meeting.qq.com/v1/webinars

二、输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明。

参数名称 必选 参数类型 参数描述
userid 是 String 调用方用于标示用户的唯一 ID(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。企业唯一用户标识说明:1:企业对接 SSO 时使用的员工唯一标识 ID。2:企业调用创建用户接口时传递的 userid 参数。
instanceid 是 Integer 用户的终端设备类型:0:PSTN1:PC2:Mac3:Android4:iOS5:Web6:iPad7:Android Pad8:小程序9:voip、sip 设备10:Linux20:Rooms for Touch Windows21:Rooms for Touch MacOS22:Rooms for Touch Android30:Controller for Touch Windows32:Controller for Touch Android33:Controller for Touch iOS创建会议时 userid 对应的设备类型,不影响入会时使用的设备类型,缺省可填1。
subject 是 String 网络研讨会主题(1~255位字符长度)。
sponsor 否 String 主办方名称(1~40位字符长度)。
start_time 是 String 会议开始时间戳(单位秒),不能少于当前时间戳半小时以上。
end_time 是 String 会议结束时间戳(单位秒)。
time_zone 否 String 时区,可参见Oracle-TimeZone 标准。不传则默认中国标准时区 Asia/Shanghai。
admission_type 是 Integer 观众观看限制类型:0:公开1:报名2:密码
hosts 是 User 对象数组 会议指定主持人的用户 ID,如果无指定,主持人将被设定为参数 userid 的用户,即 API 调用者。 注意:仅授权用户账号为腾讯会议商业版、企业版、教育版可指定主持人。 修改时传入,则会覆盖原有设置。
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 否 Boolean 是否开启通过邀请链接自动成为嘉宾:true:开启false:不开启,默认 false
media_setting 否 MediaSetting 对象 媒体参数配置。
enable_qa 否 Boolean 是否开启问答:true:开启false:不开启,默认 true
sensitive_words 否 String 数组 聊天敏感词,包含敏感词的观众公共聊天将不会出现在你的会议中,最多可添加100个敏感词,单个敏感词限制10个中文字符长度。
enable_manual_check 否 Boolean 是否开启信息安全人工审核:true:开启false:不开启,默认 false
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。
sync_to_wework 否 Boolean 会议是否同步至企业微信,该字段仅支持创建会议时设置,创建后无法修改。该配置仅支持与企业微信关联的企业。true:同步,默认同步false:不同步
preparation_mode 否 Boolean 是否开启准备模式:true:开启false:关闭
allow_look_audience_count 否 Integer 允许观众查看会中人数,默认为1。0:关闭1:开启

三、User 对象

参数名称 必选 参数类型 参数描述
userid 是 String 用户 ID。 企业唯一用户标识说明: 企业对接 SSO 时使用的员工唯一标识 ID,企业调用创建用户接口时传递的 userid 参数。
open_id 是 String OAuth2.0 授权用户 ID。仅支持与会议创建者(即授权的用户)同企业,个人用户无法指定主持人。OAuth 鉴权仅使用 open_id。

四、MediaSetting 对象

参数名称 必选 参数类型 参数描述
mute_enable_join 否 Boolean 入会时静音,默认值为 true。true:开启false:不开启
allow_unmute_self 否 Boolean 允许参会者取消静音,默认值为 true。true:开启false:不开启
allow_in_before_host 否 Boolean 是否允许嘉宾在主持人进会前加入会议,默认值为 true。true:允许false:不允许
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及以上版本生效。

五、输出参数

参数名称 参数类型 参数描述
subject String 网络研讨会主题。
meeting_id String 网络研讨会唯一标识。
meeting_code String 会议 App 的呼入号码。
start_time String 会议开始时间戳(单位秒)。
end_time String 会议结束时间戳(单位秒)。
admission_type Integer 观众观看限制类型:0:公开1:报名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 人工审核密码。

六、错误码列表

状态码 错误码 错误描述
400 190004 参数非法,请对照接口文档检查你的参数。
500 9100 无权限预订会议。
500 190001 存在未注册的用户。
500 202007 成员不在会中。
500 41 网络错误,请稍后重试。

七、输入示例

POSThttps://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":"17305428xxxx4531991", "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"}

赞 (0)
上一篇 4天前
下一篇 4天前