同步联系人

同步任务命令采用异步处理，收到指令后响应指令接收成功，数据通过回调通知接口上报。
分批上送联系人数据，每批最多上送50个联系人
（非必要不调此接口，此接口为向企微发起全部好友同步请求，需注意频率，过于频繁会导致卡顿或是风险）

请求示例：

{
  "type": "robot.contacts.sync",
  "messageId": "2020110901993434",
  "robotKey": "fffaedd2fb984ec882adfd9527e2e7c9",
  "syncType": 1
}

请求参数说明：

名称	类型	必须	描述
type	String	是	robot.contacts.sync
messageld	String	是	请求消息id，32个字符的唯一，应答时原样回传
robotKey	String	是	机器人robotKey
syncType	Integer	否	0 客户和群，1 客户数据，2 群数据，默认0

回调通知：

回调通知接口 /XXXX/service/result

联系人数据：

{
  "messageId":"2020110901993434",
  "robotKey":"fffaedd2fb984ec882adfd9527e2e7c9",
  "syncType":1,
  "code":"0",
  "externalUsersCount":7,
  "currentCount":7,
  "robotType":2,
  "type":"robot.chat.get",
  "externalUsers":[
    {
      "userId":7881299617985997,
      "realRemarks":"🐱Fay🐶20230216",
      "wechatName":"",
      "markAsCustomerTime":"2023-02-16 16:51:55",
      "isMarkedAsCustomer":1,
      "isOuterUser":1,
      "corpanyId":1970325134026788,
      "isCustomer":1,
      "name":"🐱Fay🐶",
      "flag":2049,
      "gender":2,
      "isExternalUser":1,
      "remarkCorpName":"微信",
      "createTime":"2023-02-15 18:44:19",
      "avatorUrl":"http:\/\/wx.qlogo.cn\/mmhead\/Q3auHgzwzM6AeEQ8W76B1oz5M1etQmiaJKI8JuxqgKbIscHxR4HXVQA\/0",
      "namePinyin":"🐱Fay🐶",
      "remarks":"test",
      "remarkPhoneList":[
        "15915728861"
      ]
    },
    {
      "userId":7881300731914225,
      "...":"..."
    }
  ]
}

参数说明：

名称	类型	必须	描述
externalUsersCount	Integer	是	当前成员客户总数
currentCount	Integer	是	本次客户数量
type	String	是	robot.chat.get 表示客户数据通知
externalUsers	Array	是	客户数据列表

客户数据 externalUsers ：

名称	类型	必须	描述
userId	Long	是	用户 VID
realRemarks	String	是	备注
markAsCustomerTime	String	是	成为客户的时间 "yyyy–MM–dd HH:mm:ss" 格式的北京时间
isMarkedAsCustomer	Integer	是	是否客户
corpanyld	Long	是	客户的公司 vid
remarkCorpName	String	否	备注公司名
avatorUrl	String	否	头像
name	String	是	客户昵称或姓名
gender	Integer	是	`0` 未知 `1` 男性 `2` 女性
isExternalUser	Integer	是	是否外部用户 `1` 是，`0` 否
createTime	String	是	加客户的时间 "yyyy–MM–dd HH:mm:ss" 格式的北京时间
remarks	String	否	描述信息
remarkPhoneList	Array	否	备注手机号数组

群数据：

{
  "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"
    },
    {
      "...":"..."
    }
  ]
}

参数说明：

名称	类型	必须	描述
conversationType	Integer	是	群类型
convManagers	Array	是	管理员vid数组
type	String	是	命令字，"robot.group.get"表示通知群详细信息上送
conversationald	String	是	群id
creatorld	Long	是	群主vid
createTime	String	是	建群的时间 "yyyy–MM–dd HH:mm:ss" 格式的北京时间
groupNotices	Array	否	群公告信息数组
noticeUserId	Long	否	发送群公告的成员，无群公告时为0
noticeTime	String	是	群公告的时间 "yyyy–MM–dd HH:mm:ss" 格式的北京时间
memberCount	Integer	是	群成员数量
memberList	Array	是	群成员数组
chatGroupEnd	Integer	否	当出现该字段为1时，表示本次批量上送结束

群成员明细 memberList

名称	类型	必须	描述
userId	Long	是	用户 VID
realRemarks	String	是	备注
corpanyld	Long	是	客户的公司 vid
avatorUrl	String	否	头像
name	String	是	客户昵称或姓名
gender	Integer	是	0 未知 1 男性 2 女性
isExternalUser	Integer	是	是否外部用户 1 是，0 否
joinTime	String	是	入群时间 "yyyy–MM–dd HH:mm:ss"
remarks	String	否	描述信息
nickName	String	否	群内昵称
isConvAdmin	Integer	是	是否是管理员 1 是，0 否
mobile	String	否	手机号码
realName	String	否	实际姓名
inviterUserId	Long	否	邀请人的 vid

application/json

Bodyapplication/json

示例

{
    "messageId":"2020110901993434",
    "code": "202",
	  "msg": "OK",
    "type":"robot.contacts.sync",
    "robotKey":"fffaedd2fb984ec882adfd9527e2e7c9"
}

请求示例：

请求参数说明：

回调通知：

联系人数据：

参数说明：

客户数据 externalUsers ：

群数据：

参数说明：

群成员明细 memberList

请求参数

请求示例代码

返回响应

同步联系人

请求示例：#

请求参数说明：#

回调通知：#

联系人数据：#

参数说明：#

客户数据 externalUsers ：#

群数据：#

参数说明：#

群成员明细 memberList#

请求参数

请求示例代码

返回响应

请求示例：

请求参数说明：

回调通知：

联系人数据：

参数说明：

客户数据 externalUsers ：

群数据：

参数说明：

群成员明细 memberList