互动活动配置同步

# 互动通知绑定接口
## 功能效果

绑定接口互动编辑页面会出现“导入活动配置按钮”
![](/media/202301/2023-01-31_174746_8147340.3227339227133643.png)
录入参数后点击确认通知绑定的接口

## 配置接口
应用管理-互动编辑器-活动导入设置绑定接口
![](/media/202301/2023-01-31_175104_8234890.6856454533410413.png)
## 配置说明

| 页面名称 | 使用说明 |
| --- | --- |
| 导入信息通知接口 | 通知的接口 |
| 请输入参数 | 该接口的参数 |
| 更新字段 | 选择更新互动作品的字段 |
| 更新字段是否可修改 | 否：编辑器页面无法手动修改 |

## 接口规范
- 方法类型：POST

- Content-Type：application/json

- 接口入参
```json
{
    "creationId":100,
    "otherParam":{
        "x1":"xxx",
        "x2":"xxx"
        .....
    }
}
```
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| nonce | 是 | String | 随机字符串 |
| timestamp | 是 | Long | 当前 UNIX 时间戳，可记录发起 API 请求的时间。例如1529223702 |
| signature | 是 | String | 请求签名。 |
| msgEncrypt | 是 | String | 数据明细,不同业务类型，数据格式不一样 |

- msgEncrypt解密数据格式 
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
|creationId|是|Long|作品ID|
|otherParam|否|JSONObject|活动导入设置的灵活参数|

- 接口返回值
```json
{
	"success": true，
	"code":"200",
	"msg":"操作成功"，
	"data":{
		"bindCreationId":"荣数绑定易企秀作品的参数值",
		"hdSetting":{
			"activityName":"我是活动名称",
			"startTime":"2022-11-18 15:44:17",
			"endTime":"2022-11-18 15:44:17",
			"loginPosition":0,
			"myPrizeType":1,
			"prizes":[
				{
					"prizeLevel":0,
					"prizeLevelName":"一等奖",
					"prizeName":"手机",
					"prizeCode":"奖品代码",
					"prizeDesc":"奖品描述",
					"prizeImg":"http://xxx.png",
					"redemptionAddr":"http://www.baidu.com"
				},
				 {
					"prizeLevel":1,
					"prizeLevelName":"二等奖",
					"prizeName":"电脑",
					"prizeCode":"奖品代码",
					"prizeDesc":"奖品描述",
					"prizeImg":"http://xxx.png",
					"redemptionAddr":"http://www.baidu.com"
				}
			]
		}
	}
}
```
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
|success|是|Boolean|成功状态|
|code|是|String|状态码，200请求正确，其他视为失败|
|msg|是|String|返回消息|
|data.bindCreationId|是|String|绑定易企秀作品的参数值|
|data.hdSetting|否|Object|配置更新数据（参照互动活动配置同步接口参数）|

# 互动活动配置同步接口
## 接口说明
本接口协议是方便企业用户通过调用本接口将互动活动的配置信息进行更新。
## 接口规范
- 接口地址: /api/v1/editor/hd/creation/setting/update?token=TOKEN

- 请求方式：POST

- Content-Type：application/json

