API

小蜜蜂企微RPA（WxRobot）本地服务接口说明，供二次开发与自动化编排。

客户端启动后会在本机暴露 HTTP 服务，默认基址为 http://localhost:58239/（端口以实际环境为准）。所有接口路径前缀为 api/。

响应结构

多数接口返回 JSON，字段含义如下：

字段类型说明
Statusstringok 成功，fail 失败
Messagestring提示信息
Dataobject / array可选，业务数据

成功示例：

{
  "Status": "ok",
  "Message": "查询成功"
}

失败示例：

{
  "Status": "fail",
  "Message": "请确保你可以看到[通讯录]菜单按钮。之后点击软件右下角的[系统测试]按钮, 对系统组件的运行情况进行检查"
}

调用顺序建议

  1. GET api/status — 确认服务可用
  2. GET api/me — 确认授权与 VIP 状态
  3. POST api/autoCheck — 环境自检（失败时按 Message 处理）
  4. GET api/getAddFriendWindows — 获取可用企微窗口与 ProcessId
  5. PUT api/addFriend — 提交加好友任务
  6. DELETE api/stopAddFriendTask — 需要时终止任务

查询接口状态

GET api/status

用于探测本地服务是否在线。

成功响应

{
  "Status": "ok",
  "Message": "服务运行中"
}

查询身份信息

GET api/me

查询当前登录用户的授权信息。

成功响应

{
  "Status": "ok",
  "Message": "查询成功",
  "Data": {
    "UserName": "17761731746",
    "IsVip": true,
    "ExpiredTime": "2027-03-24 06:33:47"
  }
}
字段说明
Data.UserName用户名（常为手机号）
Data.IsVip是否为 VIP / 有效授权
Data.ExpiredTime授权到期时间

自动检查

POST api/autoCheck

对系统组件与企业微信界面能力做自检。若企微未正确登录或看不到「通讯录」等入口，会返回 fail。

成功响应

{
  "Status": "ok",
  "Message": ""
}

查询添加客户窗口列表

GET api/getAddFriendWindows

返回当前可用于「添加客户」的企微窗口列表，后续 PUT api/addFriend 需使用其中的 ProcessId。

成功响应

{
  "Status": "ok",
  "Message": "添加客户窗口列表",
  "Data": [
    {
      "ProcessId": 47516,
      "NickName": "小蜜蜂",
      "Phone": "17798561746",
      "TodayAddCount": 0,
      "TodayMaxAddCount": 50
    },
    {
      "ProcessId": 22704,
      "NickName": "吴昊",
      "Phone": "17761731746",
      "TodayAddCount": 0,
      "TodayMaxAddCount": 50
    }
  ]
}
字段说明
ProcessId进程 ID，加好友时必填
NickName窗口对应账号昵称
Phone绑定手机号
TodayAddCount今日已添加数量
TodayMaxAddCount今日添加上限

执行添加好友任务

PUT api/addFriend

Content-Type: application/json

请求体

{
  "ProcessId": 22704,
  "AddMode": 2,
  "Info": {
    "remark": "备注可空",
    "phoneNum": "17761731746",
    "labelName": "客户标签可空",
    "hello": "打招呼语50字内"
  },
  "MouseKeyDelay": 100,
  "MouseKeyDelayMax": 300
}
字段必填说明
ProcessId是来自 getAddFriendWindows 的进程 ID
AddMode是0 只加个微，1 只加企微，2 都加
Info是客户信息对象
Info.phoneNum是手机号，用于搜索添加
Info.hello是验证语 / 打招呼，建议 50 字内
Info.remark否通过后备注
Info.labelName否通过后标签名
MouseKeyDelay是鼠标操作最小间隔（毫秒），越小越快
MouseKeyDelayMax是鼠标操作最大间隔（毫秒）

成功响应

{
  "Status": "ok",
  "Message": "成功"
}

失败响应示例

{
  "Status": "fail",
  "Message": "不存在"
}

间隔过小可能增加风控风险，请结合 使用说明 与 常见问题 合理设置。

终止任务

DELETE api/stopAddFriendTask

终止当前正在执行的添加好友任务。

成功响应

{
  "Status": "ok",
  "Message": ""
}

环境与调试

环境基址（示例）
默认本地http://localhost:58239/
Mock（Apipost 等）以导出工具中的 Mock 地址为准

集成前请确认：

  • 小蜜蜂客户端已启动且企微已登录
  • 防火墙未拦截本机端口
  • 具备有效 VIP 时 api/me 中 IsVip 为 true

相关文档