活动参与信息接口

## 中奖名单

- 接口描述：获取活动中奖名单
- 接口地址：/api/v1/editor/hd/win/prize/list?token=TOKEN
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| creationId | 是 | String | 作品id |
| prizeCode | 否 | String | 兑奖码 |
| pageNo | 否 | int | 第几页，默认1 |
| pageSize | 否 | int | 每页大小，默认10 |

- 接口出参
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": null,
    "map": {
        "pageNo": 1,
        "count": 8,
        "pageSize": 10,
        "end": true
    },
    "list": [
        {
            "id": 161546,
            "creationId": 10378,
            "encodeId": "dcac1b3aabf1cbb60d2ea57d9307ff27",
            "nickName": "Lonsy²⁰²¹",
            "headImgUrl": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTJAUlVzuuhU0VPOez901dntGxCqncq7hic7OPCaPyQgoI2oEHia79uNp2bukHv43XkNOlbdI3ia1lTGQ/132",
            "winCode": "PaEUhFaeIW",
            "prizeLevel": "1",
            "prizeLevelName": "二等奖",
            "prizeName": "200元优惠券",
            "winTime": 1623036758000,
            "status": "0",
            "redemptionAddr": null,
            "redemptionDesc": null,
            "startRedemptionTime": 1622800540000,
            "endRedemptionTime": 1654077340000,
            "cashTime": null,
            "elecCode": null,
            "thirdUserId": "123456"
        }
    ]
}
```
- 字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| id | Long | 中奖编号 |
| creationId | Long | 作品编号 |
| encodeId | String | 参与者编号 |
| nickName | String | 参与者昵称 |
| headImgUrl | String | 参与者头像 |
| winCode | String | 兑奖码 |
| prizeLevel | int | 奖品等级，从0开始 |
| prizeLevelName | String | 奖品等级名称 |
| prizeName | String | 奖品名称 |
| winTime | Long | 中奖时间 |
| status | String | 当redemptionMethod=7时，为0:未发货 5:待发货；6:已发货。其他兑奖方式，状态为0:未兑换，1:已兑换 |
| redemptionMethod | int | 兑奖方式:0:线下兑奖；1:网页兑奖；2:淘口令兑奖；5:网页兑奖（新）；6:外部兑奖；7：实物兑奖 |
| redemptionAddr | String | 兑奖地址 |
| redemptionDesc | String | 兑奖描述 |
| startRedemptionTime | Long | 开始兑奖时间 |
| endRedemptionTime | Long | 结束兑奖时间 |
| cashTime | Long | 参与者兑奖时间 |
| elecCode | String | 电子兑奖码 |
| thirdUserId | String | 对接方提供的用户唯一标识 |

## 参与用户列表

- 接口描述：获取活动参与的用户信息
- 接口地址：/api/v1/editor/lottery/record/summary/list?token=TOKEN
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| code | 是 | String | 作品code |
| city | 否 | String | 参与用户所在省市，如北京、石家庄、济南 |
| pageNo | 否 | int | 第几页，默认1 |
| pageSize | 否 | int | 每页大小，默认10 |

- 接口出参
```json
{
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": {
        "pageNo": 1,
        "count": 1,
        "pageSize": 10,
        "end": true
    },
    "list": [
        {
            "encodeId": "dcac1b3aabf1cbb60d2ea57d9307ff27",
            "thirdUserId": "123456",
            "nickName": "互动参与昵称",
            "headImgUrl": "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTJAUlVzuuhU0VPOez901dntGxCqncq7hic7OPCaPyQgoI2oEHi",
            "startTime": "2021-06-07 11:32:36",
            "endTime": "2021-06-07 11:32:36",
            "lotteryCount": 5,
            "prize": "二等奖:200元优惠券",
            "ip": "101.254.236.210",
            "province": "北京",
            "city": "北京",
            "device": "iPhone"
        }
    ]
}
```
- 字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| encodeId | String | 参与者编号 |
| nickName | String | 参与者昵称 |
| headImgUrl | String | 参与者头像 |
| startTime | String | 首次参与时间 |
| endTime | String | 最后参与时间 |
| lotteryCount | int | 参与抽奖次数 |
| prize | String | 中奖名称 |
| ip | String | 参与者ip |
| province | String | 参与者省份 |
| city | String | 参与者城市 |
| device | String | 参与者设备 |
| thirdUserId | String | 对接方提供的用户唯一标识 |

## 游戏排行榜

- 接口描述：获取作品游戏排行榜
- 接口地址：/api/v1/editor/hd/rank/list?token=TOKEN&openId=OPENID
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| creationId | 是 | Long | 作品唯一标识 |
| pageNo | 否 | int | 第几页，默认1 |
| pageSize | 否 | int | 每页大小，默认10 |

- 接口出参
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": {
        "nickName": "用户信息",
        "rankNo": "游戏排名",
        "score": "游戏得分",
        "updateTime": "排行更新时间"
    },
    "map": {
        "pageNo": 1,
        "count": 1,
        "pageSize": 10,
        "end": true
    },
    "list": [
        {
            "nickName": "eqxiu",
            "score": 85,
            "rankNo": "1.0",
            "updateTime": "2021-05-14 08:59:05",
            "headImgUrl": "https://wework.qpic.cn/wwhead/nMl9sso",
            "thirdUserId": "123456"
        }
    ]
}
```