- 请求参数
```json
{
    "bindCreationId":"12345",
    "myPrizeType":1,
    "loginPosition":1,
    "winNum":11,
    "myPrizeLink":"https://mallb.leagpoint.com/",
    "activityRules":1,
    "activityName":"game test",
    "styleType":2,
    "place1":4,
    "lotteryScore":"0",
	"activityDescription": "活动说明",
    "prizes":[
        {
            "prizeDesc":"这个奖品",
            "prizeLevelName":"1等奖",
            "prizeLevel":0,
            "prizeName":"0奖品序号",
            "redemptionAddr":"http://www.baidu.com",
            "prizeCode":"abc0",
            "prizeImg":"https://asset.eqxiu.cn/common/icon-wechat.png",
            "prizeNum":25,
            "prizeType":0, //奖品类型 0-礼品 1-门店优惠劵 4-积分
            "maxCanWinNum":33, //最多中奖次数
            "amount": 12, //单次中奖数量
            "cycleReleasePrizeNum":99, //奖品库存释放量
            "cyclePrize": false, //奖品库存释放 false-不限制 true-限制
            "startRedemptionTime": 1725355667000, //兑奖开始时间
            "endRedemptionTime": 1726651667000, //兑奖结束时间
            "redemptionDesc":"111" //兑奖须知
        }
    ],
    "gamePrizeSetting":[
        {
            "prizeType":2,
            "open":1,
            "rankType":1,
            "prizes":[
                {
                    "prizeLevelName":"1等奖",
                    "prizeLevel":0,
                    "rankStart":1,
                    "rankEnd":2
                }
            ]
        },
        {
            "prizeType":1,
            "open":1,
            "prizes":[
                {
                    "prizeLevelName":"1等奖",
                    "prizeLevel":0,
                    "score":10,
                    "prizeNum":5
                }
            ]
        }
    ],
    "property":{
        "benefitOpen":1,
        "benefitUrl":"",
        "sceneTempConfig":{
            "bgType":"outerLink",
            "bgOuterLink":"https://www.baidu.com"
        }
    },
    "lotterySetting":{
        "multiDraw":1,
        "drawNum":10,
        "preTip":1,
        "preTipSetting":{
            "img":"http://asset.eqxiu.cn/60418abc9bba44d0934e8d873654d854%5C168b1aad684d497481b3c7e0816af38a.png?imageMogr2/cut/!80x45a10a28",
            "btn":"http://asset.eqxiu.cn/60418abc9bba44d0934e8d873654d854/55a07994fb314826bc4e365c5d6dbafb.png?imageMogr2/cut/!277x49a35a206",
            "showTip":1,
            "showTipDefault":1
        },
		"lotterySetting.shufflingDyn":{
        "showUserTypeList":[1,2],// 1：头像、2：昵称
        "showPrizeTypeList":[1,2],// 1：奖品等级、2：奖品名称
        "maxShowNumber":3//展示最大条数限制
		"gameTimes":2, //次数限制 1无限制 2是限制，3 是分渠道限制
        "totalChance":33, //总次数
		"winNum": 1, //最多中奖次数
        "chance": {  //天/月次数限制，monthChance和dayChance只能传1个
            "monthChance": 3,
            "dayChance": 3
        },
		
        "channelSetting": { //渠道设置
            "channelWx": {
                "enable": true, //是否开启
                "voteNum": 3,//数量
                "key": "wx"//渠道标识
            },
            "channelMobile": {
                "enable": true,
                "voteNum": 1,
                "key": "mo"
            },
            "customChannelList": [
                {
                    "channelName": "自定义",
                    "enable": true,
                    "voteNum": 1,
                    "keyPrefix": "ori_",
                    "keyVal": "test",
                    "key": "ori_test"
                }
            ],
            "channelAll": {//总渠道限制
                "enable": true,
                "voteNum": 1
            }
        },
        "winRateType":1, //中奖率类型 1：综合中奖率 2：单个中奖率
        "totalProbability":98, //综合中奖率
        "winRate":[1,22,55], //单个中奖率
		"rewardRankTypes":[1,2,3,4], //奖励排行类型
		"showRankTypes":[1,2,3,4] // 展示排行榜类型
      }
    },
    "customSetting":{
        "customList":[
            {
                "actionAfterEnd":0,
                "customType":3,
                "jsId":100845
            },
            {
                "actionAfterEnd":1,
                "customType":3,
                "jsId":10553
            },
			{
                "actionAfterEnd": 0,
                "customType": 2,
                "clickTriggersType": "event",
                "eventTriggersType": "lottery",
                "imgUrl": "https://asset.eqxiu.cn/485fb498bfb343fa9bcf883247e9b3a1/4d565fac27eb43c1b6111ee1d8293c23.png"
            },
			{
                "actionAfterEnd": 0,
                "customType": 2,
                "clickTriggersType": "0"
            },
			{
              "actionAfterEnd": 0,
              "customType": 2,
              "clickTriggersType": "customComp",
              "eventTriggersType": "",
              "jsId": 11157,
              "imgUrl": "https://asset.eqxiu.cn/485fb498bfb343fa9bcf883247e9b3a1/4d565fac27eb43c1b6111ee1d8293c23.png"
          }
        ]
    },
    "pageInfo":{
        "singleDrawImg":"http://asset.eqxiu.cn/60418abc9bba44d0934e8d873654d854%5C168b1aad684d497481b3c7e0816af38a.png?imageMogr2/cut/!80x45a10a28",
        "multiDrawImg":"http://asset.eqxiu.cn/60418abc9bba44d0934e8d873654d854%5C168b1aad684d497481b3c7e0816af38a.png?imageMogr2/cut/!80x45a10a28"
    },
	"shareSetting": {
                "customBtnShow": 1,// 对应自定义按钮，1：显示、0：隐藏
                "shareRadioType": 1,// 按钮类型（1：一键关注、2：跳转页面、3：小程序普通链接、4：小程序tabbar页面）
                "shareRadioUrl": "/kkkkk"// 链接地址（二维码为图片地址）
        }
}
```

