API文档

# 客户中心数据

# 接口说明

项 值
URL /openapi/v1/customer/list.json
描述 客户中心数据
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
id long 客户ID 非必传，传参之后取id 之后的数据 否

# 分页对象

字段名 字段类型 说明 是否必传
pageSize number 页大小 是。区间 (0,100]
pageNum number 页码 是。从1开始

# 请求数据

{
  "id": 100,  
  "pageDto": {
    "pageNum": 1,
    "pageSize": 20
  }
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": [
    {
      "id": 46,
      "customerNum": "LBQyXYbABO",
      "name": "漫漫",
      "mobile": null,
      "avatar": "http://wx.qlogo.cn/mmhead/U0icibv8iaDaw61tzAaOqDfRPM8fm7ctN3SyEwqVDjR1qCldxrz3qPibjWzn5l3YD4y7dp98dbicwQhI/0",
      "unionId": "odzSQxNcHKaMChbT6RuRHeh_WXp4"
    }
  ],
  "pageDto": {
    "count": 0,
    "curPageCount": null,
    "pageNum": 1,
    "pageSize": 20,
    "needCount": true,
    "totalPageNum": 0,
    "offset": 0
  }
}

# 第三方账号注册登录

# 接口说明

项 值
URL /openapi/v1/customer/thirdAccountLogin.json
描述 第三方账号注册登录
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
account string 第三方的客户唯一ID 是
nickname string 第三方的客户昵称 否
avatar string 第三方的客户头像地址 否

# 请求数据

{
  "account": "182xxxx1928",
  "nickname": "漫漫",
  "avatar": "http://wx.qlogo.cn/mmhead/U0icibv8iaDaw61tzAaOqDfRPM8fm7ctN3SyEwqVDjR1qCldxrz3qPibjWzn5l3YD4y7dp98dbicwQhI/0"
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": {
    "customerNum": "xxxxx" // 该客户在短训宝的唯一ID
  }
}

# 客户动态轨迹列表

# 接口说明

项 值
URL /openapi/v1/customer/route.json
描述 客户动态轨迹列表
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
pageDto object 分页对象 是
unionId string 微信unionId 是
startTime number 开始时间戳,毫秒级 否
endTime number 结束时间戳,毫秒级 否
routeTypes array 轨迹类型。 否

# 分页对象

字段名 字段类型 说明 是否必传
pageSize number 页大小 是。区间 (0,100]
pageNum number 页码 是。从1开始

# 轨迹类型

类型 说明
clickGoods 点击商品
getCoupon 领取优惠券
live 观看直播
livePlayback 观看回放
hitLiveKeyword 直播间发言命中关键词
payOrder 支付订单
payTimeout 超时未支付
payCanceled 取消支付
bookLive 预约直播
addContact 成为好友
joinRoom 进入群聊
delContact 删除好友
delFollowUser 被好友删除
quitRoom 退出群聊
visitPage 用户访问页面
addMobile 加手机号
fansSubscribe 粉丝关注
fansUnSubscribe 粉丝取消关注
orderRefund 退款
signContract 签署合同
bindRelations 绑定客户中心id
unbindRelations 解绑客户中心id

# 请求数据

