腾讯会议API创建会议-腾讯会议 - 腾讯会议帮助中心

创建会议

接口描述

描述：快速创建/预定一个会议。

企业 secret 鉴权用户可创建该用户所属企业下的会议，OAuth2.0 鉴权用户只能创建该企业下 OAuth2.0 应用的会议。
用户必须是注册用户，请求头部 X-TC-Registered 字段必须传入为1。
当您想实时监测会议创建状况时，您可以通过订阅会议创建的事件，接收事件通知。
本接口的邀请参会成员限制调整至300人。
当会议为周期性会议时，主持人密钥每场会议固定，但单场会议只能获取一次。支持创建周期性会议的主持人密钥。
注：
1. 商业版账号：按年购买高级账号数不足20个，无法使用该接口。
2. 企业版、教育版账号：购买虚拟会议室数不足10个，无法使用该接口。

调用方式：POST
接口请求域名：

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

输入参数

以下请求参数列表仅列出了接口请求参数，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	会议主题。
type	是	Integer	会议类型：<br>0：预约会议 <br>1：快速会议
hosts	否	UserObj 数组	会议指定主持人的用户 ID，如果无指定，主持人将被设定为参数 userid 的用户，即 API 调用者。<br>注意：仅腾讯会议商业版和企业版可指定主持人。
invitees	否	UserObj 数组	会议邀请的参会者，可为空。（企业内部请使用企业唯一用户标识；OAuth2.0 鉴权用户请使用 openId）。<br>注意：仅腾讯会议商业版和企业版可邀请参会者，邀请者列表仅支持300人；需要邀请超过300人的场景请调用设置会议邀请成员接口。
start_time	是	String	会议开始时间戳（单位秒）。
end_time	是	String	会议结束时间戳（单位秒）。
password	否	String	会议密码（4~6位数字），可不填。
settings	否	Object	会议媒体参数配置。
meeting_type	否	integer	默认值为0。<br> 0：普通会议<br> 1：周期性会议（周期性会议时 type 不能为快速会议，同一账号同时最多可预定50场周期性会议）
recurring_rule	否	Object	周期性会议配置。
enable_live	否	Boolean	是否开启直播。
live_config	否	Object	直播配置。
enable_doc_upload_permission	否	Boolean	是否允许成员上传文档，默认为允许。
guests	否	Guest 数组	会议嘉宾列表，会议嘉宾不受会议密码和等候室的限制。
media_set_type	否	Integer	该参数仅提供给支持混合云的企业可见，默认值为0。<br>0：外部会议<br>1：内部会议
enable_interpreter	否	Boolean	同声传译开关，默认值为false。<br>false：不开启<br>true：开启同声传译
enable_enroll	否	Boolean	是否激活报名。

注意：
1. userid 不能为1，为1时会发生不确定错误。
2. 会议主题参数为字符串类型，请求和回复消息体中都需要。

用户对象 UserObj

参数名称	必选	参数类型	参数描述
userid	是	String	用户 ID（企业内部请使用企业唯一用户标识；OAuth2.0 鉴权用户请使用 openId）。 <br>企业唯一用户标识说明： <br>企业对接 SSO 时使用的员工唯一标识 ID，企业调用创建用户接口时传递的 userid 参数。
is_anonymous	否	boolean	用户是否匿名入会，缺省为 false，不匿名。<br>true：匿名<br> false：不匿名<br>
nick_name	否	String	用户匿名字符串。如果字段“is_anonymous”设置为“true”，但是无指定匿名字符串, 会议将分配缺省名称，例如 “会议用户xxxx”，其中“xxxx”为随机数字。

会议媒体参数配置对象（Settings 参数）

参数名称	必选	参数类型	参数描述
mute_enable_join	是	boolean	入会时静音，默认值为 true。<br>true：开启 <br>false：关闭
allow_unmute_self	否	boolean	允许参会者取消静音，默认值为 true。<br>true：开启 <br>false：关闭
mute_all	否	boolean	全体静音。
host_video	否	boolean	入会时主持人视频是否开启，暂时不支持。
participant_video	否	boolean	入会时参会者视频是否开启，暂时不支持。
play_ivr_on_leave	否	boolean	参会者离开时播放提示音，暂时不支持，可在客户端设置。
play_ivr_on_join	否	boolean	有新的与会者加入时播放提示音，暂不支持，可在客户端设置。
allow_in_before_host	否	boolean	是否允许成员在主持人进会前加入会议，默认值为 true。 <br>true：允许 <br>false：不允许
auto_in_waiting_room	否	boolean	是否开启等候室，默认值为 false。<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。<br> true：仅企业内部用户可入会 <br>false：所有人可入会
auto_record_type	否	String	自动会议录制类型。<br>none：禁用，表示不开启自动会议录制。<br>local：本地录制，表示主持人入会后自动开启本地录制。<br>cloud：云录制，表示主持人入会后自动开启云录制。<br>说明：<br><li>该参数依赖企业账户设置，当企业强制锁定后，该参数必须与企业配置保持一致。<li>仅客户端2.7及以上版本可生效。
participant_join_auto_record	否	boolean	当有嘉宾入会时立即开启云录制，默认值为 false 关闭，关闭时，主持人入会自动开启云录制；当设置为开启时，则有嘉宾入会自动开启云录制。<br>说明：<br><li>该参数必须 auto_record_type 设置为“cloud”时才生效，该参数依赖企业账户设置，当企业强制锁定后，该参数必须与企业配置保持一致。<li>仅客户端2.7及以上版本生效。
enable_host_pause_auto_record	否	boolean	允许主持人暂停或者停止云录制，默认值为 true 开启，开启时，主持人允许暂停和停止云录制；当设置为关闭时，则主持人不允许暂停和关闭云录制。<br>说明：<br><li>该参数必须 auto_record_type 设置为“cloud”时才生效，该参数依赖企业账户设置，当企业强制锁定后，该参数必须与企业配置保持一致。<li>仅客户端2.7及以上版本生效。