- 参数说明
| 参数名 | 是否必须 | 参数类型 | 参数说明 | 长度限制 | 备注 |
| --- | --- | --- | --- | --- | --- |
|creationId|否|Long|作品ID|  | 不传此参数会更新bindCreationId对应的所有作品 |
|bindCreationId|是|String|绑定易企秀作品的参数值|| 互动通知绑定接口绑定返回对应的值配置同步时会做是否已经绑定的校验，避免出现同步对应错误 |
|activityName	    |是	|      String|	活动名称	  |  24	|                                                              |
|startTime	        |否	|      Date	 |  活动开始时间  |		|e.g:2022-11-18 15:44:17                                       |
|endTime	        |否	|      Date	 |  活动结束时间  |		|e.g:2022-11-18 15:44:17 校验：活动结束时间需要大于活动开始时间|
|loginPosition	    |是	|      Integer	 |  登录时机	  |	    |1:打开时登录 2: 触发动作                                      |
|winNum	    |否	|      Integer	 |  中奖限制  |		|  |
|myPrizeType	    |否	|      Integer	 |  我的奖品开关  |		| 0隐藏 1默认 2作品内弹出 3页面跳转|
|myPrizeLink	    |否	|      String	 |  我的奖品跳转链接  |		|  |
|activityRules	    |否	|      Integer	 |  活动规则设置  |		| 0隐藏 1默认 2作品内弹出 3页面跳转|
|activityRulesLink	    |否	|      String	 |  活动规则跳转链接  |		|  |
|styleType	    |否	|      Integer	 |  中奖弹窗样式  |		|  1-系统默认 2-自定义样式|
|place1	    |否	|      Integer	 |  位置1  |		| 1 奖品等级 2 奖品名称 3 奖品描述 4 奖品图片 |
|place2	    |否	|      Integer	 |  位置2  |		| 1 奖品等级 2 奖品名称 3 奖品描述 4 奖品图片 |
|lotteryScore	    |否	|      String	 |  达标分数  |		| 游戏参数（抽奖类型不设置） |
|prizes	    |否	|      Array	 |  抽奖游戏奖项参数  |		| 抽奖参数（游戏类型不设置） |
|gamePrizeSetting	    |否	|      Array	 |  游戏类型参数  |		| 游戏参数（抽奖类型不设置） |
|property	    |否	|      JsonObject	 |  属性配置  |		|  |
|lotterySetting	    |否	|      JsonObject	 |  抽奖设置  |		|  |
|customSetting	    |否	|      Array	 |  自定义设置  |		|  |
|pageInfo	    |否	|      JsonObject	 |  页面设置  |		|  |
|shareSetting	    |否	|      JsonObject	 |  分享设置  |		|  |

