内容中台技术手册
动态与公告
公告
发布记录
接口变更记录
对接必读
产品简介
名词解释
调用方式
公共代码
公共事件
账号开通
基础集成
单点登录
访客体系打通
数据推送
授权接口
管理集成
组织模型
企业配置接口
员工管理接口
集成配置接口
部门管理接口
编辑器集成
通用
集成页面
作品接口
统计数据接口
行为画像接口
传播脉络接口
模板接口
素材接口
分组接口
多人分发接口
作品共享接口
编辑器公共事件
黑名单管理
访客信息接口
互动
互动接口
活动参与信息接口
互动事件
自定义活动逻辑(抽奖等)
积分、权益体系集成
奖品库集成
互动任务
电子兑奖码
互动活动配置同步
地址库对接
活动白名单
收货地址自定义提交
表单
自定义表单提交
表单默认值自动填充
表单回传数据
表单选项数据结构
嵌入第三方页面
表单接口
H5
自定义下拉表单组件
任务组件
动态替换作品元素
H5接口
任务组件(新)
自定义js脚本(新)
渲染组件相关接口
数据集成
H5事件
留资玩法
长页
海报
基于模板生成图片
对接素材美化和编辑功能
海报事件
视频
服务集成
短信服务集成
素材库集成接口
自定义JS集成
审批工作流集成
红包服务集成
收款配置-小程序对接
移动端集成
Android SDK集成
iOS SDK集成
平台集成
集成申请
用户组织架构
平台接口
配置指南
企业配置
集成配置
商户号配置
最佳实践
年度总结H5
微信小程序嵌入H5
支付宝小程序嵌入H5
基于模板动态生成图片
跳转小程序页面
PC大转盘抽奖使用方法
私域分享增加权益
微信小程序对接互动默认商户号红包
常见问题
-
+
公共代码
>本节定义了内容中台接口协议中所涉及的所有字典表数据信息。 ## 系统返回状态码(StatusCode) - A开头表示客户端输入类异常 - B开头表示服务端逻辑异常 - C开头表示第三方服务异常 | **代码** | **描述** | | --- | --- | | 200 | 请求成功,正确返回 | | A000001 | 用户端异常 | | A000002 | 邮箱格式错误 | | A000003 | 手机号格式错误 | | A000004 | 验证码错误 | | A000005 | 令牌错误 | | A000006 | 参数值不在业务范围内 | | A000007 | 参数缺失 | | A000008 | 参数校验失败 | | A000009 | 参数不合法 | | A000010 | 非法请求 | | A000011 | 链接格式错误! | | A000012 | 文件大小不能超过1MB! | | A000013 | 文件格式不正确! | | A000014 | 请求方式不支持! | | A010101 | 账号和密码不能为空 | | A010102 | 密码错误 | | A010103 | 账号不存在 | | A010104 | 账号已存在 | | A010105 | 手机号或邮箱格式不正确 | | A010114 | 企业员工唯一标识为空 | | A010115 | 企业员工已经存在 | | A010116 | 企业员工不存在 | | A010117 | 登录限制 | | A010118 | 账号已停用 | | A010119 | 账号名或登录密码不正确 | | A010120 | 密码格式不正确, 8-20个字符, 不能与用户名相同 | | A010121 | 密码错误, 退出登录! | | A010130 | 登录限制-企业停用 | | A010201 | 企业ID不能为空 | | A010202 | 域名已被使用 | | A010203 | 域名格式不正确 | | A010301 | 手机与邮箱不能同时为空 | | A010302 | 员工ID不能为空 | | A010303 | 员工已存在 | | A010304 | 员工不存在 | | A010305 | 手机号已被注册 | | A010306 | 姓名不能为空 | | A010307 | 该员工为所有者,不可删除! | | A010313 | 抱歉,添加成员已达上限,如有需要,请联系平台或者客户成功服务。! | | A010401 | 一级部门不能删除 | | A010402 | 部门存在员工 | | A010403 | 部门id不能为空 | | A010404 | 部门名称不能为空 | | A010405 | 部门已存在 | | A010406 | 八级部门不能添加子部门 | | A010501 | 角色下存在员工 | | A010601 | 至少配置一项角色权限 | | A010602 | 至少配置一项数据权限 | | A010701 | 密钥key格式不正确 | | A010702 | 密钥创建失败, 请稍后再试! | | A010703 | 密钥ID不存在 | | A010704 | 密钥ID已启用 | | A010705 | 密钥ID已禁用 | | A010706 | 无此密钥ID操作权限 | | A010707 | 请先配置回调密钥 | | A010801 | 不支持的类型! | | A010802 | 用户自主设置已启用自定义用户, 不可取消! | | A010803 | url返回数据格式不合法 | | A011001 | token参数缺失 | | A011002 | secretId参数缺失 | | A011003 | 签名校验失败 | | A011004 | 非法请求 | | A011005 | token已失效 | | A011006 | secretId与token不匹配 | | A011007 | 签名加密方法不支持 | | A011008 | 授权码无效 | | A011009 | 接口访问过于频繁 | | A011010 | openId不存在 | | A011011 | appId不能为空 | | A011012 | signature不能为空 | | A011013 | timestamp不能为空 | | A011101 | 该应用不存在! | | B000001 | 服务端异常 | | B000002 | 未登录或Session已过期 | | B000003 | 没有权限 | | B000004 | 验证码发送失败 | | B000005 | 数据不存在 | | B000006 | 验证码验证失败 | | B000007 | 数据不合法 | | B010201 | 企业已存在 | | B010801 | appId错误或app不存在 | | B010802 | 请求数据错误 | | C000001 | 第三方服务异常 | | C000002 | 第三方返回空 | | C010201 | 添加域名解析失败 | | C010202 | 更换域名失败 | | C010203 | 企业名称不能为空 | ## 作品类型(OpusType) | **代码** | **描述** | | --- | --- | | hd | 互动 | | h5 | 翻页 | | lc | 长页 | | design | 海报 | | form | 表单 | ## 作品发布状态(OpusStatus) | **代码** | **描述** | | --- | --- | | -1 | 已删除 | | 1 | 未发布 | | 2 | 已发布 | | 3 | 已暂停、临时关闭 | | 4 | 已停用 | | 5 | 已结束 | ## 作品与作品状态对应关系 | **作品类型** | **状态** | | --- | --- | | hd互动 | -1已删除,1未发布,2已发布,3已暂停,4已停用【手动结束】,5已结束【自动结束】 | | h5翻页 | -1已删除,1未发布,2已发布| | lc长页 | -1已删除,1未发布,2已发布| | form表单 | -1已删除,1未发布,2已发布,5已结束| | design海报 | -1已删除,1未发布,2已发布| ## 素材类型(SourceType) | **代码** | **描述** | | --- | --- | | 1 | 图片 | | 2 | 音乐 | | 3 | 视频 | ## 分发类型(ShareType) | **代码** | **描述** | | --- | --- | | 1 | 个人 | | 2 | 部门级以下 | | 3 | 全部 | ## 数据统计范围(StatisticsType) | **代码** | **描述** | | --- | --- | | 1 | 今日数据 | | 2 | 昨日数据 | | 3 | 近7日数据 | | 4 | 总数据 | ## 活动状态(ActivityStatus) **只有互动,表单这些可设置开始时间、结束时间作品,此状态才有意义,其他作品返回-1** | **代码** | **描述** | | --- | --- | | 1 | 未开始 | | 2 | 进行中 | | 3 | 暂停中 | | 4 | 已结束 | | -1 | 未发布未开始(无实际意义) | | ~~-4~~ | ~~非已结束~~ | ## 表单类型(FormType) | **代码(extra)** | **描述** | | --- | --- | | QUESTIONNAIRE | 问卷 | | VOTE | 投票 | | ENROLL | 报名 | | EXAM | 考试 | ## 海报类型(DesignType) | **代码(extra)** | **描述** | **尺寸** | | --- | --- | --- | | 10 | 公众号封面小图 | 200*200 px | | 11 | 公众号底部二维码 | 600*600 px | | 12 | 微博封面图 | 922*302 px | | 13 | 微博焦点图 | 560*260 px | | 14 | 微信朋友圈方图 | 400*400 px | | 15 | 朋友圈邀请函 | 720*1280 px | | 16 | 手机海报 | 640*1008 px | | 17 | 手机截屏 |720*1280 px | | 19 | 淘宝banner |1920*600 px | | 20 | 新版微信公众号首图 |900*383 px | | 24 | 日签 |1125*2436 px | | 25 | 企业红包封面 |957*1584 px | | 30 | PC端banner |1920*450 px | | 31 | 微信横板海报 |900*500 px | | 33 | 商品详情页 |790*5000 px | | 34 | 电脑壁纸 |1920*1080 px | | 35 | 手机壁纸 |720*1280 px | | 36 | 移动端开屏广告 |1080*1920 px | ## 奖品兑换状态(ExchangeStatus) | **代码** | **描述** | | --- | --- | | 0 | 未兑奖 | | 1 | 已兑奖 | ## 奖券状态(LotteryStatus) | **代码** | **描述** | | --- | --- | | 0 | 使用中(已绑定到作品,未发到用户) | | 1 | 已发放(已绑定作品,用户中奖) | | 3 | 未使用(初始化导入,未绑定作品) | ## 奖品等级(PrizeLevel) | **代码** | **描述** | | --- | --- | | 1 | 一等奖 | | 2 | 二等奖 | | 3 | 三等奖 | | 4 | 四等奖 | | 5 | 五等奖 | | 6 | 六等奖 | | 7 | 七等奖 | | 8 | 八等奖 | ## 奖品状态(PrizeStatus) | **代码** | **描述** | | --- | --- | | 0 | 待发放(未填写地址) | | 1 | 已发放 | | 2 | 已领取 | | 3 | 未领取 | | 5 | 未发货 | | 6 | 已发货 | ## 奖品类型(PrizeType) | **代码** | **描述** | | --- | --- | | 0 | 礼品 | | 1 | 优惠券 | | 2 | 现金红包 | | 3 | 电子兑奖码 | | 4 | 积分 | ## 作品业务类型(BizType) | **作品类型** | **代码** | **描述** | | --- | --- | --- | | hd | 1 | 游戏 | | hd | 2 | 抽奖 | | hd | 11 | 抽奖+游戏 | | hd | 12 | 签到 | | hd | 222 | 助力 | | form | 101 | 问卷调查 | | form | 102 | 投票评选 | | form | 103 | 报名登记 | | form | 104 | 考试测评 | ## 互动子页面定义 | **代码** | **描述** | | --- | --- | | hd_index | 活动首页 | | hd_desc | 活动说明 | | hd_game_index | 游戏页面 | | hd_game_success | 成功页面 | | hd_game_fail | 失败页面 | | hd_reward_detail | 抽奖详情 | | hd_lottery_index | 抽奖页面 | | hd_lottery_success | 中奖页面 | | hd_lottery_fail | 未中奖页面 | ## 表单子页面定义 | **代码** | **描述** | | --- | --- | | form_1_cover | 封面页 | | form_2_content | 答题页 | | form_3_submit | 提交页 | ## 翻页H5子页面定义 翻页h5为多页作品,每个子页面有对应的ID 可通过接口[获取翻页h5的子页面接口](https://hc.eqxiu.cn/doc/35/) ![](/media/202209/2022-09-29_104045_326630.png) | **代码** | **描述** | | --- | --- | |子页面 ID| 具体的页面ID | ## 长页子页面定义 单页作品,子页面不存在,所以子页面为第一页 | **代码** | **描述** | | --- | --- | |第一页| 第一页 |
will
June 20, 2023, 9:56 a.m.
5340
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码