周期性会议 recurring_rule

参数名称	必选	参数类型	参数描述
recurring_type	否	integer	重复类型，默认值为0。<br>0：每天<br> 1：每周一至周五<br>2：每周<br>3：每两周<br>4：每月<br>
until_type	否	integer	结束重复类型，默认值为0。<br>0：按日期结束重复<br>1：按次数结束重复
until_date	否	integer	结束日期时间戳。<br>说明：结束日期与第一场会议的开始时间换算成的场次数不能超过以下限制：每天、每个工作日、每周最大支持200场子会议；每两周、每月最大支持50场子会议，例如：对于每天的重复类型，第一场会议开始时间为1609430400，则结束日期时间戳不能超过1609430400 + 200 × 24 × 60 × 60 - 1。如未填写，默认为当前日期往后推7天。
until_count	否	integer	限定会议次数。<br>说明：每天、每个工作日、每周最大支持200场子会议；每两周、每月最大支持50场子会议。如未填写，则默认为7次。

直播配置 live_config

参数名称	必选	参数类型	参数描述
live_subject	否	String	直播主题，开启之后。
live_summary	否	String	直播简介。
enable_live_password	否	boolean	是否开启直播密码，默认值为 false。<br>true：开启<br> false：不开启
live_password	否	String	直播密码。当设置开启直播密码时，该参数必填。
enable_live_im	否	boolean	允许观众讨论，默认值为 false。<br> true：开启<br> false：不开启
enable_live_replay	否	boolean	开启直播回看，默认值为 false。<br> true：开启<br> false：不开启
live_watermark	否	object	直播水印对象信息。

直播水印信息 live_watermark_info

参数名称	必选	参数类型	参数描述
watermark_opt	否	integer	水印选项，默认为0。<br> 0：默认水印<br> 1：无水印

会议嘉宾 Guest 对象

参数名称	必选	参数类型	参数描述
area	是	String	国家/地区代码（例如：中国传86，不是+86，也不是0086）。
phone_number	是	String	手机号。
guest_name	否	String	嘉宾名称。

输出参数

参数名称	参数类型	参数描述
meeting_number	integer	会议数量。
meeting_info_list	会议对象数组	预约会议列表。

会议对象

参数名称	参数类型	参数描述
subject	String	会议主题。
meeting_id	String	会议的唯一标示。
meeting_code	String	会议 App 的呼入号码。
password	String	会议密码。
hosts	String 数组	会议主持人的用户 ID，如果无指定，主持人将被设定为上文的 userid，即 API 调用者，仅商业版和企业版可指定主持人。
participants	String 数组	邀请的参会者用户 ID，仅商业版和企业版可邀请参会用户。
user_non_registered	String 数组	邀请的参会者中未注册用户。<br>注意：仅腾讯会议商业版和企业版可获取该参数。
start_time	String	会议开始时间戳（单位秒），对于快速会议则为会议创建的时间。
end_time	String	会议结束时间戳（单位秒）。
join_url	String	加入会议 URL（单击链接直接加入会议）。
settings	会议媒体参数对象	会议的配置，可为缺省配置。
enable_live	Boolean	是否开启直播。
live_config	Object	直播配置对象，内部只返回 live_addr（直播观看地址）。

示例

输入示例

POST https://api.meeting.qq.com/v1/meetings
{
     "userid" : "tester",
     "instanceid" : 1,
     "subject" : "tester's meeting",
     "type" : 0,
     "hosts" : ["tester"],
     "invitees" : ["test1", "guest1", "guest2"],
     "start_time" : "1572172200",
     "end_time" : "1572175800",
     "password" : "1111",
     "user_non_registered":["test1","test2"],
     "settings" : {
        "mute_enable_join":true,
        "allow_unmute_self":false,
        "mute_all": false,
        "play_ivr_on_leave": false,
        "play_ivr_on_join": false,
        "allow_in_before_host":true,
        "auto_in_waiting_room":false,
        "allow_screen_shared_watermark":false,
        "only_enterprise_user_allowed":false
     },
     "meeting_type":1,
     "recurring_rule":{
        "recurring_type":0,
        "until_type":1,
        "until_count":7,
        "until_data":1600682957
     },
     "enable_live": true,
     "live_config": {
    	"live_subject":"test_subject",
        "live_summary":"test_summary",
        "enable_live_password": true,
        "live_password":"1234",
        "enable_live_im": true,
        "enable_live_replay": true
    	}
}

输出示例

下载腾讯会议API创建会议-腾讯会议.pdf

文章内容是否对您有帮助？

有帮助

无帮助

能否告知我们这篇文章的问题？（选填）

操作步骤描述不清晰/看不懂这个功能不好用找不到描述的入口没找到我想要了解的信息

0 / 150