访客信息接口

获取访客信息

接口描述：根据encodeId获取访客信息。
接口地址：/api/v1/biz/customer/info?token=TOKEN
方法类型：GET

接口入参

参数名	是否必须	参数类型	参数说明
token	必须	String	内容平台后端交互令牌
encodeId	必须	String	访客在内容中台的唯一标识，可通过自定义授权的userId换取，或者在部分业务场景下链接上会携带

返回值示例

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": {
      "authType": 3,
      "nickName": "郑伯yangxu",
      "sex": null,
      "headImgUrl": "https://asset.eqxiu.cn/common/benefit.png",
      "unionId": null,
      "thirdOpenId": null,
      "thirdAppId": null,
      "thirdUserId": "d0ae5318456a44379eb9ab689937931e",
      "mobile": "136****8789"
  },
  "map": null,
  "list": null,
  "details": null
}

返回值说明

参数名	参数类型	参数说明	备注
authType	Int	授权方式	1.微信授权 2.手机号授权 3.自定义授权
nickName	String	昵称
sex	Int	性别	1.男 2.女
headImgUrl	String	头像
unionId	String	微信unionId	authType为1有效
thirdAppId	String	微信appId	authType为1有效
thirdOpenId	String	微信openId	authType为1有效
thirdUserId	String	用户id	authType为3有效
mobile	String	手机号	authType为2有效

自定义授权userId转encodeId

接口描述：根据自定义授权的userId获取encodeId。
接口地址：/api/v1/biz/customer/encodeId?token=TOKEN
方法类型：GET

接口入参

参数名	是否必须	参数类型	参数说明
token	必须	String	内容平台后端交互令牌
thirdUserId	必须	String	访客体系打通中“获取用户信息接口规范”返回的userId

返回值示例

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": {
      "encodeId": "e704226d492b4953b00589035bf8af42"
  },
  "map": null,
  "list": null,
  "details": null
}

返回值说明

参数名参数类型参数说明备注

encodeId String 访客在内容中台的唯一标识可通过自定义授权的userId换取，或者在部分业务场景下链接上会携带

获取授权访客明细

接口描述：获取授权访客明细
接口地址：/api/v1/editor/statistic/auth/visitor/list?token=TOKEN
方法类型：GET

接口入参

参数名	是否必须	参数类型	参数说明
token	是	String	内容平台后端交互令牌
creationId	是	int	作品ID
startDay	否	String	开始日期
endDay	否	String	结束日期
name	否	String	访客名称
pageNo	否	int	页数，默认值为1
pageSize	否	int	条数，默认值为10

返回值示例

{
  "success": true,
  "code": 200,
  "msg": "操作成功",
  "obj": null,
  "map": {
      "pageNo": 1,
      "count": 3,
      "pageSize": 10,
      "end": true
  },
  "list": [
      {
          "id": 29069777,
          "nickName": "匿名用户",
          "headImgUrl": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTIlrUcod3kHAntcBmfPfA2Fcibf6oujS7SZM2FFUmmLiblUmHsfNyIn9fy0vxyhNCjp2pqiacNy2IYgQ/132",
          "creationId": 167112,
          "encodeId": "5ed01d5f978f4e399980b7bb993d9029",
          "fromEncodeId": null,
          "previewCount": 2,
          "subFormCount": 0,
          "partakeCount": 0,
          "lotteryCount": 1,
          "taskCount": 0,
          "formMsgCount": null,
          "type": 1,
          "level": 1,
          "toCount": 0,
          "unionId": "oW-IQv1XR9Xy6Lf84uJqqfQcA4vA",
          "thirdAppId": "wx0424aefe853c387c",
          "thirdOpenId": "oYy90xJOm2Pze2oqEBnmQhI0Xa7o",
          "thirdUserId": null,
          "mobile": null,
          "firstTime": "2023-06-26 10:53:59",
          "lastTime": "2023-06-26 11:20:01",
          "channal": null,
          "channelName": null,
          "creationType": "hd",
          "channelNameMans": null
      }
  ]
}

返回值说明

参数名	参数类型	参数说明	备注
nickName	String	访客名称
headImgUrl	String	头像
encodeId	String	访问ID
headImgUrl	String	头像
firstTime	String	首次访问时间
lastTime	String	最后访问时间
previewCount	int	访问记录
subFormCount	int	提交表单
partakeCount	int	参与游戏
lotteryCount	int	参与抽奖
taskCount	int	参与任务
level	int	所属层级
toCount	int	裂变人数
type	int	授权类型 1-微信授权 2-手机号授权 3-自定义授权 4-无授权
creationType	String	作品类型
unionId	String	微信unionId	authType为1有效
thirdAppId	String	微信appId	authType为1有效
thirdOpenId	String	微信openId	authType为1有效
thirdUserId	String	用户id	authType为3有效
mobile	String	手机号	authType为2有效

访客提前注册

接口描述：访客还没登录易企秀平台的情况下可以通过接口提前注册。
接口地址：/api/v1/biz/customer/register?token=TOKEN
方法类型：POST
接口入参

参数名是否必须参数类型参数说明

thirdUserId 必须 String 三方用户id，最长支持64位

返回值示例

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": null,
  "map": null,
  "list": null,
  "details": null
}