内容中台技术手册
动态与公告
公告
发布记录
接口变更记录
对接必读
产品简介
名词解释
调用方式
公共代码
公共事件
账号开通
基础集成
单点登录
访客体系打通
数据推送
授权接口
管理集成
组织模型
企业配置接口
员工管理接口
集成配置接口
部门管理接口
编辑器集成
通用
集成页面
作品接口
统计数据接口
行为画像接口
传播脉络接口
模板接口
素材接口
分组接口
多人分发接口
作品共享接口
编辑器公共事件
黑名单管理
访客信息接口
互动
互动接口
活动参与信息接口
互动事件
自定义活动逻辑(抽奖等)
积分、权益体系集成
奖品库集成
互动任务
电子兑奖码
互动活动配置同步
地址库对接
活动白名单
收货地址自定义提交
表单
自定义表单提交
表单默认值自动填充
表单回传数据
表单选项数据结构
嵌入第三方页面
表单接口
H5
自定义下拉表单组件
任务组件
动态替换作品元素
H5接口
任务组件(新)
自定义js脚本(新)
渲染组件相关接口
数据集成
H5事件
留资玩法
H5定位打卡:支持在非微信环境下使用
长页
海报
基于模板生成图片
对接素材美化和编辑功能
海报事件
视频
服务集成
短信服务集成
素材库集成接口
自定义JS集成
审批工作流集成
红包服务集成
收款配置-小程序对接
移动端集成
Android SDK集成
iOS SDK集成
平台集成
集成申请
用户组织架构
平台接口
配置指南
企业配置
集成配置
商户号配置
最佳实践
年度总结H5
微信小程序嵌入H5
支付宝小程序嵌入H5
基于模板动态生成图片
跳转小程序页面
PC大转盘抽奖使用方法
私域分享增加权益
微信小程序对接互动默认商户号红包
常见问题
-
+
访客信息接口
## 获取访客信息 - 接口描述:根据encodeId获取访客信息。 - 接口地址:/api/v1/biz/customer/info?token=TOKEN - 方法类型:GET - 接口入参 | 参数名 | 是否必须 | 参数类型 | 参数说明 | | --- | --- | --- | --- | | token | 必须 | String | 内容平台后端交互令牌 | | encodeId | 必须 | String | 访客在内容中台的唯一标识,可通过自定义授权的userId换取,或者在部分业务场景下链接上会携带 | - 返回值示例 ```json { "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 | [访客体系打通](https://hc.eqxiu.cn/doc/23/ "访客体系打通")中“获取用户信息接口规范”返回的userId | - 返回值示例 ```json { "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 | - 返回值示例 ```json { "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位 | - 返回值示例 ```json { "success": true, "code": "200", "msg": null, "obj": null, "map": null, "list": null, "details": null } ```
旭
2024年6月3日 09:25
3252
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码