企业内部开发
基础
连接微信
办公
会议
会议统计管理
企业内部开发
服务端API
会议
预约会议高级管理
创建预约会议
创建预约会议
最后更新:2024/09/27

该接口用于创建一个预约会议。

请求方式: POST(HTTPS
请求地址: https://qyapi.weixin.qq.com/cgi-bin/meeting/create?access_token=ACCESS_TOKEN

请求包体:

{
	"admin_userid": "zhangsan",
	"title": "新建会议",
	"meeting_start": 1600000000,
	"meeting_duration": 3600,
	"description": "新建会议描述",
	"location":"广州媒体港",
	"agentid": 1000014,
	"invitees": {
		"userid": ["lisi", "wangwu"]
	},
	"guests":[{
		"area":"86",
		"phone_number":"135012938457",
		"guest_name":"fifa"
	}],
	"settings": {
		"password": "1234",
		"enable_waiting_room": false,
		"allow_enter_before_host": true,
		"enable_enter_mute": 1,
		"allow_unmute_self":true,
		"mute_all":false,
		"allow_external_user": false,
		"enable_screen_watermark": false,
		"watermark_type":1,
		"auto_record_type":"none",
		"attendee_join_auto_record":false,
		"enable_host_pause_auto_record":false,
		"enable_interpreter":true,
		"enable_enroll":true,
		"enable_host_key":true,
		"host_key":"meetinghostkey",
		"hosts": {
			"userid": ["lisi", "wangwu"]
		},
		"remind_scope":4,
		"ring_users":{
			"userid":["lisi"]
		}
	},
	"cal_id": "wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA",
	"reminders": {
		"is_repeat": 1,
		"repeat_type": 0,
		"is_custom_repeat":1,
		"repeat_until_type":1,
		"repeat_until_count":10,
		"repeat_until": 1606976813,
		"repeat_interval": 1,
		"repeat_day_of_week": [3, 7],
		"repeat_day_of_month": [10, 21],
		"remind_before": [0, 900]
	}
}

参数说明:

参数必须类型说明
access_tokenstring调用接口凭证。获取方法查看“获取access_token
admin_useridstring会议管理员userid
titlestring会议的标题(1~255位字符长度)
meeting_startuint32会议开始时间的unix时间戳,需大于当前时间
meeting_durationuint32会议持续时间单位秒,最小300秒
descriptionstring会议的描述,最多支持500个字节或者utf8字符
locationstring会议地点。最长支持18个汉字或36个英文字母。
agentiduint32授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数
inviteesobject邀请参与会议的成员。人数上限以指定的「管理员」可预约的人数上限来校验:
普通企业与会人员最多100
付费企业根据企业选购的在线会议室容量,但最多不能超过300人,若超过300人请调用更新会议受邀成员列表接口
注意:
任何userid不合法或者不在应用可见范围,直接报错。
invitees.useridstring[]参与会议的企业成员userid
guestsobject[]会议嘉宾列表,详见Guest
cal_idstring会议所属日历ID。该日历必须是access_token所对应应用所创建的日历。
注意,若参与人在日历分享范围内,则插入到该日历(同时会插入会议参与人的默认日历),若不在分享范围内,否则仅插入到参与者默认日历;
如果不填,那么插入到参与者的默认日历上。
第三方应用必须指定cal_id
不多于64字节
settingsobject会议配置,详见Settings
remindersobject周期性相关配置,详见Reminders

Guest说明

参数必须类型说明
areastring国家/地区代码(例如:中国传86,不是+86,也不是0086)
phone_numberstring手机号
guest_namestring会议嘉宾姓名(1~16位字符长度)

Settings说明:

参数必须类型说明
passwordstring入会密码,仅可输入4-6位纯数字
enable_waiting_roombool是否开启等候室。
true:开启等候室
false:不开启等候室
默认不开
allow_enter_before_hostbool是否允许成员在主持人进会前加入。
true:允许
false:不允许
默认允许
enable_enter_muteuint32成员入会时静音设置。
1:开启
0:关闭
2:超过6人后自动开启静音
默认超过6人自动开启静音
allow_unmute_selfbool允许参会者取消静音。
true:允许
false:不允许
默认允许
mute_allbool是否设置全体静音。该字段单独使用不生效,当设置allow_unmute_self为false时,需要指定mute_all=true
watermark_typeuint32水印样式。当屏幕共享水印参数为开启时,此参数才生效。
0:单排
1:多排
默认为单排
auto_record_typestring自动会议录制类型。
none:禁用,表示不开启自动会议录制
local:本地录制,表示主持人入会后自动开启本地录制
cloud:云录制,表示主持人入会后自动开启云录制。
说明:该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。
attendee_join_auto_recordbool是否当有参会成员入会时立即开启云录制。
false:关闭,主持人入会自动开启云录制
true:开启,有参会成员入会自动开启云录制
默认为关闭
说明:该参数必须 auto_record_type 设置为“cloud”时才能配置,该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。
enable_host_pause_auto_recordbool是否允许主持人暂停或者停止云录制。
true:开启,主持人允许暂停和停止云录制
false:不允许,主持人不允许暂停和关闭云录制
默认为允许
说明:该参数必须 auto_record_type 设置为“cloud”时才能配置,该参数依赖企业账户设置,当企业强制锁定后,该参数必须与企业配置保持一致。
enable_interpreterbool同声传译开关。
false:不开启
true:开启同声传译
默认为不开启
enable_enrollbool是否激活报名
enable_host_keybool是否开启主持人密钥。
true:开启
false:关闭
默认为不开启
host_keystring主持人密钥,仅支持6位数字。如开启主持人密钥后没有填写此项,将自动分配一个6位数字的密钥。
allow_external_userbool是否允许外部成员入会。
true:所有成员可入会
false:仅企业内部成员可入会
默认所有成员可入会
enable_screen_watermarkbool是否开启屏幕水印。
true:开启
false:不开启
默认不开启
hostsobject会议主持人列表,最多10个。若包含admin_userid,会自动过滤。任何userid不合法,直接报错。仅购买了高级功能的企业可以指定主持人。
hosts.useridstring[]企业成员userid
remind_scopeuint32会议开始时来电提醒方式,1.不提醒 2.仅提醒主持人 3.提醒所有成员入 4.指定部分人响铃。默认仅提醒主持人
ring_usersobject指定响铃的成员列表。如果remind_scope为4,但是ring_users为空,则全部成员均不响铃。
ring_users.useridstring[]指定响铃的成员userid

Reminders说明:

参数必须类型说明
is_repeatuint32是否是周期性会议。
1:周期性会议
0:非周期性会议
默认为0
repeat_typeuint32周期性会议类型,当is_repeat为1时有效。目前支持如下类型:
0 - 每日
1 - 每周
2 - 每月
7 - 工作日
当指定为自定义重复时,仅能选择按每日、每周或者每月重复
is_custom_repeatuint32是否自定义重复设置,当is_repeat=1时生效。
0-否
1-是
repeat_intervaluint32重复间隔
当指定为自定义重复时必填
该字段随repeat_type不同而含义不同
例如:
repeat_interval指定为3,repeat_type指定为每周重复,那么每3周重复一次;
repeat_interval指定为3,repeat_type指定为每月重复,那么每3个月重复一次
repeat_day_of_weekuint32[]每周周几重复
仅当指定为自定义重复且重复类型为每周时有效
取值范围:1 ~ 7,分别表示周一至周日。
注意:自定义按周重复时,会议开始时间对应的那天需要包含在该数组中。例如:开始时间是周一,则该数组需要包含1,如果开发者没有指定,后台会补上
repeat_day_of_monthuint32[]每月哪几天重复
仅当指定为自定义重复且重复类型为每月时有效
取值范围:1 ~ 31,分别表示1~31号。
注意:自定义按月重复时,会议开始时间对应的那天需要包含在该数组中。例如:开始时间是某月1号,则该数组需要包含1,如果开发者没有指定,后台会补上
repeat_until_typeuint32[]结束重复类型。
0:按日期结束重复
1:按次数结束重复
默认为0
repeat_until_countuint32周期会议限定次数。
说明:
每天、每个工作日、每周最大支持200场子会议
每月最大支持50场子会议
如未填写,则默认为7次
repeat_untiluint32周期会议结束时刻。repeat_until_type=0时该字段才生效。。每天\每个工作日\每周 最多重复200次会议;每月最多重复50次会议。
如未填写,默认为当前日期往后推7天
remind_beforeuint32指定会议开始前多久提醒成员,相对于meeting_start前的秒数。目前仅支持
0:会议开始时提醒
300:5分钟前提醒
900:15分钟前提醒
3600:一小时前提醒
86400:一天前提醒。
默认不提醒,若指定了非支持的值,则表现为会议开始时提醒

权限说明:

  • 发起人和企业内部参与人必须在应用可见范围内,「会议」应用默认全员可见
  • 自建应用需要配置在“可调用接口的应用”列表

返回结果:

{
   "errcode": 0,
   "errmsg": "ok",
   "meetingid": "XXXXXXXXX",
   "excess_users":["zhangsan","lisi"],
   "meeting_code":"meeting_code",
   "meeting_link":"https://meeting.com/jige"
}

参数说明:

参数类型说明
errcodeint32返回码
errmsgstring对返回码的文本描述内容
meetingidstring会议id,通过此id可调用“进入会议”接口(包括小程序接口JS-SDK接口),以向参会人提供便捷入会入口
excess_usersstring参会人中包含无效会议账号的userid,仅在购买会议专业版企业由于部分参会人无有效会议账号时返回
meeting_codestring会议的会议号
meeting_linkstring入会链接
注:会议改为应用身份创建后,也允许指定之前应用创建的组织者身份的日历。
上一篇获取会议发起记录
下一篇修改预约会议
    本节内容
服务端API
基础
连接微信
办公
会议
会议统计管理
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们