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

开发流程

运行#

本产品为一个程序,以常驻进程的形式运行,运行时会打开一个微信/企微客户端,如已运行则不会重新打开。
能够同时管理多个微信/企微客户端,每个客户端以 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 和用户标识的关系,方便后续对应的调用接口。
修改于 2024-07-12 03:21:31
上一页
文档说明
下一页
配置
Built with