个微
  1. 文档必读
个微
  • 文档必读
    • 文档说明
    • 开发流程
    • 配置
    • Q&A
    • 消息回调
    • 风控说明
  • 客户端
    • 打开微信
      POST
    • 进入微信
      POST
    • 注销登录
      POST
    • 退出微信程序
      POST
    • xbot 健康检查
      POST
    • 刷新登录二维码
      POST
    • 获取个人信息
      POST
    • 修改个人信息
      POST
  • 联系人
    • 获取好友列表
      POST
    • 分页获取好友列表
      POST
    • 获取单个好友信息
      POST
    • 指量获取好友信息
      POST
  • 群组
    • 获取群组列表
      POST
    • 获取群组列表(数量少)
      POST
    • 获取群组列表(只有ID)
      POST
    • 获取群组信息(有群成员详细信息)
      POST
    • 获取群组信息(没有群成员详细信息)
      POST
    • 获取群成员邀请关系
      POST
  • 企业微信数据
    • 获取企业群组信息
      POST
    • 获取企业群组成员信息
      POST
    • 获取企业好友信息
      POST
  • 好友操作
    • 删除好友
    • 修改好友备注
    • 接收好友的转账
    • 退还好友的转账
    • 僵尸粉检测
  • 加好友
    • 添加好友
    • 添加单向好友(无需验证)
    • 同意加好友请求
    • 通过手机号/微信号/QQ号查询任意微信号信息
    • 添加通过任意手机号/微信号/QQ号查询的联系人
  • 群操作
    • 创建群聊
    • 创建群聊(新)
    • 邀请好友进群
    • 邀请好友进群(需好友同意)
    • 踢出群成员
    • 修改群聊名称
    • 修改群公告(可用于@全体)
    • 修改我在本群的昵称
    • 保存到/移出通讯录
    • 删除并退出
    • 二维码链接进群
    • 二维码图片进群
  • 发送消息
    • 发送文本
    • 发送文本(新版)
    • 发送群聊@消息
    • 发送群聊@消息(新版)
    • 发送名片消息
    • 发送名片消息(新版)
    • 发送链接消息
    • 发送图片消息
    • 发送图片消息(CDN)
    • 发送图片(URL)
    • 发送文件消息
    • 发送文件消息(CDN)
    • 发送视频消息
    • 发送视频消息(CDN)
    • 发送gif表情
    • 发送gif表情(CDN)
    • 发送位置消息
    • 主动撤回消息
    • 主动撤回消息(新版)
    • 发送视频号消息
    • 发送XML
    • 发送XML(新版)
    • 转发小程序
    • 发送小程序消息
    • 发送小程序(xml) 模式
    • 转发消息
    • 发送文件消息(URL)
  • 解密类
    • 解密图片
    • 解密图片 v2
    • a8 key
    • 识别二维码
    • 获取数据库查询
  • 标签
    • 获取所有标签
    • 删除标签
    • 编辑标签
    • 查找或创建标签
    • 用户的标签列表
    • 给好友打标签
  • 朋友圈
    • 朋友圈列表
    • 好友朋友圈列表
    • 朋友圈点赞
    • 朋友圈评论
    • 发送朋友圈
    • 上传图片
  • 视频号
    • 视频号初始化
    • 视频号搜索
    • 视频号用户主页
    • 视频号详情(包含评论与下载链接)
    • 关注视频号作者
    • 视频号点赞
    • 获取私信sessionId
    • 发送私信
    • 创建虚拟昵称
    • 切换虚拟昵称
    • 删除虚拟昵称
    • 视频解密
  • 直播
    • 进入直播间
    • 获取直播间在线人员
    • 获取直播间变动信息(人气,实时发言等))
    • 直播间发言
    • 直播间点赞
    • 获取直播间货架
    • 获取货架商品详细信息
  • CDN
    • CDN初始化
    • CDN下载
    • CDN上传
  • 其他
    • 获取小程序授权code
    • 开启防撤回
    • 语音消息转文本
  1. 文档必读

开发流程

运行#

xbot 为一个程序,以常驻进程的形式运行,运行时会打开一个微信/企微客户端,如已运行则不会重新打开。
xbot 能够同时管理多个微信/企微客户端,每个客户端以 client id 自增去识别。

配置文件#

常用的 xbot 配置(.env 文件,与 xbot 在同一目录中)
CALLBACK_URL=
SECRET=
PORT=
开发者可以新建 .env 文件去自行初始化配置,如没有配置,xbot 会自动打开浏览器给开发者进行配置。
CALLBACK_URL 填写http或https的回调地址,xbot 会推送消息到该回调地址
SECRET 购买 xbot 后会拿到该参数
PORT 调 xbot 接口需要填写端口,配置运行后可直接 POST http://127.0.0.1:{PORT} 则可以调接口
更多个性化配置,可以根据自身需求询问作者

同步调用接口#

xbot 默认是回调返回调用结果的。但为了方便开发者,xbot 提供了同步调用的方式,xbot 根据消息发送与预期返回进行匹配,不完全精准,建议不要并发调同个 type 的接口。
使用方式,POST 的时候在外层传上 "is_sync": 1 即可
例:
{
    "data": {
        "search": "wxzsxt"
    },
    "client_id": 1,
    "is_sync": 1,
    "type": "MT_SEARCH_CONTACT_MSG"
}

问题排查#

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

多个客户端处理 client id#

调用接口,都一定包含 data, client_id, type 三个参数。
在刚打开微信/企微客户端,因为未登录,xbot 只能获取到一个 client id, 还不知道用户登录信息。在登录成功后,会通过回调返回 client id 以及登录成功的用户标识,开发者可以自行存储好本次 client id 和用户标识的关系,方便后续对应的调用接口。
修改于 2023-01-03 11:19:26
上一页
文档说明
下一页
配置
Built with