创建会议

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

12：Vision Pro

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

81：HarmonyOS Phone

82：HarmonyOS Tablet

83：HarmonyOS PC

84：HarmonyOS Intelligent Cockpit​​

86：HarmonyOS AR/VR

创建会议时 userid 对应的设备类型，不影响入会时使用的设备类型，缺省可填1。

subject

是

String

会议主题。长度不能超过512个字节（长度换算方法为：1个英文字母为2个字节，1个中文汉字为2-4个字节，不同汉字字节长度不一样）。

type

是

Integer

会议类型：

0：预约会议 1：快速会议

hosts

否

User 对象数组

会议指定主持人的用户，如果无指定，主持人将被设定为参数 userid 的用户，即 API 调用者。

注意：仅腾讯会议商业版和企业版可指定主持人。

guests

否

Guest 对象数组

会议嘉宾列表，会议嘉宾不受会议密码和等候室的限制。

会议嘉宾人数限制2000人。

invitees

否

User 对象数组

仅支持邀请与会议创建者同企业的成员（企业内部请使用企业唯一用户标识；OAuth 2.0鉴权用户请使用 openId），该会议将添加至邀请成员的会议列表中。

企业唯一用户标识说明：

企业对接 SSO 时使用的员工唯一标识 ID。

企业调用创建用户接口时传递的 userid 参数。

注意：仅腾讯会议商业版和企业版可邀请参会者，邀请者列表仅支持300人；需要邀请超过300人的场景请调用 设置会议邀请成员 接口。

start_time

是

String

会议开始时间戳（单位秒）。需大于当前时间。

end_time

是

String

会议结束时间戳（单位秒）。需大于开始时间。

password

否

String

会议密码（4~6位数字），可不填。

settings

否

Setting 对象

会议媒体参数配置。

meeting_type

否

integer

会议的模式类型，默认值为0。

0：普通会议

1：周期性会议（周期性会议时 type 不能为快速会议，同一账号每场周期性会议最多可预定50场子会议）

5：个人会议号会议

注意：

部分参数不支持个人会议号会议，传入不生效：

• 不生效，以个人会议号设置的为准：hosts、password、auto_in_waiting_room、only_enterprise_user_allowed、only_user_join_type、allow_in_before_host、allow_screen_shared_watermark、water_mark_type、allow_multi_device、mute_enable_type_join。

• 不生效，PMI 不支持此类能力：meeting_type（不支持修改个人号会议的类型）、recurring_rule、guests、enable_doc_upload_permission、enable_interpreter、enable_enroll、sync_to_wework。

recurring_rule

否

RecurringRule 对象

周期性会议配置。

enable_live

否

Boolean

是否开启直播。

live_config

否

LiveConfig 对象

直播配置。

enable_doc_upload_permission

否

Boolean

是否允许成员上传文档，默认为允许。

media_set_type

否

Integer

该参数仅提供给支持混合云的企业可见，默认值为0。0：外部会议 1：内部会议

enable_interpreter

否

Boolean

同声传译开关，默认值为false。false：不开启 true：开启同声传译

enable_enroll

否

Boolean

是否激活报名。

enable_host_key

否

Boolean

是否开启主持人密钥，默认为 false。

true：开启

false：关闭

host_key

否

String

主持人密钥，仅支持6位数字。

如开启主持人密钥后没有填写此项，将自动分配一个6位数字的密钥。

sync_to_wework

否

Boolean

会议是否同步至企业微信，该字段仅支持创建会议时设置，创建后无法修改。该配置仅支持与企业微信关联的企业。

true：同步，默认同步

false：不同步

time_zone

否

String

时区，可参见 Oracle-TimeZone 标准。

location

否

String

会议地点。最长支持18个汉字或36个英文字母。

allow_enterprise_intranet_only

否

Boolean

是否仅允许企业内网络访问入会。仅企业开通混合云功能后支持该参数。

false：默认值，不限制用户加入会议使用的网络

true：仅允许通过企业内网络访问加入会议

参数名称

必选

参数类型

参数描述

userid

是

String

用户 ID（企业内部请使用企业唯一用户标识；OAuth 2.0鉴权用户请使用 openId）。

企业唯一用户标识说明：

企业对接 SSO 时使用的员工唯一标识 ID，企业调用创建用户接口时传递的 userid 参数。

is_anonymous

否

Boolean

用户是否匿名入会，缺省为 false，不匿名。

true：匿名

false：不匿名

nick_name

否

String