- **prizes**
| 参数名 | 是否必须 | 参数类型 | 参数说明 | 长度限制 | 备注 |
| --- | --- | --- | --- | --- | --- |
|prizes.prizeLevel	|是	|	Integer     |  奖品等级	  |	    |  从0开始计数                                                 |
|prizes.prizeLevelName	|否|String	|	奖品等级名称  |	16	|                                                              |
|prizes.prizeName	|是		     | String |奖品名称	  | 24	|  传空字符串表示奖品名称设为空                                                            |
|prizes.prizeCode	|否		     |String  |奖品代码	  | 50	|                                                              |
|prizes.prizeDesc	|否		     | String |奖品描述	  | 30	|                                                              |
|prizes.prizeImg	|否		     | String |奖品图片	  |	    |                                                              |
|prizes.redemptionAddr	|否	     | String |外部兑奖链接 |  	|	                                                           |
|prizes.prizeNum	|否	     | Integer |奖品总量 |  	|	                             (游戏类型-得分奖励：不传默认无限奖。其他类型：不传不修改)   |
|prizes.score	|否	     | Long |达标分数 | |(游戏类型-得分奖励，不传默认200) 	|
|prizes.rankStart	|否	     | Integer |排名区间开始 | |(游戏类型-排行奖励，必传参数) 	|
|prizes.rankEnd	|否	     | Integer |排名区间结束 | |(游戏类型-排行奖励，必传参数) 	|

- **gamePrizeSetting**
| 参数名 | 是否必须 | 参数类型 | 参数说明 | 长度限制 | 备注 |
| --- | --- | --- | --- | --- | --- |
|gamePrizeSetting.prizeType	|是	|	Integer |  游戏奖项类型 |	 |  1:得分奖励 2：排行奖励|
|gamePrizeSetting.rankType	|是	|	Integer |  排行榜类型 |	 |  1:总;2:日;3:周;4:月|
|gamePrizeSetting.open	|是|Integer	|	奖励开关  |	|1：开启、2：关闭	|
|gamePrizeSetting.prizes	|否|Array	|	游戏奖项设置  |	|在open为开启时必传。参数详情参考prizes	|

- **property**
| 参数名 | 是否必须 | 参数类型 | 参数说明 | 长度限制 | 备注 |
| --- | --- | --- | --- | --- | --- |
|property.benefitOpen	|否	|	Integer |  是否开启权益 |	 |  1:是 0：否|
|property.benefitUrl	|否|String	|	权益的接口地址  |	| 接口地址需要和控制台设置的权益接口地址一致	|
|property.sceneTempConfig.bgType	|否|String	|	背景设置类型  |	|outerLink-链接	|
|property.sceneTempConfig.bgOuterLink	|否|String	|	背景设置链接地址  |	|	|

- **lotterySetting**
| 参数名 | 是否必须 | 参数类型 | 参数说明 | 长度限制 | 备注 |
| --- | --- | --- | --- | --- | --- |
|lotterySetting.multiDraw	|否	|	Integer |  是否开启连抽功能 |	 |  1:是 0：否|
|lotterySetting.drawNum	|否|Integer	|	连抽的次数  |	| 最大10次，开启连抽时必传	|
|lotterySetting.showRankTypes	|是|array	|	排行榜显示类型  |	| 1:总;2:日;3:周;4:月	|
|lotterySetting.rewardRankTypes	|是|array	|	排行榜奖励类型  |	| 1:总;2:日;3:周;4:月	|
|lotterySetting.preTip	|否|Integer	|	是否开启抽奖前提示  |	|1:是 0：否	|
|lotterySetting.preTipSetting.img	|否|String	|	提示图片地址  |	|	|
|lotterySetting.preTipSetting.btn	|否|String	|	抽奖按钮图片地址  |	|	|
|lotterySetting.preTipSetting.showTip	|否|Integer	|	是否显示：“知道了，今日不显示”  |	|	1:是 0：否|
|lotterySetting.preTipSetting.showTipDefault	|否|Integer	|	是否显示：“访客默认选中[今日不显示]”  |	|1:是 0：否	|
|lotterySetting.shufflingDyn.showUserTypeList	|否|List	|	弹幕展示内容  |	|1：头像、2：昵称|
|lotterySetting.shufflingDyn.showPrizeTypeList	|否|List	|	弹幕展示内容  |	|1：奖品等级、2：奖品名称|
|lotterySetting.shufflingDyn.maxShowNumber	|否|Integer	|	展示最大条数限制  |	||