- 字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| obj | Object | 列表的表头与list对应 |
| nickName | String | 游戏玩家昵称 |
| score | double | 游戏分数 |
| rankNo | String | 排行榜排名 |
| updateTime | Date | 排行榜更新时间 |
| headImgUrl | String | 玩家头像 |
| thirdUserId | String | 对接方提供的用户唯一标识 |

## 查询访客用户的中奖记录

- 接口描述：获取指定活动指定用户的中奖记录
- 接口地址：/api/v1/preview/hd/lottery/third/win?token=TOKEN&creationId=&thirdUserId=
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| creationId | 是 | Long | 作品唯一标识 |
| thirdUserId | 是 | String | 第三方访客标识 |

- 接口出参
```json
{
    "success": true,
    "code": "200",
    "msg": null,
    "obj": null,
    "map": null,
    "list": [
        {
            "id": 856169,
            "creationId": 124648,
            "encodeId": "5f1c74682f3e4412bfdaa40a7202690c",
            "nickName": "hsy",
            "mobile": null,
            "headImgUrl": "https://asset.eqxiu.cn/common/icon-organization-user.png",
            "winCode": "23354dWMUr",
            "prizeCode": "",
            "sourceType": 1,
            "prizeLevel": "0",
            "prizeLevelName": "一等奖",
            "prizeName": "200元优惠券",
            "winTime": 1703043457000,
            "status": "0",
            "redemptionAddr": null,
            "redemptionDesc": "我是兑奖须知",
            "startRedemptionTime": 1703038066000,
            "endRedemptionTime": 1703642866000,
            "mailDesc": "",
            "redeemStartTime": "2023-12-20 10:07:46",
            "redeemEndTime": "2023-12-27 10:07:46",
            "message": null,
            "redPackageAmount": null,
            "redemptionMethod": 1,
            "takeNum": null,
            "prizeType": 0,
            "customerId": null,
            "staffId": null,
            "unionId": null,
            "openId": null,
            "corpId": null,
            "cashTime": null,
            "elecCode": null,
            "authType": null,
            "thirdUserId": null,
            "thirdOpenId": null,
            "thirdAppId": null,
            "authMobile": null,
            "amount": 99,
            "dynData": null
        },
        {
            "id": 856170,
            "creationId": 124648,
            "encodeId": "5f1c74682f3e4412bfdaa40a7202690c",
            "nickName": "hsy",
            "mobile": null,
            "headImgUrl": "https://asset.eqxiu.cn/common/icon-organization-user.png",
            "winCode": "233542vqIw",
            "prizeCode": "",
            "sourceType": 1,
            "prizeLevel": "1",
            "prizeLevelName": "二等奖",
            "prizeName": "200元优惠券",
            "winTime": 1703043463000,
            "status": "0",
            "redemptionAddr": null,
            "redemptionDesc": "",
            "startRedemptionTime": null,
            "endRedemptionTime": null,
            "mailDesc": "我是邮寄说明",
            "redeemStartTime": null,
            "redeemEndTime": null,
            "message": null,
            "redPackageAmount": null,
            "redemptionMethod": 7,
            "takeNum": null,
            "prizeType": 0,
            "customerId": null,
            "staffId": null,
            "unionId": null,
            "openId": null,
            "corpId": null,
            "cashTime": null,
            "elecCode": null,
            "authType": null,
            "thirdUserId": null,
            "thirdOpenId": null,
            "thirdAppId": null,
            "authMobile": null,
            "amount": 4,
            "dynData": null
        },
        {
            "id": 856171,
            "creationId": 124648,
            "encodeId": "5f1c74682f3e4412bfdaa40a7202690c",
            "nickName": "hsy",
            "mobile": null,
            "headImgUrl": "https://asset.eqxiu.cn/common/icon-organization-user.png",
            "winCode": "233544cxW9",
            "prizeCode": "",
            "sourceType": 1,
            "prizeLevel": "2",
            "prizeLevelName": "三等奖",
            "prizeName": "200元优惠券",
            "winTime": 1703043469000,
            "status": "0",
            "redemptionAddr": null,
            "redemptionDesc": "",
            "startRedemptionTime": null,
            "endRedemptionTime": null,
            "mailDesc": "我是三等奖的邮寄说明",
            "redeemStartTime": null,
            "redeemEndTime": null,
            "message": null,
            "redPackageAmount": null,
            "redemptionMethod": 7,
            "takeNum": null,
            "prizeType": 0,
            "customerId": null,
            "staffId": null,
            "unionId": null,
            "openId": null,
            "corpId": null,
            "cashTime": null,
            "elecCode": null,
            "authType": null,
            "thirdUserId": null,
            "thirdOpenId": null,
            "thirdAppId": null,
            "authMobile": null,
            "amount": 4,
            "dynData": null
        },
        {
            "id": 856172,
            "creationId": 124648,
            "encodeId": "5f1c74682f3e4412bfdaa40a7202690c",
            "nickName": "hsy",
            "mobile": null,
            "headImgUrl": "https://asset.eqxiu.cn/common/icon-organization-user.png",
            "winCode": "23354uCVtf",
            "prizeCode": "",
            "sourceType": 1,
            "prizeLevel": "1",
            "prizeLevelName": "二等奖",
            "prizeName": "200元优惠券",
            "winTime": 1703043474000,
            "status": "0",
            "redemptionAddr": null,
            "redemptionDesc": "",
            "startRedemptionTime": null,
            "endRedemptionTime": null,
            "mailDesc": "我是邮寄说明",
            "redeemStartTime": null,
            "redeemEndTime": null,
            "message": null,
            "redPackageAmount": null,
            "redemptionMethod": 7,
            "takeNum": null,
            "prizeType": 0,
            "customerId": null,
            "staffId": null,
            "unionId": null,
            "openId": null,
            "corpId": null,
            "cashTime": null,
            "elecCode": null,
            "authType": null,
            "thirdUserId": null,
            "thirdOpenId": null,
            "thirdAppId": null,
            "authMobile": null,
            "amount": 4,
            "dynData": null
        }
    ],
    "details": null
}
```

