👉 接入须知

文档定位

本文档面向企业微信 API 接入与二次开发场景，重点说明接口调用顺序、参数结构、回调处理和工程落地注意事项。建议先完成最小闭环验证，再逐步接入联系人、消息、外部群、文件、标签和朋友圈等能力。

一、快速接入(验证)流程

方式一(最快):

登陆管理后台： 直接扫码登录企业微信,然后发送第一条消息即可。

方式二(代码接入):

获取接口密钥：在管理后台创建或获取 Token，并在请求头中传入 WECOM-TOKEN。

创建设备：调用「创建设备并获取 guid」，保存返回的 guid。

扫码登录：调用「获取登录二维码」，由企业微信扫码确认登录。

检查状态：调用「查询账号在线状态」，确认账号在线后再进入业务接口调用。

配置回调：如需接收消息、账号状态、系统事件或异步任务结果，请配置 Webhook 回调地址。

JSON 接口统一请求 /finder/api。

请求体统一包含 method 和 params。

method 为接口能力标识，例如 /login/checkLogin。

params 为业务参数对象，不同接口参数结构不同。

文件类接口请按照对应接口说明提交文件、文件 URL 或素材参数。

回调地址必须公网可访问。

接收端建议在 3 秒内返回 HTTP 200 或空字符串。

不建议在回调请求内直接执行耗时业务，推荐先入库或投递消息队列。

可使用 guid 区分账号或设备实例。

可使用 cmd、msgType、msgUniqueIdentifier、requestId 做事件分类、幂等与排查。

💡

接口能力应服务于合法、合规、真实的业务系统建设。正式环境建议增加权限校验、操作日志、频率控制、异常告警和人工审核机制，避免高频、并发、骚扰式或违反平台规则的调用行为。