wecom-unified

企业微信套件 (WeCom Unified)

企业微信 CLI (wecom-cli) 全能套件，通过命令行工具与企业微信系统交互，覆盖 6 大业务域：通讯录、消息、文档（含文档/表格/智能表格/智能文档 4 种品类）、日程、会议、待办。

⚠️ 前置检查 — 使用任何命令前必须执行

Step 1: 检查 CLI 是否安装

wecom-cli --version

如果命令不存在或报错，执行安装：

npm install -g @wecom/cli@0.1.9

Step 2: 检查凭证是否配置

wecom-cli auth show --auth-status

• 输出 authorized → 已配置，可以继续使用
• 输出 unauthorized → 未配置，需要执行 Step 3

Step 3: 配置凭证（仅未授权时执行）

wecom-cli init --noninteractive

⚠️ 该命令会输出一个授权链接和二维码，并阻塞等待用户扫码完成验证。授权成功后命令会自动退出，仅需执行一次。

---

业务域概览

👤 通讯录 (contact)

获取可见范围成员列表、按姓名/别名搜索匹配、查询 userid。

→ 详见 references/wecom-contact.md

💬 消息 (msg)

会话列表查询、消息记录拉取（文本/图片/文件/语音/视频）、多媒体文件获取、文本消息发送。

→ 详见 references/wecom-msg.md

📄 文档 (doc)

文档（/doc/*，doc_type=3）创建 / 读取 / 编辑，统一以 Markdown 格式交互。支持通过 docid 或 URL 定位。

→ 详见 references/wecom-doc.md

📊 表格 / 在线表格 (sheet)

表格 / 在线表格（/sheet/*）的完整管理能力：新建空白表格、读取完整内容（Markdown 形式，异步轮询）、读取基础信息与子表列表、按区域修改单元格、末尾追加一行、增删子工作表。

→ 详见 references/wecom-sheet.md

📰 智能文档（智能主页） (smartpage)

智能文档（/smartpage/*，原名「智能主页」）创建（基于本地 Markdown 文件、支持多子页面）与内容导出（异步两步）。仅当用户明确提到「智能文档」或「智能主页」时触发。

→ 详见 references/wecom-smartpage.md

🧮 智能表格 (smartsheet)

智能表格（/smartsheet/*，doc_type=10）创建，子表 / 字段（列） / 记录的增删改查，支持带图片或文件的记录写入与更新；写入受限时支持 Webhook 兜底。

→ 详见 references/wecom-smartsheet.md

📅 日程 (schedule)

查询日程列表与详情、创建/修改/取消日程、添加/移除参与人、查询多成员闲忙状态并分析共同空闲时段。

→ 详见 references/wecom-schedule.md

🎥 会议 (meeting)

创建预约会议、查询会议列表与详情、取消会议、更新受邀成员。

→ 详见 references/wecom-meeting.md

✅ 待办 (todo)

创建/更新/删除待办、获取待办列表与详情、按姓名搜索用户并分派参与人、更改参与人在待办中的状态（拒绝/接受/已完成）、设置截止时间和多种提醒方式。

→ 详见 references/wecom-todo.md

---

公共概念与规则

所有业务域共享的通用调用格式、返回格式、错误处理、通讯录查询方法和时间格式规范。

→ 详见 references/wecom-shared.md

---

快速示例

查询通讯录成员

wecom-cli contact get_userlist '{}'

查看最近会话列表

wecom-cli msg get_msg_chat_list '{"begin_time": "2026-04-08 00:00:00", "end_time": "2026-04-15 23:59:59"}'

发送文本消息

wecom-cli msg send_message '{"chat_type": 1, "chatid": "zhangsan", "msgtype": "text", "text": {"content": "hello"}}'

创建文档

wecom-cli doc create_doc '{"doc_type": 3, "doc_name": "项目周报"}'

读取文档内容（Markdown 格式）

wecom-cli doc get_doc_content '{"docid": "DOCID", "type": 2}'

新建在线表格（空白）

wecom-cli doc create_doc '{"doc_type": 4, "doc_name": "项目排期表"}'

读取在线表格基础信息（含子表 sheet_id）

wecom-cli doc sheet_get_info '{"docid": "DOCID"}'

修改在线表格指定区域内容

wecom-cli doc sheet_update_range_data '{"docid": "DOCID", "sheet_id": "SHEET_ID", "grid_data": {"start_row": 0, "start_column": 0, "rows": [{"values": [{"cell_value": {"text": "完成需求文档"}, "cell_format": {}}, {"cell_value": {"text": "张三"}, "cell_format": {}}]}]}}'

在线表格末尾追加一行

wecom-cli doc sheet_append_data '{"docid": "DOCID", "sheet_id": "SHEET_ID", "row": {"values": [{"cell_value": {"text": "新任务"}, "cell_format": {}}, {"cell_value": {"text": "李四"}, "cell_format": {}}]}}'

添加子工作表

wecom-cli doc sheet_add_sub '{"docid": "DOCID", "sheet": {"title": "新子表", "row_count": 100, "column_count": 26}, "index": 0}'

删除子工作表

wecom-cli doc sheet_delete_sub '{"docid": "DOCID", "sheet_id": "SHEET_ID"}'

创建智能文档（智能主页）

⚠️ 特殊语法：此命令必须使用 +smartpage_create（带 + 前缀），加号不可省略；该 + 仅适用于此命令，不要泛化到其他 doc 子命令。

wecom-cli doc +smartpage_create '{"title": "项目概览", "pages": [{"page_title": "需求文档", "content_type": 1, "page_filepath": "/path/to/requirements.md"}]}'

导出智能文档内容

wecom-cli doc smartpage_export_task '{"docid": "DOCID", "content_type": 1}'

查询今天的日程

wecom-cli schedule get_schedule_list_by_range '{"start_time": "2026-04-15 00:00:00", "end_time": "2026-04-15 23:59:59"}'

创建预约会议

wecom-cli meeting create_meeting '{"title": "周例会", "meeting_start_datetime": "2026-04-16 15:00", "meeting_duration": 3600}'

查看待办列表

wecom-cli todo get_todo_list '{}'

创建待办

wecom-cli todo create_todo '{"content": "完成Q2规划文档", "follower_list": [{"follower_id": "zhangsan"}], "end_time": "2026-04-20 09:00:00", "remind_type_list": [4, 7]}'