- 字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| creationId | Long | 作品唯一标识 |
| encodeId | String | 访客ID |
| nickName | String | 访客昵称 |
| mobile | String | 手机号 |
| headImgUrl |  String | 头像地址 |
| winCode | String | 兑奖码 |
| prizeCode | String | 奖品代码 |
| sourceType | int | 1:默认奖品类型，2：排行榜奖品 |
| prizeLevel | int | 奖品等级 |
| prizeLevelName | String | 奖品等级名称 |
| prizeName | String | 奖品名称 |
| winTime | Long | 中奖时间 |
| status | int | 状态0:待发放or 未填写地址；1:已发放；2:已领取；3:未领取；5:未发货;6:已发货; |
| redemptionAddr | String | 兑奖地址 |
| redemptionDesc | String | 兑奖须知 |
| startRedemptionTime | Long | 兑奖开始时间 |
| endRedemptionTime | Long | 兑奖结束时间 |
| mailDesc | String | 邮寄说明 |

## 修改访客用户中奖的邮寄地址

- 接口描述：修改访客用户中奖的邮寄地址
- 接口地址：/api/v1/preview/hd/win/third/writeAddress?token=TOKEN
- 请求方式：post/json
- 接口入参
```json
{
    "receiverName": "张三",
    "receiverPhone": "18215560411",
    "receiverAddress": "我是收货地址",
    "winCode": "23354uCVtf"
}
```
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| winCode | 是 | String | 兑奖码-可来源于查询访客用户的中奖记录接口 |
| receiverName | 是 | String | 收货人 |
| receiverPhone | 是 | String | 收货人-手机号码 |
| receiverAddress | 是 | String | 收货人-收货地址 |