- **customSetting**
| 参数名 | 是否必须 | 参数类型 | 参数说明 | 长度限制 | 备注 |
| --- | --- | --- | --- | --- | --- |
|customSetting.customList.actionAfterEnd	|否	|	Integer |  自定义组件-活动结束后显示设置 |	 |   0-隐藏 1-显示（不可点击） 2-显示（可以点击|
|customSetting.customList.customType	|否|Integer	|	自定义组件设置-组件类型  |	| 图片-2，自定义组件-3	|
|customSetting.customList.jsId	|否|Integer	|	自定义js的id  |	|[集成配置接口-查询集成配置](https://hc.eqxiu.cn/doc/32/ "集成配置接口-查询集成配置")自定义js(key为1504)返回的id	|
|customSetting.customList.clickTriggersType	|否|String	|	图片-点击触发类型  |	| 0-无 event-事件	customComp-自定义组件|
|customSetting.customList.eventTriggersType	|否|String	|	图片-事件触发类型  |	| lottery-抽奖 	|
|customSetting.customList.imgUrl	|否|String	|	图片-组件图片地址  |	| 	|
- **pageInfo**
| 参数名 | 是否必须 | 参数类型 | 参数说明 | 长度限制 | 备注 |
| --- | --- | --- | --- | --- | --- |
|singleDrawImg	|否	|	String |  连抽功能，抽奖一次按钮图片地址 |	 |  |
|multiDrawImg	|否	|	String	|	连抽功能， 抽奖多次按钮图片地址 |	| |
- **shareSetting**
| 参数名 | 是否必须 | 参数类型 | 参数说明 | 长度限制 | 备注 |
| --- | --- | --- | --- | --- | --- |
|customBtnShow	|是	|	Integer |  对应自定义按钮，1：显示、0：隐藏 |	 |  |
|shareRadioType	|否	|	Integer	|	按钮类型（1：一键关注、2：跳转页面、3：小程序普通链接、4：小程序tabbar页面） |	| |
 |shareRadioUrl	|否	|	String |  链接地址（二维码为图片地址） |	 |  |

- 返回参数
```json
{
  "success": true，
  "code":"200",
  "msg":"操作成功"
}
```
bindCreationId不存在异常情况
```json
{
  "success": false,
  "code": "C020265",
  "msg": "不存在绑定关系，无法更新",
  "obj": null,
  "map": null,
  "list": null,
  "details": null
}
```
- 参数说明
| 参数名 | 是否必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
|success|是|Boolean|成功状态|
|code|是|String|状态码，200请求正确，其他视为失败|
|msg|是|String|返回消息|

# 绑定易企秀作品接口
## 接口说明
本接口协议是方便企业用户通过调用本接口将企业作品与易企秀作品进行绑定（就不用手动在页面进行绑定了）。
## 接口规范
- 接口地址: /api/v1/editor/hd/creation/bind?token=TOKEN

- 请求方式：POST

- Content-Type：application/json

- 请求参数
```json
{
    "creationId":2134,
    "bindCreationId":"abc"
}
```
- 参数说明
| 参数名 | 是否必须 | 参数类型 | 参数说明 |备注|
| --- | --- | --- | --- |--|
|creationId|是|Long|作品ID||
|bindCreationId|是|String|企业作品ID|互动通知绑定接口绑定返回对应的值配置同步时会做是否已经绑定的校验，避免出现同步对应错误|
- 返回参数
```json
{
  "success": true，
  "code":"200",
  "msg":"操作成功"
}
```
# 解绑易企秀作品接口
## 接口说明
解除企业作品与易企秀作品的绑定关系。
## 接口规范
- 接口地址: /api/v1/editor/hd/creation/unbind/{creationId}?token=TOKEN

- 请求方式：POST

- Content-Type：application/json

- 参数说明
| 参数名 | 是否必须 | 参数类型 | 参数说明 |备注|
| --- | --- | --- | --- |--|
|creationId|是|Long|作品ID||
- 返回参数
```json
{
  "success": true，
  "code":"200",
  "msg":"操作成功"
}
```
不存在绑定关系异常情况
```json
{
  "success": false,
  "code": "C020266",
  "msg": "不存在绑定关系"
}
```