1. bot-机器人
企微Work-bot
  • 开发指南
    • 了解Work-bot
    • 开发前必读
    • 基本概念介绍
    • 试用与支持
    • 获取token
      POST
  • 企微机器人
    • bot-发送消息
      • 获取表情包【matebot、probot、autobot】
      • 发送表情包【matebot、probot、autobot】
      • 收藏表情【matebot、probot、autobot】
      • 发送文本消息
      • 发送图片
      • 发送链接
      • 发送文件
      • 发送视频
      • 发送语音
      • 发送视频号视频消息
      • 发送小程序
      • 发送表情包、动图gif【nanobot、probot】
      • 发送群公告
      • 转发消息
      • 发送引用消息
      • 消息撤回
      • 语音转文字
      • 发送位置消息
      • 发送名片
    • bot-收到消息
      • 收到文本消息
      • 收到图片消息
      • 收到链接消息
      • 收到文件消息
      • 收到视频消息
      • 收到视频号消息
      • 收到小程序消息
      • 收到红包消息
      • 收到位置消息
      • 收到动图gif消息
      • 收到引用消息
      • 根据appInfo 查找引用消息
      • 对方撤回通知
      • 收到语音消息
      • 收到名片消息
    • bot-机器人
      • 检查授权码数量
        POST
      • 创建机器人
        POST
      • 企微机器人列表
        POST
      • 获取登录二维码
        POST
      • 提交验证码
        POST
      • 登录检查
        POST
      • 下线机器人(退出企微登录)
        POST
      • 删除机器人
        POST
      • 登录通知
        POST
      • 退出通知
        POST
      • 账号退出
        POST
      • 机器人企业成员信息通知
        POST
    • bot-联系人
      • 同步联系人
      • 查询联系人
      • 同步标签
      • 同步企业成员
      • 给客户打标签
      • 设置客户备注、描述
      • 设置客户手机号
      • 手机号加粉
      • 添加手机号搜索到的客户微信
      • 删除好友
    • bot-客户群
      • 同步客户群
      • 客户群列表
      • 创建群
      • 添加群成员
      • 查询群信息
      • 修改群名
      • 修改群公告
      • 群解散
      • 群踢人(移除群成员)
      • 拉人进群
      • 退出群聊
      • 添加/删除群管理员
      • 开启/关闭群邀请验证
      • 转让群主
      • 群二维码
      • 禁止修改群名开关
    • bot-朋友圈
      • 获取朋友圈详情
      • 大文件上传
      • 发朋友圈
    • bot-回调通知
      • 联系人通知
        • 查询收到的好友请求列表
        • 添加好友请求(客户添加机器人)
        • 通过添加好友邀请
        • 新增好友通知
        • 好友删除通知
      • 客户群通知
        • 新增群成员通知robot.members.chain
        • 新增群成员通知robot.group.member.changed
        • 新增群成员通知robot.contact.modify
        • 群成员退群通知
        • 群名称变更通知
        • 新增群聊通知
        • 群管理变更通知
    • bot-数据转换
      • 官方群chatId转换为企微群ID
      • 官方客户数据转机器人数据
      • 机器人客户数据转官方自建应用客户数据
      • 机器人企业成员数据转官方自建应用企业成员数据
      • 机器人群id转为官方群id
  • 企微SCRM
    • 客户群
      • 群成员列表
    • 企业成员
      • 企业成员
    • 消息群发
      • 新建群发任务-4
      • 群发任务详情
      • 终止群发任务
      • 群发任务列表
    • 入群邀请
      • 创建拉群任务
    • 机器人设置-群聊
      • 群欢迎语-开启关闭
      • 群欢迎语内容-设置
      • 群欢迎语内容-查询
      • 群欢迎语时间-设置
      • 群欢迎语时间-查询
      • 模板参数-设置
      • 机器人客户群列表
      • 默认回复开关-打开/关闭
      • 默认回复内容-设置
      • 图片回复内容-设置
      • 图片回复内容-查询
      • 图片回复规则-查询
      • 图片回复规则-设置
      • 群管理员-设置
    • 机器人设置-私聊
      • 获取私聊设置
      • 自动拉人入群-设置
      • 自动拉人进群-打开/关闭
      • 图片回复开关-打开/关闭
      • 链接回复内容-设置
      • 链接回复开关-打开/关闭
      • 口令入群-打开/关闭
      • 口令入群-设置
      • 默认回复-设置
      • 默认回复开关-打开/关闭
      • 默认回复时间设置-查询
      • 关键字打标签开关状态-查询
      • 关键词打标签-开启/关闭
      • 关键词打标签配置信息-查询
    • 机器人设置-通用
      • 私聊/群聊 关键词回复内容设置
      • 查询标签数据
      • 打开/关闭 关键词回复开关
      • 获取关键词回复设置
    • 客户与客户群
      • 接口拓客手机号列表
      • 企微群列表
      • 企微群成员列表
      • 客户列表
    • 其它
      • 上传图片/文件
      • 资源url加签名
    • 账号
      • 删除子账号(注意删除后不能在创建同名账号)
      • 创建子账号
    • 会话
      • 聊天记录
      • 最近会话列表
    • scrm-回调通知
      • 添加企业客户事件
      • 删除企业客户事件
      • 删除跟进成员事件
  • 数据模型
    • 示例数据模型
      • Pet
      • Category
      • Tag
    • Schemas
      • TaskData
      • MessageContent
      • AcceptTarget
      • TextMessage
      • ImageMessage
      • LinkMessage
  1. bot-机器人

