API回调

TIP

回调会重试5次，间隔分别是1，4，9，16, 25秒测试环境域名：https://crm.testing.pipacoding.com

新增客户

POST /crm-botorange/v1/notify/add/customer

sign=body+token 签名

请求参数Body:

{
  "type": "add_external_contact",
  "event": {
    "ToUserName": "ww02f212d73c9dd123",
    "FromUserName": "sys",
    "CreateTime": "1597931626",
    "MsgType": "event",
    "Event": "change_external_contact",
    "ChangeType": "add_external_contact",
    "UserID": "rocky",
    "ExternalUserID": "wm0ZoZBwAAVinZ739MvTpccHQkHQx3gA",
    "State": "8ff9cf31-98ce-4cce-88b3-53d123",
    "WelcomeCode": "lUdrUtUN2lXUGPee0AhccvmOs0NI1foXdDZMk8qf123"
  },
  "data": {
    "unionId": "ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
    "name": "李四",
    "avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
    "externalUserId": "wmfvEMCAAAPHR9XslvYqTFgCJTULiZgg",
    "gender": 1,
    "type": 1,
    "followUser": [
      {
        "userId": "rocky",
        "name": "张三",
        "remark": "张总",
        "avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
        "createTimestamp": 1604048292000,
        "tags": [
          {
            "groupName": "标签组名",
            "tagName": "标签名",
            "type": "1",
            "tagId": "etDodGBwAA-rmc_3HDr84OnvfycgOQQQ"
          },
          {
            "groupName": "个人标签",
            "tagName": "个人标签名",
            "type": "2"
          }
        ],
        "remarkMobiles": [
          "12123123"
        ]
      }
    ]
  },
  "timestamp": 123
}

参数说明：

名称	类型	必定存在	备注
type	string	是	固定为add_external_contact
event.ToUserName	string	是	企业id, 详见corpId
event.FromUserName	string	是	固定sys
event.CreateTime	string	是	添加时间（秒）
event.MsgType	string	是	固定event
event.Event	string	是	固定change_external_contact
event.ChangeType	string	是	固定add_external_contact/add_half_external_contact
event.UserID	string	是	成员id, 详见wxUserId
event.ExternalUserID	string	是	客户id, 详见externalUserId
event.State	string	否	添加此用户的「联系我」方式配置的state参数，可用于识别添加此用户的渠道, 详见state
event.WelcomeCode	string	否	欢迎语code，可用于发送欢迎语
data.unionId	string	否	客户unionId
data.externalUserId	string	是	客户id, 详见externalUserId
data.name	string	是	客户姓名
data.avatar	string	否	客户头像
data.gender	number	是	客户性别 0 -未知 1 -男性 2 -女性
data.type	number	是	客户的类型，1 表示该客户是微信用户，2 表示该客户是企业微信用户
data.followUser.userId	string	是	员工在企业微信中的userId, 详见wxUserId
data.followUser.name	string	是	员工姓名
data.followUser.avatar	string	否	员工头像
data.followUser.remark	string	是	当前员工给当前客户打的备注信息
data.followUser.createTimestamp	number	是	客户添加该员工时间戳（毫秒）
data.followUser.tags.groupName	string	是	该成员添加此客户所打标签的分组名称（标签功能需要企业微信升级到2.7.5及以上版本）
data.followUser.tags.tagName	string	是	该成员添加此客户所打标签名称
data.followUser.tags.type	string	是	该成员添加此客户所打标签类型, 1-企业设置, 2-用户自定义
data.followUser.tags.tagId	string	否	该成员添加此客户所打企业标签的id，仅企业设置（type为1）的标签返回, 详见wechatyTagId
data.followUser.remarkMobiles	string[]	是	该成员对此客户备注的手机号码
timestamp	number	是	时间戳（毫秒）

返回示例：

{
  "errCode": 0
}

客户信息变更

POST /crm-botorange/v1/notify/change/customer/info

请求参数Header:

sign=body+token 签名

请求参数Body:

