该接口用于获取指定会议的详情内容。
请求方式: POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/meeting/get_info?access_token=ACCESS_TOKEN
请求包体:
{
"meetingid": "XXXXXXXXX"
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证。获取方法查看“获取access_token” |
meetingid | 是 | 会议id |
权限说明:
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"admin_userid": "zhangsan",
"title": "title",
"meeting_start": 1600000007,
"meeting_duration": 1800,
"description": "test meeting description",
"location":"广州媒体港",
"main_department": 1,
"status": 1,
"agentid": 1000014,
"attendees": {
"member": [{
"userid": "lisi",
"status": 1,
"first_join_time":166666666,
"last_quit_time": 166666666,
"total_join_count":5,
"cumulative_time":300
}, {
"userid": "zhangsan",
"status": 2,
"first_join_time":166666666,
"last_quit_time": 166666666,
"total_join_count":5,
"cumulative_time":300
}],
"tmp_external_user": [{
"tmp_external_userid": "woabc",
"status": 3,
"first_join_time":166666666,
"last_quit_time": 166666666,
"total_join_count":5,
"cumulative_time":300
}, {
"tmp_external_userid": "woefd",
"status": 4,
"first_join_time":166666666,
"last_quit_time": 166666666,
"total_join_count":5,
"cumulative_time":300
}]
},
"settings": {
"remind_scope": 4,
"password": "1234",
"enable_waiting_room": false,
"allow_enter_before_host": true,
"enable_enter_mute": true,
"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": [5, 10]
},
"meeting_code":"123456789",
"meeting_link":"https://wecomm.com/znigeot"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
admin_userid | 会议管理员的userId |
title | 会议的标题,最大60个字节 |
meeting_start | 会议开始时间的unix时间戳 |
meeting_duration | 会议时长 |
description | 会议的描述,最大600字节 |
location | 会议地点,最多128个字符 |
main_department | 发起人所在部门 |
status | 会议的状态,1:待开始,2:会议中,3:已结束,4:已取消,5:已过期 |
attendees | 会议成员。快速会议仅返回已参与成员列表。 |
attendees.member | 企业内部成员 |
attendees.member.userid | 企业内部成员的userid |
attendees.member.status | 与会状态。1为已参与,2为未参与。 |
attendees.member.first_join_time | 参会人首次加入会议时间的unix时间戳 |
attendees.member.last_quit_time | 参会人最后一次离开会议时间的unix时间戳 |
attendees.member.total_join_count | 参会人入会次数 |
attendees.member.cumulative_time | 参会人累计参会时长,单位为秒 |
attendees.tmp_external_user | 会中参会的外部联系人注意:微信入会的用户不会返回 |
attendees.tmp_external_user.tmp_external_userid | 会中入会的外部用户临时id。同一个用户在不同会议中返回的该id不一致。 可进一步通过tmp_external_userid的转换接口转换成external_userid,方便识别外部参会人身份。 |
attendees.tmp_external_user.status | 与会状态。1为已参与,2为未参与 |
attendees.tmp_external_user.first_join_time | 参会人首次进入会议时间的unix时间戳 |
attendees.tmp_external_user.last_quit_time | 参会人最后一次离开会议时间的unix时间戳 |
attendees.tmp_external_user.total_join_count | 参会人入会次数 |
attendees.tmp_external_user.cumulative_time | 参会人累计参会时长,单位为秒 |
settings | 会议配置,详见Settings |
reminders | 重复会议相关配置,详见Reminders |
meeting_code | 会议号 |
meeting_link | 入会链接 |
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 | 否 | 指定响铃的成员列表。 |
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为2时,即周期为周时,支持设置该字段,且值不能大于2。 |
remind_before | 否 | 指定会议开始前多久提醒成员,相对于meeting_start前的秒数,默认不提醒。目前仅支持 0:会议开始时提醒;300:5分钟前提醒;900:15分钟前提醒;3600:一小时前提醒;86400一天前提醒。若指定了非支持的值,则表现为会议开始时提醒 |