- 接口出参
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": {
        "receiverName": "张三",
        "receiverPhone": "18215560411",
        "receiverAddress": "我是收货地址",
        "winId": 856160
    },
    "map": null,
    "list": null
}
```

- 字段说明
略——请求成功的情况下，会将收货信息原封不动的进行返回

## 查询访客用户游戏成绩

- 接口描述：获取指定用户在当前游戏作品取得的成绩详细信息，包括用户信息、最高分数、最高排名和每局游戏的分数和排名。
- 接口地址：/api/v1/editor/hd/rank/userRankDetail?token=TOKEN&creationId=xxxx&thirdUserId=xxxx&recordNum=xxxx&corpId=xxx
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| creationId | 是 | String | 作品唯一标识 |
| thirdUserId | 是 | String | 用户标识 |
| recordNum | 否 | String | 流水号 |
| corpId | 否 | String | 没有登陆状态需要 |
| ~~encodeId~~ | 否 | String | 易企秀用户唯一标识（过时字段） |

- 接口出参
```json
{
  "success": true, //成功响应
  "code": 200,
  "msg": "操作成功", //返回文字描述
  "obj": {
    "recordList": [
      {
        "recordNum": "202203241632535662147483647", //流水号
        "score": 0, //当前局分数
        "nowRank": 1, //当前局排名
        "createTime": "2022-03-24 16:32:54" //游戏时间
      }
    ], //游戏记录列表
    "nickName": "178****0561", //昵称
    "headImgUrl": "https://asset.eqxiu.cn/common/default-head-img.png", //头像地址
    "encodeId": "ce6233258815394130db88587dbd9fbb", //encodeId
    "thirdUserId": null, //三方用户id
    "highestScore": 4, //最高分数
    "highestRank": 1 //最高排名
  },
  "map": null,
  "list": null
}
```

- 字段说明：
元素：obj（1,1）
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| nickName | String | 用户昵称 |
| headImgUrl | String | 用户头像 |
| encodeId | String | 易企秀用户唯一标识 |
| thirdUserId | String | 三方用户id |
| highestScore | Number | 最高分数 |
| highestRank | Number | 最高排名 |

元素：obj/recordList（0,N）
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| recordNum | String | 流水号 |
| score | Number | 当前局分数 |
| nowRank | Number | 当前局排名 |
| createTime | String | 游戏时间，格式：2022-03-24 16:32:54 |

## 表单数据

- 接口描述：获取表单提交的数据
- 接口地址：/api/v1/editor/hd/form/list?token=TOKEN&openId=OPENID
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| creationId | 是 | Long | 作品唯一标识 |
| pageNo | 否 | int | 第几页，默认1 |
| pageSize | 否 | int | 每页大小，默认10 |

- 接口出参
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": null,
    "map": {
        "pageNo": 1,
        "count": 1,
        "pageSize": 10,
        "end": true
    },
    "list": [
        [
            "玩家信息",
            "姓名",
            "电话",
            "提交时间"
        ],
        [
            "https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTJAUlVzuuhU0VPOez901dntGxCqncq7hic7OPC",
            "Lonsy²⁰²⁰",
            "陈情令",
            "183*****06",
            "2021-05-19 19:16:34",
            "thirdUserId": "123456"
        ]
    ]
}
```
- 字段说明
参考用户自己设置的表单数据，如有数据，返回字段的list第一行为表头，其余的为表单数据。

## 活动PV、UV、中奖人数统计

- 接口描述：获取PV、UV、中奖人数数据统计
- 接口地址：/api/v1/editor/hd/activity/day/statistics?token=TOKEN
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| creationId | 是 | Long | 作品唯一标识 |
| type | 是 | int | 1今日数据，2昨日数据，3近7日数据，4总数据 |

