wx-cli REST API 完整参考:用 8 个端点搭建你的本地微信数据服务
发布时间:2026/10/23 10:31:52 锦皓数字建站

【免费下载链接】wx-cliWeChat macOS database decryption and query tool项目地址https://gitcode.com/gh_mirrors/wxcl/wx-cli点击查看免费下载wx-cli 是一个运行在 macOS 上的微信数据库解密与查询工具它的wx-cli server run命令可以把本机微信数据变成一个标准的本地 REST API 服务默认监听127.0.0.1:9100提供 8 个/api/v1/*端点覆盖会话、联系人、消息、时间线、媒体、全文搜索和 SSE 实时订阅。数据不出本机个人助理、自动化脚本和多个 Agent 都能共享同一个服务实例。1 分钟启动最快配置方法前提是已经完成密钥提取和解密wx-cli key extractwx-cli decrypt。启动服务只需一条命令wx-cli server run常用参数参数默认值说明--host127.0.0.1监听地址--port9100监听端口--token无Bearer 令牌绑定非 loopback 地址时必填--poll-ms2000轮询间隔毫秒远程访问示例wx-cli server run --host 0.0.0.0 --token mysecret wx-cli server status # 查看状态 wx-cli server stop # 停止服务⚠️ 安全提示--host不是 loopback 地址而不带--token时服务会直接拒绝启动见 serve/mod.rs。8 个端点速查表路由定义集中在 routes.rs全部为 GET 请求#端点用途必填参数1/api/v1/health健康检查与服务状态—2/api/v1/sessions会话列表最近聊天—3/api/v1/contacts联系人列表与搜索—4/api/v1/messages单会话消息查询contact5/api/v1/timeline跨会话时间线since、until6/api/v1/media媒体文件图/音/视频/文件server_id、talker7/api/v1/search全文关键词搜索q8/api/v1/eventsSSE 实时事件流—统一响应结构与鉴权所有 JSON 查询端点返回同一套信封结构定义见 output.rs{ items: [ ... ], paging: { limit: 20, offset: 0, returned: 20, has_more: true, total: 342 }, stats: { scanned: 500, skipped: 0, elapsed_ms: 12 } }limit默认 20可用limit/offset翻页大多数列表端点支持orderasc|desc默认desc和show_hidden1忽略联系人隐藏规则。鉴权配置了--token后所有请求需携带Authorization: Bearer token头否则返回 401实现见 auth.rs。本机不带 token 启动时无需鉴权。逐个端点详解1. GET /api/v1/health — 健康检查curl http://127.0.0.1:9100/api/v1/health返回ready服务是否就绪、worker_id、cli_version和current_account当前账号 wxid 与昵称。readyfalse表示桥接层仍在初始化SSE 端点此时会返回 503。2. GET /api/v1/sessions — 会话列表curl http://127.0.0.1:9100/api/v1/sessions?limit10返回最近会话含summary最后一条消息摘要、last_msg_type、sort_timestamp等字段本地数据库有记录时还会带上avatar_url头像。参数limit、offset、order、show_hidden。3. GET /api/v1/contacts — 联系人搜索curl http://127.0.0.1:9100/api/v1/contacts?search张三limit10search参数支持按昵称、备注等模糊过滤返回 wxid、显示名、头像等信息实现见 handlers.rs。4. GET /api/v1/messages — 单会话消息查询最灵活的端点contact支持传 wxid、昵称或备注名自动解析curl http://127.0.0.1:9100/api/v1/messages?contact张三limit20typetext参数分两类不可混用时间范围模式since/untilUnix 秒、type消息类型、offset翻页锚点模式三选一 ——around_sort_seq、around_server_id、after_sort_seq其中around_*可搭配contextN表示锚点消息前后各取 N 条。约束违反会返回 400三个锚点参数互斥锚点模式不能与since/until同时使用锚点模式下offset必须为 0。5. GET /api/v1/timeline — 跨会话时间线一次请求读取时间范围内所有会话的消息是 Agent 记忆补全、日报生成、归档批处理的关键端点避免逐会话调用实现见 handlers.rscurl http://127.0.0.1:9100/api/v1/timeline?since1750000000until1750086400limit100要求since和until同时提供且since until返回的每条消息带有talker、talker_display_name、directioninbound/outgoing和snippet摘要可按order与type过滤、limit/offset翻页。6. GET /api/v1/media — 媒体文件下载按消息定位取回图片、语音、视频或文件实现见 media.rs# 语音转成 mp3 curl -o voice.mp3 http://127.0.0.1:9100/api/v1/media?server_id123456talker张三formatmp3 # 图片 curl -o img.jpg http://127.0.0.1:9100/api/v1/media?server_id123456talker张三server_id与talker均必填值可从 messages 查询结果中直接取format仅语音有效ogg默认或mp3需本机安装 ffmpeg图片响应带X-Wechat-Media-Quality: full|thumbnail头标明返回的是完整图还是缩略图服务始终优先返回本机已下载的高清原图。7. GET /api/v1/search — 全文搜索curl http://127.0.0.1:9100/api/v1/search?q周末爬山limit20优先走独立连接的 SQLite FTS 全文索引不阻塞主库查询失败时自动降级为逐会话扫描实现见 handlers.rs。stats.elapsed_ms字段可用于观察两种路径的性能差异。8. GET /api/v1/events — SSE 实时订阅长连接持续推送新消息事件类型定义见 event.rscurl -N http://127.0.0.1:9100/api/v1/events事件类型含义message某会话有新消息含talker、消息数组和anchor_sort_seqsession会话状态变化最后一条消息、未读数等heartbeat心跳保活30 秒一次连接在服务未就绪时返回 503客户端断线后重连即可服务端通过增量游标补齐事件。错误处理HTTP 状态码对照错误统一以{error: ...}返回映射关系定义在 error.rs状态码场景示例400 Bad Request缺少必填参数如missing required parameter: contact、参数互斥冲突401 Unauthorized未携带或错误的 Bearer token404 Not Found找不到媒体消息或文件501 Unsupported Media该消息类型不支持媒体下载502 Bad Gateway上游媒体处理失败503 Service UnavailableSSE 桥接层尚未初始化完成500 Internal Server Error数据库或内部错误三个实用组合场景给 Agent 建长期记忆定时用/timeline拉取过去一小时的跨会话消息 → 汇总生成日报/待办关键词触发工作流常驻连接/events收到message事件后匹配关键词命中则触发提醒聊天知识库前端/search提供搜索框/messages提供会话视图/media直接出图出语音无需导出。 提示wx-cli的查询命令sessions、query、search等检测到本机server run在跑时会自动复用 REST API可用--no-server强制本地查询、--server-only强制走服务。延伸阅读路由与中间件routes.rs各端点处理逻辑handlers.rs服务启动流程mod.rs服务端参数定义--token、--poll-ms等server/types.rs服务运行时状态上报server/manager.rs实时消息监控模块wx-monitor至此8 个端点就构成了一整套完整的本地微信数据服务历史数据靠sessions/contacts/messages/search/media批量处理靠timeline实时能力靠eventshealth兜底监控。一条wx-cli server run启动后你的自动化程序就可以像访问任何标准 API 一样访问自己的微信数据了。赞分享【免费下载链接】wx-cliWeChat macOS database decryption and query tool项目地址https://gitcode.com/gh_mirrors/wxcl/wx-cli点击查看免费下载相关推荐Agent Orchestrator完整API参考薄CLI背后的REST、SSE与终端WebSocket接口地图Agent Orchestrator完整API参考薄CLI背后的REST、SSE与终端WebSocket接口地图 Agent Orchestrator 是一个Prisma CLI 命令参考prisma info 显示服务部署信息与 API 端点Prisma CLI 命令参考 prisma info 显示服务部署信息与 API 端点 prisma info 是 Prisma CLI当前仓库 cli/后端数据库GraphQLDataEase API接口RESTful数据服务完整参考DataEase API接口RESTful数据服务完整参考 概述 DataEase作为开源BI工具提供了完整的RESTful API接口体系支持开发者通过数据可视化数据分析后端前端创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
锦
锦皓数字建站
深耕本土企业品牌数字化升级,专注原创端正雅致商务官网,从视觉设计到稳定运维全程保驾护航。