1. 开发指南
企微Work-bot
  • 开发指南
    • 了解Work-bot
    • 开发前必读
    • 基本概念介绍
    • 试用与支持
    • 获取token
      POST
  • 企微机器人
    • bot-发送消息
      • 获取表情包【matebot、probot、autobot】
      • 发送表情包【matebot、probot、autobot】
      • 收藏表情【matebot、probot、autobot】
      • 发送文本消息
      • 发送图片
      • 发送链接
      • 发送文件
      • 发送视频
      • 发送语音
      • 发送视频号视频消息
      • 发送小程序
      • 发送表情包、动图gif【nanobot、probot】
      • 发送群公告
      • 转发消息
      • 发送引用消息
      • 消息撤回
      • 语音转文字
      • 发送位置消息
      • 发送名片
    • bot-收到消息
      • 收到文本消息
      • 收到图片消息
      • 收到链接消息
      • 收到文件消息
      • 收到视频消息
      • 收到视频号消息
      • 收到小程序消息
      • 收到红包消息
      • 收到位置消息
      • 收到动图gif消息
      • 收到引用消息
      • 根据appInfo 查找引用消息
      • 对方撤回通知
      • 收到语音消息
      • 收到名片消息
    • bot-机器人
      • 检查授权码数量
      • 创建机器人
      • 企微机器人列表
      • 获取登录二维码
      • 提交验证码
      • 登录检查
      • 下线机器人(退出企微登录)
      • 删除机器人
      • 登录通知
      • 退出通知
      • 账号退出
      • 机器人企业成员信息通知
    • 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. 开发指南

开发前必读

开发前必读#

1.
服务端API开放了丰富的能力接口,开发者可以借助接口能力,实现企业服务及企业微信的集成。支持的能力,通过目录导航可以快速预览,目录树按功能块聚合归类,如通讯录管理、消息推送等。
2.
文档的阅读次序,建议先阅读一遍开发指南,以及接口token获取。然后就可以独立查看各个功能块文档说明。
3.
所有的接口需使用HTTPS协议、JSON数据格式。
4.
所有的请求都必须携带以下参数

通用请求头#

名称类型必须示例值描述
tokenstring是eaa7c835b5b27c231a8b0c323feb1361第三方认证的token,所有的请求需要携带该参数
request_idString是09cb05da9c91453fa1ae08efa083ecd132位请求号,全局唯一,采用querystring方式携带在url后面
请求时将token通过http增加header的方式传递,token:"eaa9c935b5b27c231a8b0c323feb1361"

接口规范#

请求方式:所有接口统一使用 POST 方法
数据格式:请求和响应均使用 JSON 格式
字符编码:统一使用 UTF-8
认证方式:所有接口需要在 header 中携带 token

获取token#

token是开发者调用Work-bot Api的重要票据,由accessKey和accessSecret产生。所有接口在通信时都需要携带此信息用于验证接口的访问权限。
获取token,参考 [文档说明]获取token。
名称类型必须示例值描述
accessKeyString是user1登录账号
accessSecretString是Q3KR21ME登录密钥
accessKey、accessSecret在联系客服获得体验账号时颁发。
在本项目API文档中已设置了测试用的token,用于在测试相关Api时使用。

开发方式#

机器人交互接口包括服务请求接口和通知接口。
开发者通过服务接口调用机器人能力,服务端收到请求后,操纵机器人完成任务指令,执行结果通过通知接口回调开发者。
回调通知接口:企业微信收到的会话消息以及客户、群数据变更等将在回调通知接口通知开发者。

http服务请求接口#

URL: /wxworkapi/message/exchange
Request method: POST application/json

通用请求参数说明#

请求消息id:messageld(String),必传,32个字符的唯一,回调接口原样回传 示例:mm202504212069831394827942942968

回调通知接口#

说明: 回调通知接口, 由开发者实现,接口地址开发者自定义,文档中地址仅作为参考,回调通知接口地址需提供给客服进行配置
例如: URL: /XXXX/service/result
Request method: POST application/json
成功响应及重试说明:
接收通知接口需在收到通知时响应200状态码,非200响应,推送服务会识别为失败,延迟10秒重试1次,继续失败,再延时30秒重试1次。之后不再重试。
修改于 2026-05-20 06:20:47
上一页
了解Work-bot
下一页
基本概念介绍
Built with