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-机器人
      • 检查授权码数量
      • 创建机器人
      • 企微机器人列表
      • 获取登录二维码
      • 提交验证码
      • 登录检查
      • 下线机器人(退出企微登录)
      • 删除机器人
      • 登录通知
      • 退出通知
      • 账号退出
      • 机器人企业成员信息通知
    • bot-联系人
      • 同步联系人
      • 查询联系人
      • 同步标签
      • 同步企业成员
      • 给客户打标签
      • 设置客户备注、描述
      • 设置客户手机号
      • 手机号加粉
      • 添加手机号搜索到的客户微信
      • 删除好友
    • bot-客户群
      • 同步客户群
        POST
      • 客户群列表
        POST
      • 创建群
        POST
      • 添加群成员
        POST
      • 查询群信息
        POST
      • 修改群名
        POST
      • 修改群公告
        POST
      • 群解散
        POST
      • 群踢人(移除群成员)
        POST
      • 拉人进群
        POST
      • 退出群聊
        POST
      • 添加/删除群管理员
        POST
      • 开启/关闭群邀请验证
        POST
      • 转让群主
        POST
      • 群二维码
        POST
      • 禁止修改群名开关
        POST
    • 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/message/exchange
命令字type:robot.contacts.sync
同步任务命令采用异步处理,收到指令后响应指令接收成功,数据通过回调通知接口上报。
群数据异步单个上送。

请求示例:#

{
  "type": "robot.contacts.sync",
  "messageId": "2020110901993434",
  "robotKey": "e8ef2eea32f44f45b05dd0fe9f0acb2e",
  "syncType": 2
}

请求参数说明:#

名称类型必须描述
typeString是contacts.sync
messageldString是请求消息id,32个字符的唯一,应答时原样回传
robotKeyString是机器人robotKey
syncTypeInteger否0 客户和群,1 客户数据,2 群数据,默认0
回调通知接口 /XXXX/service/result
回调群数据
{
  "conversationType":2,
  "convManagers":[
    1688850872073621,
    1688851094693341,
    1688854353367405
  ],
  "robotKey":"fffaedd2fb984ec882adfd9527e2e7c9",
  "robotType":2,
  "hasRobot":1,
  "conversationId":"R:10887453349691109",
  "creatorId":1688854655507369,
  "type":"robot.group.get",
  "dts":1677211168341,
  "name":"666ABCD",
  "messageId":"2020110901993434",
  "isWxRoomAdmin":1,
  "groupNotices":[
    {
      "content":"11111"
    }
  ],
  "createTime":"2023-01-31 18:40:31",
  "memberCount":13,
  "noticeTime":"2023-0211 09:23:10",
  "noticeUserId":1688854353367405,
  "memberList":[
    {
      "remarks":"",
      "avatorUrl":"https:\/\/wework.qpic.cn\/wwpic\/977743_pSRu18RpRLuP_uT_1666245541\/0",
      "userId":1688855725377539,
      "corpanyId":1970325089352628,
      "name":"我要青春不要痘",
      "isConvAdmin":0,
      "nameStatus":1,
      "nickName":"爱听小八卦",
      "position":"",
      "mobile":"",
      "gender":1,
      "realName":"XXXXX",
      "realRemarks":"",
      "joinTime":"2023-01-12 12:12:01"
    },
    {
      "remarks":"",
      "realRemarks":"",
      "position":"",
      "avatorUrl":"http:\/\/wx.qlogo.cn\/mmhead\/wprMnqDUJH4HN2usTRwDu4x8DiasJ5YibATCFxEoib3hkyLmnDLdCaKbQ\/0",
      "userId":7881300384921417,
      "corpanyId":1970325134026788,
      "nickName":"",
      "name":"listen",
      "isConvAdmin":0,
      "gender":1,
      "mobile":"",
      "officePhone":"",
      "isExternalHidePersonalCorp":0,
      "isExternalHideMobile":0,
      "remarkImageUrl":"",
      "account":"",
      "inviterUserId": 1688800000XXXX,
      "realName":"XXXXX",
      "joinTime":"2023-01-12 12:12:01"
    },
    {
      "remarks":"",
      "realRemarks":"",
      "position":"",
      "avatorUrl":"http:\/\/wx.qlogo.cn\/mmhead\/HmVQlX9WkBsf62BpnXclPH0v0LmiahtHoiceEwe5wMia1fm8hy7t8hF3w\/0",
      "userId":7881301536954520,
      "corpanyId":1970325134026788,
      "nickName":"",
      "name":"凯XXX",
      "isConvAdmin":0,
      "gender":1,
      "mobile":"",
      "officePhone":"",
      "isExternalHidePersonalCorp":0,
      "isExternalHideMobile":0,
      "remarkImageUrl":"",
      "account":"",
      "joinTime":"2023-01-12 12:12:01"
    },
    {
      "...":"..."
    }
  ]
}
备注: 群信息一个群,一个群上送
字段说明
名称类型必须描述
conversationTypeInteger是群类型
convManagersArray是管理员vid数组
typeString是命令字,“robot.group.get”表示通知
群详细信息上送
conversationIdString是群id
creatorIdLong是群主vid
createTimeString是建群的时间 "yyyy-MM-dd HH:mm:ss"
格式的北京时间
groupNoticesArray否群公告信息数组
noticeUserIdLong否发送群公告的成员,无群公告时为0
noticeTimeString是群公告的时间 "yyyy-MM-dd HH:mm:ss"
格式的北京时间
memberCountInteger是群成员数量
memberListArray是群成员数组
chatGroupEndInteger否当出现该字段为1 时, 表示本次批量上送结束
群成员数据:
名称类型必须描述
userIdLong是用户VID
realRemarksString是备注
corpanyIdLong是客户的公司vid
avatorUrlString否头像
nameString是客户昵称或姓名
genderInteger是0 未知 1 男性 2 女性
isExternalUserInteger是是否外部用户 1 是, 0 否
joinTimeString入群时间 "yyyy-MM-dd HH:mm:ss"
格式的北京时间
remarksString否描述信息
nickNameString否群内昵称
isConvAdminInteger是是否是管理员 1 是, 0 否
mobileString否手机号码
realNameString否实际姓名
inviterUserIdLong否邀请人的vid

请求参数

Authorization
Query 参数

Body 参数application/json

示例
{
    "type": "robot.contacts.sync",
    "messageId": "2020110901993434",
    "robotKey": "fffaedd2fb984ec882adfd9527e2e7c9",
    "syncType": 2
}

请求示例代码

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/message/exchange?acttype=syncgroup' \
--header 'Content-Type: application/json' \
--data '{
    "type": "robot.contacts.sync",
    "messageId": "2020110901993434",
    "robotKey": "fffaedd2fb984ec882adfd9527e2e7c9",
    "syncType": 2
}'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{
    "messageId":"2020110901993434",
    "code": "202",
	  "msg": "OK",
    "type":"robot.contacts.sync",
    "robotKey":"fffaedd2fb984ec882adfd9527e2e7c9"
}
修改于 2025-08-25 02:46:11
上一页
删除好友
下一页
客户群列表
Built with