# API回调

TIP

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

# 新增成员

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

# 请求参数Header:

sign=body+token 签名

# 请求参数Body:

{
  "type": "create_user",
  "event": {
    "AuthCorpId": "corpId",
    "InfoType": "change_contact",
    "TimeStamp": "123",
    "ChangeType": "create_user",
    "UserID": "userId",
    "Status": "1"
  },
  "data": {
    "userId": "zhangsan",
    "name": "张三",
    "email": "zhangsan@163.com",
    "isLogin": true,
    "avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0"
  },
  "timestamp": 123
}

# 参数说明:

名称 类型 必定存在 备注
type string 固定为create_user
event.AuthCorpId string 企业的CorpID
event.InfoType string 固定为change_contact
event.TimeStamp string 时间戳
event.ChangeType string 固定为create_user
event.UserID string userId
event.Status string 激活状态: 1=已激活,2=已禁用,4=未激活,5=退出企业
data.userId string 员工userId
data.name string 员工姓名
data.email string 员工邮箱
data.isLogin boolean 是否登录句子秒回
data.avatar string 员工头像
timestamp number 时间戳 (毫秒)

# 返回示例:

{
  "errCode": 0
}

# 新增客户

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

# 请求参数Header:

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
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
event.ExternalUserID string 客户id
event.State string 添加此用户的「联系我」方式配置的state参数,可用于识别添加此用户的渠道
event.WelcomeCode string 欢迎语code,可用于发送欢迎语
data.unionId string 客户unionId
data.externalUserId string 客户id
data.name string 客户姓名
data.avatar string 客户头像
data.gender number 客户性别 0 -未知 1 -男性 2 -女性
data.type number 客户的类型,1 表示该客户是微信用户,2 表示该客户是企业微信用户
data.followUser.userId string 员工在企业微信中的userId
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)的标签返回
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"
  },
  "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
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
event.ExternalUserID string 客户id
data.unionId string 客户unionId
data.externalUserId string 客户id
data.name string 客户姓名
data.avatar string 客户头像
data.gender number 客户性别 0 -未知 1 -男性 2 -女性
data.type number 客户的类型,1 表示该客户是微信用户,2 表示该客户是企业微信用户
data.followUser.userId string 员工在企业微信中的userId
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)的标签返回
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
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
event.ExternalUserID string 客户id
data.unionId string 客户unionId
data.externalUserId string 客户id
data.name string 客户姓名
data.avatar string 客户头像
data.gender number 客户性别 0 -未知 1 -男性 2 -女性
data.type number 客户的类型,1 表示该客户是微信用户,2 表示该客户是企业微信用户
data.followUser.userId string 员工在企业微信中的userId
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)的标签返回
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
avatar string 客户头像
userId string 员工的userId
wxid string 客户的wxid

# 返回示例:

{
  "errCode": 0
}
最近更新: 2022/5/11 上午10:44:50