个微
  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. 文档必读

配置

配置为 .env 文件,与 xbot 在同一目录中
配置文件大致预览:
CALLBACK_URL=http://domain.com/callback
SECRET=xxxxxxxxxxxxxxxxxx
PORT=5887

配置详解#

常用必备#

CALLBACK_URL=http://domain.com/callback #回调地址,所有消息都会推送到此地址
SECRET=xxxxxxx #密钥,购买后颁发
PORT=2352 #端口,调接口用到,可以是 `http://localhost:{port}` 也可以是 `http://{公网}:{port}`

中转代理#

WS_SERVER=ws://localhost:5283 #当电脑没有公网IP时,可以自行写个ws服务端,让xbot通过ws连接后,写入要执行的json指令
ws 服务端例子,可直接下载使用,作为无公网IP的中转代理: https://github.com/xbot-org/xbot-ws-server

请求连接#

API_TOKEN=xxx #怕端口暴露被调用,可以设置这个,请求时需要在`header`加上`token`

文件系统#

xbot运行在Windows,图片与文件都在Windows上,有些用户如果想要在其他服务器访问这些文件,可以通过配置文件系统实现远程访问。生效需要同时配置以下两项
FILE_PORT=8235 #文件系统访问端口,通过HTTP访问即可
FILE_DIR=D:\WeChat Files\ #访问的默认文件夹,根据路径访问文件,一般建议设置微信/企微的文件管理路径
根据以上配置好后,重启 xbot,访问 http://{ip}:8235/1.jpg 便可访问到服务器 D:\WeChat Files\1.jpg 的内容。

客户端#

NO_AUTO_OPEN=1 #设置后,启动xbot不会打开微信/企微客户端,需要手动调用接口打开

企微专属#

企微多开时,会发现部分客户端收消息延迟,可以通过配置该项解决
WXWORK_PATH=C:\Users\Administrator\Documents\WXWork #值的内容去复制企微设置,文件管理里面的文件存储位置,保存后重启xbot
上一页
开发流程
下一页
Q&A
Built with