该接口用于创建一个预约会议。
请求方式: 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"]
},
"settings": {
"remind_scope": 1,
"password": "1234",
"enable_waiting_room": false,
"allow_enter_before_host": true,
"enable_enter_mute": 1,
"allow_external_user": false,
"enable_screen_watermark": false,
"hosts": {
"userid": ["lisi", "wangwu"]
},
"ring_users": {
"userid": ["zhangsan", "lis"]
}
},
"cal_id": "wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA",
"reminders": {
"is_repeat": 1,
"repeat_type": 0,
"repeat_until": 1606976813,
"repeat_interval": 1,
"remind_before": [0, 900]
}
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证。获取方法查看“获取access_token” |
admin_userid | 是 | 会议管理员userid |
title | 是 | 会议的标题,最多支持40个字节或者20个utf8字符 |
meeting_start | 是 | 会议开始时间的unix时间戳。需大于当前时间 |
meeting_duration | 是 | 会议持续时间单位秒,最小300秒 |
description | 否 | 会议的描述,最多支持500个字节或者utf8字符 |
location | 否 | 会议地点,最多128个字符 |
agentid | 否 | 授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数 |
invitees | 否 | 邀请参会的成员。任何userid不合法或者不在应用可见范围,直接报错。参会人数上限不超过指定的「管理员」可预约的人数的上限,普通企业参会人员最多为100人;付费企业不超过企业选购的在线会议室容量,但最多为300人,超过300人请调用更新会议受邀成员列表接口。 |
invitees.userid | 否 | 参与会议的企业成员userid |
cal_id | 否 | 会议所属日历ID。该日历必须是access_token所对应应用所创建的日历。 注意,若参与人在日历分享范围内,则插入到该日历(同时会插入会议参与人的默认日历),若不在分享范围内,否则仅插入到参与者默认日历; 如果不填,那么插入到参与者的默认日历上。 第三方应用必须指定cal_id 不多于64字节 |
settings | 否 | 会议配置,详见Settings |
reminders | 否 | 重复会议相关配置,详见Reminders |
Settings说明:
参数 | 必须 | 说明 |
---|---|---|
password | 否 | 入会密码,仅可输入4-6位纯数字 |
enable_waiting_room | 否 | 是否开启等候室。true:开启等候室;false:不开启等候室;默认不开 |
allow_enter_before_host | 否 | 是否允许成员在主持人进会前加入。true:允许;false:不允许。默认允许 |
remind_scope | 否 | 会议开始时来电提醒方式,1.不提醒 2.仅提醒主持人 3.提醒所有成员入 4.指定部分人响铃。默认仅提醒主持人 |
enable_enter_mute | 否 | 成员入会时静音;1:开启;0:关闭;2:超过6人后自动开启静音。默认超过6人自动开启静音 |
allow_external_user | 否 | true:所有成员可入会;false:仅企业内部成员可入会 。默认所有成员可入会 |
enable_screen_watermark | 否 | 是否开启屏幕水印,true:开启;false:不开启。默认不开启 |
hosts | 否 | 会议主持人人列表,主持人员最多10个。若包含ceaater_userid,会自动过滤。任何userid不合法,直接报错。仅购买了高级功能的企业可以指定主持人。 |
hosts.userid | 否 | 企业成员userid |
ring_users | 否 | 指定响铃的成员列表。如果remind_scope为4,但是ring_users为空,则全部成员均不响铃。 |
ring_users.userid | 否 | 指定响铃的成员userid |
Reminders说明:
参数 | 必须 | 说明 |
---|---|---|
is_repeat | 否 | 是否是周期性会议,1:周期性会议 0:非周期性会议。默认为0 |
repeat_type | 否 | 周期性会议重复类型,0.每天;1.每周;2.每月;7.每个工作日。默认为0。周期性会议该字段才生效 |
repeat_until | 否 | 重复结束时刻。周期性会议该字段才生效。若会议结束时间超出最大结束时间或者未设置,则默认设置为最大结束时间。每天\每个工作日\每周 最多重复200次会议;每两周\每月最多重复50次会议 |
repeat_interval | 否 | 重复间隔。目前仅当repeat_type为1时,即周期为周时,支持设置该字段,且值不能大于2。 |
remind_before | 否 | 指定会议开始前多久提醒成员,相对于meeting_start前的秒数,默认不提醒。目前仅支持 0:会议开始时提醒;300:5分钟前提醒;900:15分钟前提醒;3600:一小时前提醒;86400一天前提醒。若指定了非支持的值,则表现为会议开始时提醒 |
权限说明:
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"meetingid": "XXXXXXXXX",
"excess_users":["zhangsan","lisi"]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
meetingid | 会议id,通过此id可调用“进入会议”接口(包括小程序接口和JS-SDK接口),以向参会人提供便捷入会入口 |
excess_users | 参会人中包含无效会议账号的userid,仅在购买会议专业版企业由于部分参会人无有效会议账号时返回 |
注:会议改为应用身份创建后,也允许指定之前应用创建的组织者身份的日历。