{
  "type": "edit_external_contact",
  "event": {
    "ToUserName": "ww27f158d9319a1234",
    "FromUserName": "sys",
    "CreateTime": "1597931626",
    "MsgType": "event",
    "Event": "change_external_contact",
    "ChangeType": "edit_external_contact",
    "UserID": "rocky",
    "ExternalUserID": "wm6_UVDwAAPDG_9bTuPiv_8NxaH91234",
    "State": "8ff9cf31-98ce-4cce-88b3-53d123",
  },
  "data": {
    "unionId": "ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
    "name": "李四",
    "avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
    "externalUserId": "wmfvEMCAAAPHR9XslvYqTFgCJTULiZgg",
    "gender": 1,
    "type": 1,
    "followUser": [
      {
        "userId": "rocky",
        "name": "张三",
        "remark": "张总",
        "avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
        "createTimestamp": 1604048292000,
        "tags": [
          {
            "groupName": "标签组名",
            "tagName": "标签名",
            "type": "1",
            "tagId": "etDodGBwAA-rmc_3HDr84OnvfycgOQQQ"
          },
          {
            "groupName": "个人标签",
            "tagName": "个人标签名",
            "type": "2"
          }
        ],
        "remarkMobiles": [
          "12123123"
        ]
      }
    ]
  },
  "timestamp": 123
}

参数名称：

名称	类型	必定存在	备注
type	string	是	固定为edit_external_contact
event.ToUserName	string	是	企业id, 详见corpId
event.FromUserName	string	是	固定sys
event.CreateTime	string	是	添加时间（秒）
event.MsgType	string	是	固定event
event.Event	string	是	固定change_external_contact
event.ChangeType	string	是	固定edit_external_contact
event.UserID	string	是	成员id, 详见wxUserId
event.ExternalUserID	string	是	客户id, 详见externalUserId
event.State	string	否	添加此用户的「联系我」方式配置的state参数，可用于识别添加此用户的渠道, 详见state
data.unionId	string	否	客户unionId
data.externalUserId	string	是	客户id, 详见externalUserId
data.name	string	是	客户姓名
data.avatar	string	否	客户头像
data.gender	number	是	客户性别 0 -未知 1 -男性 2 -女性
data.type	number	是	客户的类型，1 表示该客户是微信用户，2 表示该客户是企业微信用户
data.followUser.userId	string	是	员工在企业微信中的userId, 详见wxUserId
data.followUser.name	string	是	员工姓名
data.followUser.avatar	string	否	员工头像
data.followUser.remark	string	是	当前员工给当前客户打的备注信息
data.followUser.createTimestamp	number	是	客户添加该员工时间戳（毫秒）
data.followUser.tags.groupName	string	是	该成员添加此客户所打标签的分组名称（标签功能需要企业微信升级到2.7.5及以上版本）
data.followUser.tags.tagName	string	是	该成员添加此客户所打标签名称
data.followUser.tags.type	string	是	该成员添加此客户所打标签类型, 1-企业设置, 2-用户自定义
data.followUser.tags.tagId	string	否	该成员添加此客户所打企业标签的id，仅企业设置（type为1）的标签返回, 详见wechatyTagId
data.followUser.remarkMobiles	string[]	是	该成员对此客户备注的手机号码
timestamp	number	是	时间戳（毫秒）

返回示例：

{
  "errCode": 0
}

删除客户或者被客户删除

POST /crm-botorange/v1/notify/del/customer

请求参数Header:

sign=body+token 签名

请求参数Body:

{
  "type": "del_external_contact",
  "event": {
    "ToUserName": "ww02f212d73c9dd123",
    "FromUserName": "sys",
    "CreateTime": "1597931626",
    "MsgType": "event",
    "Event": "change_external_contact",
    "ChangeType": "del_external_contact",
    "UserID": "rocky",
    "ExternalUserID": "wm0ZoZBwAAVinZ739MvTpccHQkHQx3gA"
  },
  "data": {
    "unionId": "ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
    "name": "李四",
    "avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
    "externalUserId": "wmfvEMCAAAPHR9XslvYqTFgCJTULiZgg",
    "gender": 1,
    "type": 1,
    "followUser": [
      {
        "userId": "rocky",
        "name": "张三",
        "remark": "张总",
        "avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
        "createTimestamp": 1604048292000,
        "tags": [
          {
            "groupName": "标签组名",
            "tagName": "标签名",
            "type": "1",
            "tagId": "etDodGBwAA-rmc_3HDr84OnvfycgOQQQ"
          },
          {
            "groupName": "个人标签",
            "tagName": "个人标签名",
            "type": "2"
          }
        ],
        "remarkMobiles": [
          "12123123"
        ]
      }
    ]
  },
  "timestamp": 123
}