用户匿名字符串。如果字段“is_anonymous”设置为“true”，但是无指定匿名字符串，会议将分配缺省名称，例如“会议用户xxxx”，其中“xxxx”为随机数字。

mute_enable_type_join

否

Integer

成员入会时静音选项，默认值为2。

当同时传入“mute_enable_join”和“mute_enable_type_join”时，将以“mute_enable_type_join”的选项为准。

0：关闭

1：开启

2：超过6人后自动开启

mute_enable_join

否

Boolean

入会时静音，默认值为 true。

true：开启

false：关闭

allow_unmute_self

否

Boolean

允许参会者取消静音，默认值为 true。

true：开启

false：关闭

play_ivr_on_leave

否

Boolean

参会者离开时播放提示音，暂时不支持，可在客户端设置。

play_ivr_on_join

否

Boolean

有新的与会者加入时播放提示音，暂不支持，可在客户端设置。

allow_in_before_host

否

Boolean

是否允许成员在主持人进会前加入会议，默认值为 true。

true：允许

false：不允许

auto_in_waiting_room

否

Boolean

是否开启等候室，默认值为 false。

true：开启

false：不开启

allow_screen_shared_watermark

否

Boolean

是否开启屏幕共享水印，默认值为 false。

true： 开启

false：不开启

water_mark_type

否

Integer

水印样式，默认为单排。

0：单排

1：多排

only_enterprise_user_allowed

否

Boolean

（旧参数）是否仅企业内部成员可入会，默认值为 false。

true：仅企业内部用户可入会

false：所有人可入会

only_user_join_type

否

Integer

成员入会限制。

1：所有成员可入会

2：仅受邀成员可入会

3：仅企业内部成员可入会

当 only_user_join_type 和 only_allow_enterprise_user_join 同时传的时候，以 only_user_join_type 为准。

auto_record_type

否

String

自动会议录制类型。

none：禁用，表示不开启自动会议录制。

local：本地录制，表示主持人入会后自动开启本地录制。

cloud：云录制，表示主持人入会后自动开启云录制。

说明：

该参数依赖企业账户设置，当企业强制锁定后，该参数必须与企业配置保持一致。

如果不填写该参数且企业未锁定，则默认以创建者的客户端设置为准。

仅客户端2.7及以上版本可生效。

participant_join_auto_record

否

Boolean

当有参会成员入会时立即开启云录制，默认值为 false 关闭，关闭时，主持人入会自动开启云录制；当设置为开启时，则有参会成员入会自动开启云录制。

说明：

该参数必须 auto_record_type 设置为“cloud”时才生效，该参数依赖企业账户设置，当企业强制锁定后，该参数必须与企业配置保持一致。

仅客户端2.7及以上版本生效。

enable_host_pause_auto_record

否

Boolean

允许主持人暂停或者停止云录制，默认值为 true 开启，开启时，主持人允许暂停和停止云录制；当设置为关闭时，则主持人不允许暂停和关闭云录制。

说明：

该参数必须 auto_record_type 设置为“cloud”时才生效，该参数依赖企业账户设置，当企业强制锁定后，该参数必须与企业配置保持一致。

仅客户端2.7及以上版本生效。

allow_multi_device

否

Boolean

是否允许成员多端入会。

说明：

若 enable_enroll 为 true 或 password 有值或 auto_in_waiting_room 为 true 或 only_enterprise_user_allowed 为 true 则默认不允许多端入会。

其余情况默认允许多端入会。

change_nickname

否

Integer

是否允许用户自己改名，默认为1。

1：允许用户自己改名

2：不允许用户自己改名

auto_asr

否

Boolean

入会后自动开启文字转写，默认为 false。

true：自动开启转写

false：自动关闭转写

open_asr_view

否

Integer

会中开启文字转写功能后是否自动显示转写侧边栏，默认为0。

0：打开实时转写页面

1：不打开实时转写页面

audio_watermark

否

Boolean

会中是否打开音频水印。

true：是。

false：否。

说明：优先判断账户级设置，作为默认值和强制态。

recurring_type

否

Integer

重复类型，默认值为0。

0：每天

1：每周一至周五

2：每周

3：每两周

4：每月

5：自定义，示例请参见 自定义周期规则 API 调用示例

until_type

否

Integer

结束重复类型，默认值为0。

0：按日期结束重复

1：按次数结束重复

until_date

否

Integer

结束日期时间戳。

说明：结束日期与第一场会议的开始时间换算成的场次数不能超过以下限制：每天、每个工作日、每周最大支持200场子会议；每两周、每月最大支持50场子会议，例如：对于每天的重复类型，第一场会议开始时间为1609430400，则结束日期时间戳不能超过1609430400 + 200 × 24 × 60 × 60 - 1。如未填写，默认为当前日期往后推7天。

