Loading...
Loading...
Compare original and translation side by side
是企业微信提供的命令行程序,所有操作通过执行wecom-cli命令完成。wecom-cli
is a command line program provided by WeCom, all operations are completed by executing thewecom-clicommand.wecom-cli
wecom-cli meeting <tool_name> '<json_params>'wecom-cli meeting <tool_name> '<json_params>'wecom-cli meeting list_user_meetings '{"begin_datetime": "2026-03-01 00:00", "end_datetime": "2026-03-31 23:59", "limit": 100}'wecom-cli meeting list_user_meetings '{"begin_datetime": "2026-03-01 00:00", "end_datetime": "2026-03-31 23:59", "limit": 100}'| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | 否 | 查询起始时间, 格式: |
| string | 否 | 查询结束时间, 格式: |
| string | 否 | 分页游标, 用于获取下一页数据 |
| integer | 否 | 每页返回条数, 最大 100 |
限制: 时间范围仅支持当日及前后 30 天.
| Parameter | Type | Required | Description |
|---|---|---|---|
| string | No | Query start time, format: |
| string | No | Query end time, format: |
| string | No | Pagination cursor, used to get the next page of data |
| integer | No | Number of entries returned per page, maximum 100 |
Limit: The time range only supports the current day and 30 days before and after.
{
"errcode": 0,
"errmsg": "ok",
"next_cursor": "分页游标字符串, 为空表示无更多",
"meetingid_list": ["会议ID_1", "会议ID_2"]
}| 字段 | 类型 | 说明 |
|---|---|---|
| array | 会议 ID 列表 |
| string | 下一页游标, 为空表示无更多数据 |
{
"errcode": 0,
"errmsg": "ok",
"next_cursor": "分页游标字符串, 为空表示无更多",
"meetingid_list": ["会议ID_1", "会议ID_2"]
}| Field | Type | Description |
|---|---|---|
| array | Meeting ID list |
| string | Next page cursor, empty means no more data |
wecom-cli meeting get_meeting_info '{"meetingid": "<会议id>"}'wecom-cli meeting get_meeting_info '{"meetingid": "<会议id>"}'| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| string | 是 | 会议 ID, 通过 |
| string | 否 | 会议号码 |
| string | 否 | 子会议 ID |
| Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | Meeting ID, obtained via |
| string | No | Meeting number |
| string | No | Sub-meeting ID |
{
"errcode": 0,
"errmsg": "ok",
"creator_userid": "创建者userid",
"admin_userid": "会议管理userid (与 creator_userid 有且仅返回一个)",
"title": "会议标题",
"meeting_start_datetime": "YYYY-MM-DD HH:mm",
"meeting_duration": 会议时长秒数,
"description": "会议描述文本",
"location": "会议地点文本",
"main_department": 创建者主部门ID,
"status": 会议状态枚举值,
"meeting_type": 会议类型枚举值,
"attendees": {
"member": [
{
"userid": "内部成员userid",
"status": 与会状态枚举值,
"first_join_datetime": "YYYY-MM-DD HH:mm",
"last_quit_datetime": "YYYY-MM-DD HH:mm",
"total_join_count": 加入次数,
"cumulative_time": 累计在会时长秒数
}
],
"tmp_external_user": [
{
"tmp_external_userid": "外部临时用户ID",
"status": 与会状态枚举值,
"first_join_datetime": "YYYY-MM-DD HH:mm",
"last_quit_datetime": "YYYY-MM-DD HH:mm",
"total_join_count": 加入次数,
"cumulative_time": 累计在会时长秒数
}
]
},
"settings": {
"remind_scope": 提醒范围枚举值,
"need_password": 是否需要密码布尔值,
"password": "会议密码",
"enable_waiting_room": 是否启用等候室布尔值,
"allow_enter_before_host": 是否允许提前入会布尔值,
"enable_enter_mute": 入会静音枚举值,
"allow_unmute_self": 是否允许自我解除静音布尔值,
"allow_external_user": 是否允许外部用户布尔值,
"enable_screen_watermark": 是否开启水印布尔值,
"watermark_type": 水印类型枚举值,
"auto_record_type": "录制类型枚举字符串",
"attendee_join_auto_record": 参会者加入自动录制布尔值,
"enable_host_pause_auto_record": 主持人可暂停录制布尔值,
"enable_doc_upload_permission": 允许上传文档布尔值,
"enable_enroll": 是否开启报名布尔值,
"enable_host_key": 是否启用主持人密钥布尔值,
"host_key": "主持人密钥字符串",
"hosts": {"userid": ["主持人userid列表"]},
"current_hosts": {"userid": ["当前主持人userid列表"]},
"co_hosts": {"userid": ["联席主持人userid列表"]},
"ring_users": {"userid": ["响铃用户userid列表"]}
},
"meeting_code": "会议号码字符串",
"meeting_link": "会议链接URL",
"has_vote": 是否有投票布尔值,
"has_more_sub_meeting": 是否有更多子会议枚举值,
"remain_sub_meetings": 剩余子会议场数,
"current_sub_meetingid": "当前子会议ID",
"guests": [
{
"area": "国际区号",
"phone_number": "手机号字符串",
"guest_name": "嘉宾姓名"
}
],
"reminders": {
"is_repeat": 是否周期性枚举值,
"repeat_type": 重复类型枚举值,
"repeat_until_type": 结束类型枚举值,
"repeat_until_count": 限定次数,
"repeat_until_datetime": "YYYY-MM-DD HH:mm",
"repeat_interval": 重复间隔数值,
"is_custom_repeat": 是否自定义重复枚举值,
"repeat_day_of_week": [星期几数组],
"repeat_day_of_month": [日期数组],
"remind_before": [提醒秒数数组]
},
"sub_meetings": [
{
"sub_meetingid": "子会议ID",
"status": 子会议状态枚举值,
"start_datetime": "YYYY-MM-DD HH:mm",
"end_datetime": "YYYY-MM-DD HH:mm",
"title": "子会议标题",
"repeat_id": "周期性会议分段ID"
}
],
"sub_repeat_list": [
{
"repeat_id": "周期性会议分段ID",
"repeat_type": 重复类型枚举值,
"repeat_until_type": 结束类型枚举值,
"repeat_until_count": 限定次数,
"repeat_until_datetime": "YYYY-MM-DD HH:mm",
"repeat_interval": 重复间隔数值,
"is_custom_repeat": 是否自定义重复枚举值,
"repeat_day_of_week": [星期几数组],
"repeat_day_of_month": [日期数组]
}
]
}| 字段 | 类型 | 说明 |
|---|---|---|
| string | 创建者 userid, 与 |
| string | 会议管理 userid, 与 |
| string | 会议标题 |
| string | 会议开始时间 |
| integer | 会议时长 (秒) |
| integer | 创建者所属主部门 |
| integer | 会议状态 (1: 待开始, 2: 会议中, 3: 已结束, 4: 已取消, 5: 已过期) |
| integer | 会议类型 (0: 一次性会议, 1: 周期性会议, 2: 微信专属会议, 3: Rooms 投屏会议, 5: 个人会议号会议, 6: 网络研讨会) |
| string | 会议号码 |
| string | 会议链接 |
| array | 内部参与者列表 |
| integer | 与会状态 (1: 已参与, 2: 未参与) |
| array | 外部参与者 (临时 ID) |
| integer | 与会状态 (1: 已参与, 2: 未参与) |
| array | 外部嘉宾列表, 每项含 |
| string | 当前子会议 ID |
| object | 响铃用户列表 |
| boolean | 是否需要密码 (只读字段) |
| boolean | 是否允许成员上传文档 |
| object | 主持人列表 |
| object | 当前主持人列表 |
| object | 联席主持人列表 |
| object | 周期性配置 |
| boolean | 是否有投票 (仅会议创建人和主持人有权限查询) |
| integer | 是否还有更多子会议特例 (0: 无更多, 1: 有更多) |
| integer | 剩余子会议场数 |
| array | 子会议列表 |
| integer | 子会议状态 (0: 默认/存在, 1: 已删除) |
| string | 周期性会议分段 ID, 用于关联子会议所属分段 |
| array | 周期性会议分段信息, 修改周期性会议某一场后可能产生不同分段, 各分段有不同重复规则 |
{
"errcode": 0,
"errmsg": "ok",
"creator_userid": "创建者userid",
"admin_userid": "会议管理userid (与 creator_userid 有且仅返回一个)",
"title": "会议标题",
"meeting_start_datetime": "YYYY-MM-DD HH:mm",
"meeting_duration": 会议时长秒数,
"description": "会议描述文本",
"location": "会议地点文本",
"main_department": 创建者主部门ID,
"status": 会议状态枚举值,
"meeting_type": 会议类型枚举值,
"attendees": {
"member": [
{
"userid": "内部成员userid",
"status": 与会状态枚举值,
"first_join_datetime": "YYYY-MM-DD HH:mm",
"last_quit_datetime": "YYYY-MM-DD HH:mm",
"total_join_count": 加入次数,
"cumulative_time": 累计在会时长秒数
}
],
"tmp_external_user": [
{
"tmp_external_userid": "外部临时用户ID",
"status": 与会状态枚举值,
"first_join_datetime": "YYYY-MM-DD HH:mm",
"last_quit_datetime": "YYYY-MM-DD HH:mm",
"total_join_count": 加入次数,
"cumulative_time": 累计在会时长秒数
}
]
},
"settings": {
"remind_scope": 提醒范围枚举值,
"need_password": 是否需要密码布尔值,
"password": "会议密码",
"enable_waiting_room": 是否启用等候室布尔值,
"allow_enter_before_host": 是否允许提前入会布尔值,
"enable_enter_mute": 入会静音枚举值,
"allow_unmute_self": 是否允许自我解除静音布尔值,
"allow_external_user": 是否允许外部用户布尔值,
"enable_screen_watermark": 是否开启水印布尔值,
"watermark_type": 水印类型枚举值,
"auto_record_type": "录制类型枚举字符串",
"attendee_join_auto_record": 参会者加入自动录制布尔值,
"enable_host_pause_auto_record": 主持人可暂停录制布尔值,
"enable_doc_upload_permission": 允许上传文档布尔值,
"enable_enroll": 是否开启报名布尔值,
"enable_host_key": 是否启用主持人密钥布尔值,
"host_key": "主持人密钥字符串",
"hosts": {"userid": ["主持人userid列表"]},
"current_hosts": {"userid": ["当前主持人userid列表"]},
"co_hosts": {"userid": ["联席主持人userid列表"]},
"ring_users": {"userid": ["响铃用户userid列表"]}
},
"meeting_code": "会议号码字符串",
"meeting_link": "会议链接URL",
"has_vote": 是否有投票布尔值,
"has_more_sub_meeting": 是否有更多子会议枚举值,
"remain_sub_meetings": 剩余子会议场数,
"current_sub_meetingid": "当前子会议ID",
"guests": [
{
"area": "国际区号",
"phone_number": "手机号字符串",
"guest_name": "嘉宾姓名"
}
],
"reminders": {
"is_repeat": 是否周期性枚举值,
"repeat_type": 重复类型枚举值,
"repeat_until_type": 结束类型枚举值,
"repeat_until_count": 限定次数,
"repeat_until_datetime": "YYYY-MM-DD HH:mm",
"repeat_interval": 重复间隔数值,
"is_custom_repeat": 是否自定义重复枚举值,
"repeat_day_of_week": [星期几数组],
"repeat_day_of_month": [日期数组],
"remind_before": [提醒秒数数组]
},
"sub_meetings": [
{
"sub_meetingid": "子会议ID",
"status": 子会议状态枚举值,
"start_datetime": "YYYY-MM-DD HH:mm",
"end_datetime": "YYYY-MM-DD HH:mm",
"title": "子会议标题",
"repeat_id": "周期性会议分段ID"
}
],
"sub_repeat_list": [
{
"repeat_id": "周期性会议分段ID",
"repeat_type": 重复类型枚举值,
"repeat_until_type": 结束类型枚举值,
"repeat_until_count": 限定次数,
"repeat_until_datetime": "YYYY-MM-DD HH:mm",
"repeat_interval": 重复间隔数值,
"is_custom_repeat": 是否自定义重复枚举值,
"repeat_day_of_week": [星期几数组],
"repeat_day_of_month": [日期数组]
}
]
}| Field | Type | Description |
|---|---|---|
| string | Creator userid, only one of |
| string | Meeting admin userid, only one of |
| string | Meeting title |
| string | Meeting start time |
| integer | Meeting duration (seconds) |
| integer | Main department of the creator |
| integer | Meeting status (1: To be started, 2: In progress, 3: Ended, 4: Cancelled, 5: Expired) |
| integer | Meeting type (0: One-time meeting, 1: Recurring meeting, 2: WeChat exclusive meeting, 3: Rooms screencast meeting, 5: Personal meeting number meeting, 6: Webinar) |
| string | Meeting number |
| string | Meeting link |
| array | List of internal participants |
| integer | Participation status (1: Participated, 2: Not participated) |
| array | External participants (temporary ID) |
| integer | Participation status (1: Participated, 2: Not participated) |
| array | List of external guests, each item contains |
| string | Current sub-meeting ID |
| object | List of ringing users |
| boolean | Whether password is required (read-only field) |
| boolean | Whether members are allowed to upload documents |
| object | List of hosts |
| object | List of current hosts |
| object | List of co-hosts |
| object | Recurring configuration |
| boolean | Whether there is a vote (only the meeting creator and host have permission to query) |
| integer | Whether there are more sub-meeting exceptions (0: No more, 1: More available) |
| integer | Remaining number of sub-meetings |
| array | List of sub-meetings |
| integer | Sub-meeting status (0: Default/exists, 1: Deleted) |
| string | Recurring meeting segment ID, used to associate the segment to which the sub-meeting belongs |
| array | Recurring meeting segment information, modifying a single session of a recurring meeting may generate different segments, each with different recurrence rules |
wecom-cli meeting list_user_meetings '{"begin_datetime": "2026-03-16 00:00", "end_datetime": "2026-03-22 23:59", "limit": 100}'wecom-cli meeting get_meeting_info '{"meetingid": "<会议id1>"}'wecom-cli meeting get_meeting_info '{"meetingid": "<会议id2>"}'📋 本周会议列表 (共 3 场):
1. 📅 技术方案评审
🕐 2026-03-17 10:00 - 11:00
👥 张三, 李四, 王五
2. 📅 产品需求沟通
🕐 2026-03-18 14:00 - 15:00
👥 赵六, 钱七
3. 📅 周五周会
🕐 2026-03-21 09:00 - 10:00
👥 全组成员分页处理: 如果不为空, 使用next_cursor参数继续拉取下一页.cursor
wecom-cli meeting list_user_meetings '{"begin_datetime": "2026-03-16 00:00", "end_datetime": "2026-03-22 23:59", "limit": 100}'wecom-cli meeting get_meeting_info '{"meetingid": "<会议id1>"}'wecom-cli meeting get_meeting_info '{"meetingid": "<会议id2>"}'📋 本周会议列表 (共 3 场):
1. 📅 技术方案评审
🕐 2026-03-17 10:00 - 11:00
👥 张三, 李四, 王五
2. 📅 产品需求沟通
🕐 2026-03-18 14:00 - 15:00
👥 赵六, 钱七
3. 📅 周五周会
🕐 2026-03-21 09:00 - 10:00
👥 全组成员Pagination processing: Ifis not empty, use thenext_cursorparameter to continue pulling the next page.cursor
wecom-cli meeting get_meeting_info '{"meetingid": "<target_meetingid>"}'📅 <会议标题>
🕐 时间: <开始时间>, 时长 <时长>
📍 地点: <会议地点>
📝 描述: <会议描述>
👤 创建者: <创建者姓名>
👥 参与者: <参与者姓名列表>
🔗 会议链接: <会议链接>wecom-cli meeting get_meeting_info '{"meetingid": "<target_meetingid>"}'📅 <会议标题>
🕐 时间: <开始时间>, 时长 <时长>
📍 地点: <会议地点>
📝 描述: <会议描述>
👤 创建者: <创建者姓名>
👥 参与者: <参与者姓名列表>
🔗 会议链接: <会议链接>wecom-cli meeting list_user_meetings '{"begin_datetime": "2026-02-15 00:00", "end_datetime": "2026-04-16 23:59", "limit": 100}'✅ 找到会议: "<会议标题>"
📅 时间: <开始时间>, 时长 <时长>
📍 地点: <会议地点>
👥 参与者: <参与者姓名列表>
🔗 会议链接: <会议链接>wecom-cli meeting list_user_meetings '{"begin_datetime": "2026-02-15 00:00", "end_datetime": "2026-04-16 23:59", "limit": 100}'✅ 找到会议: "<会议标题>"
📅 时间: <开始时间>, 时长 <时长>
📍 地点: <会议地点>
👥 参与者: <参与者姓名列表>
🔗 会议链接: <会议链接>YYYY-MM-DD HH:mmlist_user_meetingsget_meeting_infoYYYY-MM-DD HH:mmlist_user_meetingsget_meeting_info