参数说明：

名称	类型	必定存在	备注
type	string	是	固定为add_external_contact
event.ToUserName	string	是	企业id, 详见corpId
event.FromUserName	string	是	固定sys
event.CreateTime	string	是	添加时间（秒）
event.MsgType	string	是	固定event
event.Event	string	是	固定change_external_contact
event.ChangeType	string	是	固定del_external_contact/del_follow_user
event.UserID	string	是	成员id, 详见wxUserId
event.ExternalUserID	string	是	客户id, 详见externalUserId
data.unionId	string	否	客户unionId
data.externalUserId	string	是	客户id, 详见externalUserId
data.name	string	是	客户姓名
data.avatar	string	否	客户头像
data.gender	number	是	客户性别 0 -未知 1 -男性 2 -女性
data.type	number	是	客户的类型，1 表示该客户是微信用户，2 表示该客户是企业微信用户
data.followUser.userId	string	是	员工在企业微信中的userId, 详见wxUserId
data.followUser.name	string	是	员工姓名
data.followUser.avatar	string	否	员工头像
data.followUser.remark	string	是	当前员工给当前客户打的备注信息
data.followUser.createTimestamp	number	是	客户添加该员工时间戳（毫秒）
data.followUser.tags.groupName	string	是	该成员添加此客户所打标签的分组名称（标签功能需要企业微信升级到2.7.5及以上版本）
data.followUser.tags.tagName	string	是	该成员添加此客户所打标签名称
data.followUser.tags.type	string	是	该成员添加此客户所打标签类型, 1-企业设置, 2-用户自定义
data.followUser.tags.tagId	string	否	该成员添加此客户所打企业标签的id，仅企业设置（type为1）的标签返回, 详见wechatyTagId
data.followUser.remarkMobiles	string[]	是	该成员对此客户备注的手机号码
timestamp	number	是	时间戳（毫秒）

返回示例：

{
  "errCode": 0
}

秒回数据同步

POST /crm-botorange/v1/notify/change/customer/info

请求参数Header:

sign=body+token 签名

请求参数Body:

{
  "chatId": "5c6a35f629a2d9f8fcced6d0",
  "unionId": "ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
  "externalUserId": "wmfvEMCAAAPHR9XslvYqTFgCJTULiZgg",
  "userId": "rocky",
  "name": "李四",
  "avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
  "wxid": "12321312"
}

参数名称：

名称	类型	必定存在	备注
chatId	string	是	可用调用秒回api接口进行消息发送
unionId	string	是	客户unionId
name	string	是	客户姓名
externalUserId	string	是	客户id, 详见externalUserId
avatar	string	否	客户头像
userId	string	是	员工的userId, 详见wxUserId
wxid	string	是	客户的wxid, 详见contactWxid

返回示例：

{
  "errCode": 0
}

# API回调

# 新增客户

# 请求参数Header:

# 请求参数Body:

# 参数说明：

# 返回示例：

# 客户信息变更

# 请求参数Header:

# 请求参数Body:

# 参数名称：

# 返回示例：

# 删除客户或者被客户删除

# 请求参数Header:

# 请求参数Body:

# 参数说明：

# 返回示例：

# 秒回数据同步

# 请求参数Header:

# 请求参数Body:

# 参数名称：

# 返回示例：

API回调

新增客户

请求参数Header:

请求参数Body:

参数说明：

返回示例：

客户信息变更

请求参数Header:

请求参数Body:

参数名称：

返回示例：

删除客户或者被客户删除

请求参数Header:

请求参数Body:

参数说明：

返回示例：

秒回数据同步

请求参数Header:

请求参数Body:

参数名称：

返回示例：