until_count

否

Integer

限定会议次数。

说明：每天、每个工作日、每周最大支持200场子会议；每两周、每月最大支持50场子会议。如未填写，则默认为7次。

customized_recurring_type

否

Integer

自定义周期性会议的循环类型。

0：按天。

1：按周。

2：按月，以周为粒度重复。例如：每3个月的第二周的周四。

3：按月，以日期为粒度重复。例如：每3个月的16日。

按周；按月、以周为粒度； 按月、以日期为粒度时，需要包含会议开始时间所在的日期。

customized_recurring_step

否

Integer

每[n]（天、周、月）重复，使用自定义周期性会议时传入。

例如：customized_recurring_type=0 && customized_recurring_step=5表示每5天重复一次。

customized_recurring_type=2 && customized_recurring_step=3表示每3个月重复一次，重复的时间依赖于 customized_recurring_days 字段。

customized_recurring_days

否

Integer

哪些天重复。

根据 customized_recurring_type 和 customized_recurring_step 的不同，该字段可取值与表达含义不同。如需选择多个日期，加和即可。

customized_recurring_type = 0时，传入该字段将被忽略。

详细请参见 自定义周期规则 API 调用示例。

live_subject

否

String

直播主题。长度最大128个字符。

live_summary

否

String

直播简介。长度最大400个字符。

enable_live_password

否

Boolean

是否开启直播密码，默认值为 false。

true：开启

false：不开启

live_password

否

String

直播密码。当设置开启直播密码时，该参数必填。4-6位数字。

enable_live_im

否

Boolean

允许观众讨论，默认值为 false。

true：开启

false：不开启

enable_live_replay

否

Boolean

开启直播回看，默认值为 false。

true：开启

false：不开启

live_watermark

否

LiveWatermark 对象

直播水印对象信息。

watermark_opt

否

Integer

水印选项，默认为0。

0：默认水印

1：无水印

area

是

String

电话区号。（例如：中国内地默认86）。

phone_number

是

String

手机号。

guest_name

否

String

嘉宾名称。

meeting_number

Integer

会议数量。

meeting_info_list

MeetingInfo 对象数组

预约会议列表。

subject

String

会议主题。

meeting_id

String

会议的唯一标识。

meeting_code

String

会议 App 的呼入号码。

password

String

会议密码。

hosts

User 对象数组

会议主持人的用户，如果无指定，主持人将被设定为上文的 userid，即 API 调用者，仅商业版和企业版可指定主持人。

participants

User 对象数组

邀请的参会者用户，仅商业版和企业版可邀请参会用户。

user_non_registered

String

邀请的参会者中未注册用户。

注意：仅腾讯会议商业版和企业版可获取该参数。

start_time

String

会议开始时间戳（单位秒），对于快速会议则为会议创建的时间。

end_time

String

会议结束时间戳（单位秒）。

join_url

String

加入会议 URL（单击链接直接加入会议）。

settings

Setting 对象

会议的配置，可为缺省配置。

enable_live

Boolean

是否开启直播。

live_config

LiveConfig 对象

直播配置对象，内部只返回 live_addr（直播观看地址）。

host_key

String

主持人密钥，仅支持6位数字。

如开启主持人密钥后没有填写此项，将自动分配一个6位数字的密钥。

参数名称

参数类型

参数描述

subject

String

会议主题。

meeting_id

String

会议的唯一标识。

meeting_code

String

会议 App 的呼入号码。

password

String

会议密码。

hosts

User 对象数组

会议主持人的用户，如果无指定，主持人将被设定为上文的 userid，即 API 调用者，仅商业版和企业版可指定主持人。

participants

User 对象数组

邀请的参会者用户，仅商业版和企业版可邀请参会用户。

user_non_registered

String

邀请的参会者中未注册用户。

注意：仅腾讯会议商业版和企业版可获取该参数。

start_time

String

会议开始时间戳（单位秒），对于快速会议则为会议创建的时间。

end_time

String

会议结束时间戳（单位秒）。

join_url

String

加入会议 URL（单击链接直接加入会议）。

settings

Setting 对象

会议的配置，可为缺省配置。

enable_live

Boolean

是否开启直播。

live_config

LiveConfig 对象

直播配置对象，内部只返回 live_addr（直播观看地址）。

host_key

String

主持人密钥，仅支持6位数字。

如开启主持人密钥后没有填写此项，将自动分配一个6位数字的密钥。