登录检查

POST
/wxworkapi/robot/logincheck
获取二维码后检查用户是否完成扫码登录,在开发登录场景时建议轮循检查,直到反回确定结果。

请求示例:#

{
    "r": "f5f577df091f423da46869eaaddd6ef9",
    "token": "dc266b77b568cc851424793cb48ea823",
    "bizType": 5 
}

请求参数说明:#

名称类型必须示例值描述
tokenString是eaa7c835b5b27c231a8b0c323feb1361第三方认证的 token,所有的请求需要携带该参数
bizTypeInteger是54表示微信机器人,5表示企微机器人
rString是f5f577df091f423da46869eaaddd6ef9机器人密钥

响应示例:#

用户未扫码时:#

响应示例:
{
    "code": "0",
    "messageId": "20210329153418046996953903",
    "msg": "请扫码登录",
    "qrCode": "/9j/4AAQSkZJRgABAQAASABIAAD/4QBARXhpZgAATU0AKgAAAA",
    "robotBizType": 5,
    "robotKey": "f5f577df091f423da46869eaaddd6ef9",
    "siteCode": "wenode_chat_0049",
    "type": "robot.qrcode"
}
响应参数说明:
名称类型描述
messageldString消息 ID
msgString表示还未扫码
qrCodeString二维码编码数据
robotBizTypeInteger4 表示微信机器人,5 表示企微机器人
robotKeyString机器人密钥
siteCodeString
typeString

登录成功后:#

响应示例:
{
    "code": "0",
    "msg": "OK",
    "robotKey": "f5f577df091f423da46869eaaddd6ef9"
}
响应参数说明:
名称类型描述
msgStringOK表示成功
robotKeyString机器人密钥

未登录(未获取二维码直接调用登录检查时):#

响应示例:
{
    "code": "926",
    "msg": "未登录"
}

使用错误的企微扫码登录:#

响应示例:
{
    "code": "1005",
    "msg": "错误的企微登录"
}

使用错误的企微扫码登录:#

响应示例:
{
    "code": "1005",
    "msg": "错误的企微登录"
}

该企微号已经创建过机器人:#

响应示例:
{
    "code": "1151",
    "msg": "该微信号已经创建企微机器人,请联系管理员分配"
}

客户端版本过低:#

响应示例:
{
    "code": "1152",
    "msg": "当前客户端版本较低,请升级到最新版本后再试"
}

请求参数

Authorization
Header 参数

Body 参数application/json

示例
{
    "bizType": 5,
    "r": "dd3296bdd2f84c6b93b568f0143c7761"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://www.example.com/wxworkapi/robot/logincheck' \
--header 'token: cf95e27e49a58a63798dc48e13b6f866' \
--header 'Content-Type: application/json' \
--data '{
    "bizType": 5,
    "r": "dd3296bdd2f84c6b93b568f0143c7761"
}'

返回响应

🟢200在用户未扫码时
application/json
{
    "msg": "请扫码登录",
    "nodeServerCode": "node_server_0002",
    "code": "0",
    "siteCode": "wenode_chat_3081",
    "bizType": 5,
    "messageId": "20250326182837134137453984",
    "type": "robot.qrcode",
    "routing": "recv",
    "robotKey": "dd3296bdd2f84c6b93b568f0143c7760",
    "qrCode": "/base64********",
    "statUpSend": 1742984921218,
    "robotType": 2,
    "robotBizType": 5
}
Bodyapplication/json

示例
{}
🟢200登录成功后
🟢200未登录
🟢200使用错误的企微登录
🟢200该企微号已经创建过机器人
🟢200客户端版本过低
修改于 2025-04-03 01:58:22
上一页
提交验证码
下一页
下线机器人(退出企微登录)
Built with