{
  "unionId": "oIG7o1dPVcEc4bVNNA1-_66Ev-ZQ",
  "routeTypes": [],
  "pageDto": {
    "pageSize": 20,
    "pageNum": 1
  }
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": [{
    "eventType": "payTimeout", // 轨迹类型
    "customerNum": "AQLt9x35VR",
    "eventTime": "2024-12-02 19:43:00",
    "eventData": {  // 相关事件的数据 不同的轨迹类型 数据不同 下面有部分示例
      "accessNum": null,
      "page": null,
      "sharer": null,
      "visitor": null,
      "module": {
        "type": "trade",
        "num": null,
        "name": "商品订单",
        "planType": null,
        "channelId": null,
        "siteNumber": null,
        "weworkUserName": null,
        "productId": "202403060926551642",
        "productName": "周三营期一",
        "liveId": null,
        "liveType": null
      },
      "orderNo": "24120219144473718417",
      "orderAmount": 100
    },
    "source": "trade"
    },
    {
      "eventType": "clickGoods",
      "customerNum": "AQLt9x35VR",
      "eventTime": "2024-12-02 19:14:40",
      "eventData": {
        "accessNum": "AQv8BRCTM9",
        "page": null,
        "sharer": null,
        "visitor": {
          "type": 1,
          "refer": "https://a.test-dxb.baijiayun.com/indexh5",
          "client": "wx",
          "appId": "wxc990735a7cf7473a",
          "openId": "oImLh0jBDg4vg21N4LqbrIvJW9-Q",
          "contactId": null,
          "unionId": "oIG7o1dPVcEc4bVNNA1-_66Ev-ZQ",
          "name": "wxy",
          "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/AhmGcHibT6vLGBib1Q71GoNB2wjyXZibsPEQXaDqxTkTxs0m6KQ1zCIF0SXMFxGv5f2OonsONmqLIcokIaKAqD0vg/132",
          "country": null,
          "province": null,
          "city": null,
          "ip": "122.190.49.28",
          "userAgent": "Mozilla/5.0 (Linux; Android 11; M2012K11AC Build/RKQ1.200826.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/130.0.6723.103 Mobile Safari/537.36 XWEB/1300125 MMWEBSDK/20241103 MMWEBID/625 MicroMessenger/8.0.54.2760(0x2800363D) WeChat/arm64 Weixin NetType/WIFI Language/zh_CN ABI/arm64",
          "cookie": null,
          "mobile": null,
          "uniqId": null,
          "userId": null,
          "bjyNum": null,
          "bjyName": null
        },
        "module": {
          "type": "trade",
          "num": null,
          "name": "商品订单",
          "planType": null,
          "channelId": null,
          "siteNumber": null,
          "weworkUserName": null,
          "productId": "202403060926551642",
          "productName": "周三营期一",
          "liveId": null,
          "liveType": null
        }
      },
      "source": "app"
    },
    {
      "eventType": "livePlayback",
      "customerNum": "AQ5gEiIEk6",
      "eventTime": "2024-12-02 19:07:32",
      "eventData": {
        "accessNum": null,
        "page": {
          "title": "wxy1114直播验证1",
          "url": "https://e45805187.test-at.baijiayun.com/web/room/quickenter?code=jbfnea${customstr}",
          "sourceUrl": null,
          "shortUrl": null,
          "icon": null
        },
        "sharer": {
          "userId": 11324,
          "name": "wxy",
          "weworkUserId": null
        },
        "visitor": {
          "type": null,
          "refer": null,
          "client": null,
          "appId": null,
          "openId": null,
          "contactId": null,
          "unionId": null,
          "name": "wxy",
          "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/AhmGcHibT6vLGBib1Q71GoNB2wjyXZibsPEQXaDqxTkTxs0m6KQ1zCIF0SXMFxGv5f2OonsONmqLIcokIaKAqD0vg/132",
          "country": null,
          "province": null,
          "city": null,
          "ip": null,
          "userAgent": null,
          "cookie": null,
          "mobile": null,
          "uniqId": null,
          "userId": null,
          "bjyNum": null,
          "bjyName": null
        },
        "module": {
          "type": "live",
          "num": "AQ5Yc6UKdl", // 直播记录唯一ID
          "name": "wxy1114直播验证1",
          "planType": null,
          "channelId": null,
          "siteNumber": null,
          "weworkUserName": null,
          "productId": null,
          "productName": null,
          "liveId": 11156,
          "liveType": 1
        },
        "accessInfo": {
          "visitBeginTime": "2024-12-02 19:01:34",
          "visitEndTime": "2024-12-02 19:03:00",
          "stayTime": 64000,
          "finishPercent": null
        }
      },
      "source": "live"
    },
    {
      "eventType": "payOrder",
      "customerNum": "AQ5gEiIEk6",
      "eventTime": "2024-12-02 19:01:42",
      "eventData": {
        "accessNum": null,
        "page": null,
        "sharer": null,
        "visitor": null,
        "module": {
          "type": "live",
          "num": "AQ5Yc6UKdl",
          "name": "wxy1114直播验证1",
          "planType": null,
          "channelId": null,
          "siteNumber": null,
          "weworkUserName": null,
          "productId": "202410221656359578",
          "productName": "手机号必填",
          "liveId": 11156,
          "liveType": 1
        },
        "orderNo": "24120219013250444925",
        "orderAmount": 100,
        "payAmount": 100,
        "payChannelName": "微信公众号支付"
      },
      "source": "trade"
    },
    {
      "eventType": "live",
      "customerNum": "AQ5gEiIEk6",
      "eventTime": "2024-12-02 18:56:16",
      "eventData": {
        "accessNum": null,
        "page": {
          "title": "直播带货1202-1",
          "url": "https://e45805187.test-at.baijiayun.com/web/room/quickenter?code=3b9vfk${customstr}",
          "sourceUrl": null,
          "shortUrl": null,
          "icon": null
        },
        "sharer": {
          "userId": 11324,
          "name": "wxy",
          "weworkUserId": null
        },
        "visitor": {
          "type": null,
          "refer": null,
          "client": null,
          "appId": null,
          "openId": null,
          "contactId": null,
          "unionId": null,
          "name": "wxy",
          "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/AhmGcHibT6vLGBib1Q71GoNB2wjyXZibsPEQXaDqxTkTxs0m6KQ1zCIF0SXMFxGv5f2OonsONmqLIcokIaKAqD0vg/132",
          "country": null,
          "province": null,
          "city": null,
          "ip": null,
          "userAgent": null,
          "cookie": null,
          "mobile": null,
          "uniqId": null,
          "userId": null,
          "bjyNum": null,
          "bjyName": null
        },
        "module": {
          "type": "live",
          "num": "AQ5reNv4iy",
          "name": "直播带货1202-1",
          "planType": null,
          "channelId": null,
          "siteNumber": null,
          "weworkUserName": null,
          "productId": null,
          "productName": null,
          "liveId": 11155,
          "liveType": 1
        },
        "accessInfo": {
          "visitBeginTime": "2024-12-02 18:53:40",
          "visitEndTime": "2024-12-02 18:56:15",
          "stayTime": 155000,
          "finishPercent": null
        }
      },
      "source": "live"
    }
  ],
  "pageDto": {
    "count": 26,
    "curPageCount": 0,
    "pageNum": 1,
    "pageSize": 20,
    "needCount": true,
    "offset": 0,
    "totalPageNum": 2
  }
}

# 修改客户昵称头像

# 接口说明

项 值
URL /openapi/v1/customer/editInfo.json
描述 修改客户昵称头像
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
customerNum string 客户Num 是
name string 修改后昵称 昵称和头像不能同时为空
avatar string 修改后头像 昵称和头像不能同时为空

# 请求数据

{
  "customerNum": "xxxx",  
  "name": "修改后昵称",
  "avatar": "修改后头像"
}

# 返回数据

{
  "msg": "",
  "code": 200,
  "data": "",
  "pageDto": null
}

← 回调消息 →