该接口用于获取指定会议的详情内容。
请求方式: POST(HTTPS)
请求地址: https://qyapi.weixin.qq.com/cgi-bin/meeting/get_info?access_token=ACCESS_TOKEN
请求包体:
{
"meetingid": "XXXXXXXXX",
"meeting_code":"meetingcodexxx"
}
参数说明:
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
access_token | 是 | string | 调用接口凭证。获取方法查看“获取access_token” |
meetingid | 否 | string | 会议id。注意:meetingid和meeting_code必须填一个 |
meeting_code | 否 | string | 入会码。注意:meetingid和meeting_code必须填一个 |
权限说明:
返回结果:
{
"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,
"meeting_type": 1,
"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,
"need_password": true,
"password": "1234",
"enable_waiting_room": false,
"allow_enter_before_host": true,
"enable_enter_mute": 1,
"enable_enter_mute_type": 2,
"allow_unmute_self": true,
"allow_external_user": false,
"enable_screen_watermark": false,
"watermark_type": 1,
"auto_record_type": "none",
"participant_join_auto_record": false,
"enable_host_pause_auto_record": false,
"enable_doc_upload_permission": true,
"enable_enroll": true,
"enable_host_key": true,
"host_key": "meetinghostkey",
"hosts": {
"userid": ["lisi", "wangwu"]
},
"current_hosts": {
"userid": ["wangwu", "lisi"]
},
"co_hosts": {
"userid": ["zhangsan", "lisi"]
},
"ring_users": {
"userid": ["zhangsan", "lis"]
}
},
"cal_id": "wcjgewCwAAqeJcPI1d8Pwbjt7nttzAAA",
"reminders": {
"is_repeat": 1,
"repeat_type": 0,
"repeat_until_type": 1,
"repeat_until_count": 10,
"repeat_until": 1606976813,
"repeat_interval": 1,
"is_custom_repeat": 1,
"repeat_day_of_week": [3, 7],
"repeat_day_of_month": [10, 21],
"remind_before": [0, 900]
},
"meeting_code": "123456789",
"meeting_link": "https://wecomm.com/znigeot",
"has_vote": true,
"has_more_sub_meeting": 1,
"remain_sub_meetings": 2,
"current_sub_meetingid": "cursubmeetingid",
"sub_meetings": [{
"sub_meetingid": "sub_meetingid",
"status": 0,
"start_time": 16888888888,
"end_time": 179888888888,
"title": "子会议标题",
"repeat_id": "123-cjig-gmeihue"
}],
"guests": [{
"area": "86",
"phone_number": "135123454321",
"guest_name": "lisi"
}],
"sub_repeat_list": [{
"repeat_id": "jmbioe-1249021-bmjg",
"repeat_type": 0,
"repeat_until_type": 1,
"repeat_until_count": 10,
"repeat_until": 1606976813,
"repeat_interval": 1,
"is_custom_repeat": 1,
"repeat_day_of_week": [3, 7],
"repeat_day_of_month": [10, 21]
}]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码 |
errmsg | string | 对返回码的文本描述内容 |
admin_userid | string | 会议管理员的userId |
title | string | 会议的标题,最大40个字节 |
meeting_start | uint32 | 会议开始时间的unix时间戳 |
meeting_duration | uint32 | 会议时长 |
description | string | 会议的描述,最大600字节 |
location | string | 会议地点,最多128个字符 |
main_department | uint32 | 发起人所在部门 |
status | uint32 | 会议的状态。 1:待开始 2:会议中 3:已结束 4:已取消 5:已过期 |
meeting_type | uint32 | 会议类型。 0:一次性会议 1:周期性会议 2:微信专属会议 3:Rooms 投屏会议 5:个人会议号会议 6:网络研讨会 |
attendees | object[] | 参会成员。 |
attendees.member | object | 企业内部成员 |
attendees.member.userid | string | 企业内部成员的userid |
attendees.member.status | uint32 | 与会状态。 1为已参与 2为未参与。 |
attendees.member.first_join_time | uint32 | 参会人首次加入会议时间的unix时间戳 |
attendees.member.last_quit_time | uint32 | 参会人最后一次离开会议时间的unix时间戳 |
attendees.member.total_join_count | uint32 | 参会人入会次数 |
attendees.member.cumulative_time | uint32 | 参会人累计参会时长,单位为秒 |
attendees.tmp_external_user | object | 会中参会的外部联系人注意:微信入会的用户不会返回 |
attendees.tmp_external_user.tmp_external_userid | string | 会中入会的外部用户临时id。同一个用户在不同会议中返回的该id不一致。 |
attendees.tmp_external_user.status | uint32 | 与会状态。 1为已参与 2为未参与 |
attendees.tmp_external_user.first_join_time | uint32 | 参会人首次进入会议时间的unix时间戳 |
attendees.tmp_external_user.last_quit_time | uint32 | 参会人最后一次离开会议时间的unix时间戳 |
attendees.tmp_external_user.total_join_count | uint32 | 参会人入会次数 |
attendees.tmp_external_user.cumulative_time | uint32 | 参会人累计参会时长,单位为秒 |
guests | object | 会议嘉宾列表,详见Guest |
settings | object | 会议配置,详见Settings |
reminders | object | 重复会议相关配置,详见Reminders |
meeting_code | string | 会议号 |
meeting_link | string | 入会链接 |
has_vote | bool | 是否有投票(会议创建人和主持人才有权限查询)。 |
sub_meetings | object | 周期性子会议列表,详见SubMeeting |
has_more_sub_meeting | uint32 | 是否还有更多子会议特例。 0:无更多 1:有更多子会议特例 |
remain_sub_meetings | uint32 | 剩余子会议场数 |
current_sub_meetingid | string | 当前子会议ID(进行中/即将开始) |
sub_repeat_list | object[] | 周期性会议分段信息。企业微信客户端可以对周期性会议中某一场子会议进行『修改此会议』和『修改此及后续会议』操作,修改之后会议可能会被分裂成不同的分段,每个分段有不同的重复规则,可以通过该字段获取所有的分段信息,详见SubRepeatInfo |
Guest说明:
参数 | 类型 | 说明 |
---|---|---|
area | string | 国家/地区代码(例如:中国传86,不是+86,也不是0086)。 |
phone_number | string | 手机号。 |
guest_name | string | 会议嘉宾姓名。 |
Settings说明:
参数 | 类型 | 说明 |
---|---|---|
password | bool | 入会密码 |
enable_waiting_room | bool | 是否开启等候室。 true:开启等候室 false:不开启等候室 |
allow_enter_before_host | bool | 是否允许成员在主持人进会前加入。 true:允许 false:不允许 |
remind_scope | uint32 | 会议开始时来电提醒方式。 1:不提醒 2:仅提醒主持人 3:提醒所有成员入 4:指定部分人响铃 |
enable_enter_mute | uint32 | 是否开启成员入会静音选项。 1:开启 0:关闭 2:超过6人后自动开启静音 |
allow_unmute_self | bool | 是否允许参会者取消静音。 true:允许 false:不允许 |
watermark_type | uint32 | 水印样式。 0:单排 1:多排 |
auto_record_type | string | 自动会议录制类型。 none:禁用,表示不开启自动会议录制 local:本地录制,表示主持人入会后自动开启本地录制 cloud:云录制,表示主持人入会后自动开启云录制 |
participant_join_auto_record | bool | 是否在有参会成员入会时立即开启云录制 |
enable_host_pause_auto_record | bool | 是否允许主持人暂停或者停止云录制 |
enable_doc_upload_permission | bool | 是否允许成员上传文档 |
enable_enroll | bool | 是否激活报名。 |
enable_host_key | bool | 是否开启主持人密钥。 true:开启 false:关闭 |
host_key | string | 主持人密钥。 |
allow_external_user | bool | 是否允许企业外部成员入会。 true:所有成员可入会 false:仅企业内部成员可入会 |
enable_screen_watermark | bool | 是否开启屏幕水印。 true:开启 false:不开启 |
hosts | object | 会议主持人人列表 |
hosts.userid | string[] | 主持人userid |
current_hosts | object | 会议当前主持人列表 |
current_host.userid | string[] | 当前主持人userid |
co_hosts | object | 联席主持人列表 |
co_hosts.userid | string[] | 联席主持人userid |
ring_users | object | 指定响铃的成员列表。 |
ring_users.userid | string[] | 指定响铃的成员userid |
Reminders说明:
参数 | 类型 | 说明 |
---|---|---|
is_repeat | uint32 | 是否是周期性会议。 1:周期性会议 0:非周期性会议 |
repeat_type | uint32 | 重复类型。 0 - 每日 1 - 每周 2 - 每月 7 - 工作日 |
is_custom_repeat | uint32 | 是否自定义重复设置。 0-否 1-是 |
repeat_interval | uint32 | 周期间隔 该字段随repeat_type不同而含义不同 例如: repeat_interval指定为3,repeat_type指定为每周重复,那么每3周重复一次; repeat_interval指定为3,repeat_type指定为每月重复,那么每3个月重复一次 |
repeat_day_of_week | uint32[] | 每周周几重复 取值范围:1 ~ 7,分别表示周一至周日 |
repeat_day_of_month | uint32[] | 每月哪几天重复 取值范围:1 ~ 31,分别表示1~31号 |
repeat_until_type | uint32 | 周期性会议结束类型。 0:按日期结束重复 1:按次数结束重复 |
repeat_until_count | uint32 | 周期会议限定次数 |
repeat_until | uint32 | 周期会议结束时刻。repeat_until_type=0时该字段才返回 |
remind_before | uint32[] | 会议开始前多久提醒成员,相对于meeting_start前的秒数。 0:会议开始时提醒 300:5分钟前提醒 900:15分钟前提醒 3600:一小时前提醒 86400:一天前提醒 |
SubMeeting:
参数 | 类型 | 说明 |
---|---|---|
sub_meetingid | string | 子会议 ID。 |
status | uint32 | 子会议状态。 0:默认(存在) 1:已删除 |
start_time | uint32 | 子会议开始时间(UTC 秒) |
end_time | uint32 | 子会议结束时间(UTC 秒) |
title | string | 子会议标题 |
repeat_id | string | 周期性会议分段ID,通过该字段可以关联子会议所属的分段 |
SubRepeatInfo:
参数 | 类型 | 说明 |
---|---|---|
repeat_id | string | 分段ID |
repeat_type | uint32 | 重复类型。 0 - 每日 1 - 每周 2 - 每月 7 - 工作日 |
is_custom_repeat | uint32 | 是否自定义重复设置。 0-否 1-是 |
repeat_interval | uint32 | 周期间隔 该字段随repeat_type不同而含义不同 例如: repeat_interval指定为3,repeat_type指定为每周重复,那么每3周重复一次; repeat_interval指定为3,repeat_type指定为每月重复,那么每3个月重复一次 |
repeat_day_of_week | uint32[] | 每周周几重复 取值范围:1 ~ 7,分别表示周一至周日 |
repeat_day_of_month | uint32[] | 每月哪几天重复 取值范围:1 ~ 31,分别表示1~31号 |
repeat_until_type | uint32 | 周期性会议结束类型。 0:按日期结束重复 1:按次数结束重复 |
repeat_until_count | uint32 | 分段的重复截止次数,repeat_until_type=1时返回 |
repeat_until | uint32 | 分段的重复截止时间,repeat_until_type=0时该字段才返回 |