- 返回值
```json
{
	"success": true,
	"code": 200,
	"msg": "操作成功",
	"obj": {
		"creationId": 185109,
		"hourBeLongDay": null,
		"pvTotal": 1,
		"uvTotal": 1,
		"shareTotal": 1,
		"gameJoinPersonTotal": 0,
		"gameJoinPersonTimeTotal": 0,
		"lotteryJoinPersonTotal": 0,
		"lotteryJoinPersonTimeTotal": 0,
		"lotteryWinPersonTotal": 0,
		"lotteryWinPersonTimeTotal": 0,
		"winTotal": 0,
		"cashTotal": 0,
		"lotterySendOutPrizeTotal": 0,
		"pvDur": 1,
		"uvDur": 1,
		"shareDur": 1,
		"formTotal": 0,
		"formDur": 0,
		"avgScoreDur": 0,
		"gameJoinPersonDur": 0,
		"gameJoinPersonTimeDur": 0,
		"lotteryJoinPersonDur": 0,
		"lotteryJoinPersonTimeDur": 0,
		"lotteryWinPersonDur": 0,
		"lotteryWinPersonTimeDur": 0,
		"winDur": 0,
		"cashDur": 0,
		"lotterySendOutPrizeDur": 0,
		"pvList": [
			0,
			0,
			0
		],
		"uvList": [
			0,
			0,
			0
		],
		"formList": [
			0,
			0,
			0
		],,
		"timeList": [
			"2023-08-01",
			"2023-08-02",
			"2023-08-03"
		],
		"gameJoinPersonList": [
			0,
			0,
			0
		],
		"gameJoinPersonTimeList": [
			0,
			0,
			0
		],
		"lotteryJoinPersonList": [
			0,
			0,
			0
		],
		"lotteryJoinPersonTimeList": [
			0,
			0,
			0
		],
		"lotteryWinPersonList": [
			0,
			0,
			0
		],
		"lotteryWinPersonTimeList": [
			0,
			0,
			0
		],
		"winList": [
			0,
			0,
			0
		],
		"cashList": [
			0,
			0,
			0
		],
		"lotterySendOutPrizeList": [
			0,
			0,
			0
		],
		"catchAvgScoreList": null,
		"catchPtCountList": null,
		"shareList": [
			0,
			0,
			0
		],
		"authTitle": "全部数据"
	},
	"map": null,
	"list": null
}
```
- 返回值说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| creationId | Long | 作品id |
| pvTotal | Long | 总PV |
| uvTotal | int | 总UV |
| shareTotal | int | 分享总数 |
| gameJoinPersonTotal | int | 参与游戏总人数 |
| lotteryJoinPersonTotal | int | 参与抽奖总人数 |
| lotteryJoinPersonTimeTotal | int | 参与抽奖总人次 |
| lotteryWinPersonTotal | int | 中奖总人数 |
| winTotal | int | 中奖次数 |
| cashTotal | int | 抽奖兑奖总数 |
| lotterySendOutPrizeTotal | int | 抽奖发货奖品总数 |
| pvDur | int | 区间PV |
| uvDur | int |区间UV |
| shareDur | int | 区间分享数 |
| formTotal | int | 表单总数 |
| formDur| int | 区间表单数 |
| avgScoreDur | int | 区间平均分数 |
| gameJoinPersonDur | int | 区间参与游戏人数 |
| gameJoinPersonTimeDur | int | 区间参与游戏人次 |
| lotteryJoinPersonDur | int | 区间抽奖人数 |
| lotteryJoinPersonTimeDur | int | 区间抽奖人次 |
| lotteryWinPersonDur | int | 区间中奖人数 |
| lotteryWinPersonTimeDur | int | 区间中奖人次 |
| winDur | int | 区间中奖次数 |
| cashDur | int | 区间兑奖次数 |
| lotterySendOutPrizeDur | int | 区间抽奖发货奖品次数 |
| timeList | Array | 时间，今日昨日为24小时制，其他为日期 |
| pvList | Array | PV数据 |
| uvList | Array | UV数据 |
| formList | Array | 表单数据 |
| gameJoinPersonList | Array | 参与游戏数据 |
| gameJoinPersonTimeList | Array | 参与游戏时间数据 |
| lotteryJoinPersonList | Array | 抽奖数据 |
| lotteryJoinPersonTimeList | Array | 抽奖人次数据 |
| lotteryWinPersonList | Array | 中奖数据 |
| lotteryWinPersonTimeList | Array | 中奖人次数据 |
| cashList | Array | 兑奖数据 |
| winList | Array | 中奖数据 |
| lotterySendOutPrizeList | Array | 抽奖发货奖品数据 |
| catchAvgScoreList | Array | 平均积分数据 |
| catchPtCountList | Array | 积分数据 |
| shareList | Array | 分享数据 |
| authTitle | String | 标题 |

## 奖品发放、兑奖数据统计

- 接口描述：获取奖品发放、兑奖数据统计
- 接口地址：/api/v1/editor/hd/activity/prize/statistics?token=TOKEN
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| creationId | 是 | Long | 作品唯一标识 |
| type | 是 | int | 1今日数据，2昨日数据，3近7日数据，4总数据 |

- 接口出参
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": {
        "timeList": [
            "2021-06-04",
            "2021-06-05",
            "2021-06-06",
            "2021-06-07",
            "2021-06-08",
            "2021-06-09",
            "2021-06-10"
        ],
        "winList": [
            2,
            0,
            4,
            2,
            0,
            0,
            0
        ],
        "cashList": [
            0,
            0,
            0,
            0,
            1,
            0,
            0
        ]
    },
    "map": null,
    "list": null
}
```

- 字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| timeList | Array | 时间，今日昨日为24小时制，其他为日期 |
| winList | Array | 奖品发放数据 |
| cashList | Array | 兑奖数据 |