开发流程

运行

本产品为一个程序，以常驻进程的形式运行，运行时会打开一个微信/企微客户端，如已运行则不会重新打开。

能够同时管理多个微信/企微客户端，每个客户端以 client id 自增去识别。

配置文件

常用的配置（.env 文件，与程序在同一目录中）

CALLBACK_URL=
SECRET=
PORT=

开发者可以新建 .env 文件去自行初始化配置，如没有配置，会自动打开浏览器给开发者进行配置。

• CALLBACK_URL 填写http或https的回调地址，xbot 会推送消息到该回调地址
• SECRET 购买后会拿到该参数
• PORT 调接口需要填写端口，配置运行后可直接 POST http://127.0.0.1:{PORT} 则可以调接口
• 更多个性化配置，可以根据自身需求询问作者

同步调用接口

默认是回调返回调用结果的。但为了方便开发者，提供了同步调用的方式，据消息发送与预期返回进行匹配，不完全精准，建议不要并发调同个 type 的接口。

使用方式，POST 的时候在外层传上 "is_sync": 1 即可

例：

{
    "data": {
        "search": "wxzsxt"
    },
    "client_id": 1,
    "is_sync": 1,
    "type": "MT_SEARCH_CONTACT_MSG"
}

问题排查

所有消息、回调推送、接口调用都会在控制窗口以及日志文件可以看到，通过控制台可以查看发生的事情。日志文件的路径在目录下的 logs 文件夹里。

多个客户端处理 client id

调用接口，都一定包含 data, client_id, type 三个参数。

在刚打开微信/企微客户端，因为未登录，xbot 只能获取到一个 client id, 还不知道用户登录信息。在登录成功后，会通过回调返回 client id 以及登录成功的用户标识，开发者可以自行存储好本次 client id 和用户标识的关系，方便后续对应的调用接口。