企微
  1. 文档必读
企微
  • 文档必读
    • 文档说明
    • 开发流程
    • 配置
    • Q&A
    • 消息回调
  • 客户端控制
    • 打开企微
      POST
    • 退出企微
      POST
    • xbot 健康检查
      POST
  • 登录信息
    • 刷新登录二维码
      POST
    • 退出登录
      POST
  • 消息
    • 发送文本
      POST
    • 发送文本(新版)
      POST
    • 发送图片URL
      POST
    • 发送图片
      POST
    • 发送图片(新版)
      POST
    • 发送群@消息
      POST
    • 发送群@消息(新版)
      POST
    • 发送文件消息
      POST
    • 发送文件URL
      POST
    • 发送文件消息(新版)
      POST
    • 发送动图消息
      POST
    • 发送卡片消息
      POST
    • 发送小程序
      POST
    • 发送视频号
      POST
    • 发视频消息
      POST
    • 发视频消息(新版)
      POST
    • 发送名片
      POST
    • 发送视频号直播消息
      POST
    • 撤回消息
      POST
    • 发送语音消息
      POST
    • 发送位置消息
      POST
    • 标记消息已读
      POST
  • 联系人
    • 获取联系人信息
    • 获取内部联系人会话列表
    • 获取外部联系人列表
    • 搜索微信/企微用户
    • 添加搜索的微信用户
    • 添加搜索的企微用户
    • 添加名片为联系人
    • 添加删除的联系人
    • 修改内/外部好友备注
    • 修改内/外部好友描述
    • 修改外部联系人手机号
    • 修改外部联系人公司名称
    • 接受好友申请
    • 删除联系人
    • 批量获取联系人信息(协议)
    • 获取被对方删除的客户列表
  • 群组
    • 获取会话群聊列表
    • 获取会话群成员列表
    • 获取群信息(协议)
    • 获取客户群列表(协议)
    • 创建内/外部群
    • 创建空外部群
    • 修改群名
    • 批量邀请好友入群
    • 批量踢群成员
    • 添加群成员为联系人
    • 发布群公告
    • 转让群主
    • 开启/关闭群邀请确认
    • 开启/关闭禁止修改群名
    • 通过群邀请
    • 退出群聊
    • 解散群
    • 获取群聊二维码
    • 添加群管理员
    • 删除群管理员
    • 获取群聊黑名单
    • 禁止用户加入我的群聊
    • 获取群防骚扰规则
    • 设置群防骚扰规则
    • 获取群欢迎语列表
    • 添加群欢迎群
    • 设置群欢迎语
  • 标签
    • 获取标签下的所有联系人
    • 获取标签列表
    • 创建标签
    • 给客户加标签
    • 获取指定客户的所有标签
  • CDN
    • CDN 说明
    • 关闭客户端自动下载
    • CDN上传
    • CDN下载
    • BigCDN上传媒体文件
    • WxCDN下载
    • BigCDN下载媒体文件
    • CDN上传(URL版本)
    • BigCDN上传媒体文件(URL版本)
  • 朋友圈
    • 发布朋友圈(文字,图片,链接, 视频,视频号)
    • 设置朋友圈签名
    • 获取朋友圈列表
    • 设置朋友圈封面
  • 开放平台双向互通
    • 开放平台说明
    • 用户ID转开放平台ID
    • 群ID转开放平台chatId
    • 开放平台群ID转群chatId
    • 开放平台ID转用户ID
  1. 文档必读

配置

配置为 .env 文件,在同一目录中
配置文件大致预览:
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`

文件系统#

本产品运行在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 #设置后,启动不会打开微信/企微客户端,需要手动调用接口打开

企微专属#

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