互动接口

## 获取活动信息
- 接口描述：获取活动基本信息以及基本数据统计
- 接口地址：/api/v1/editor/hd/activity/info?token=TOKEN&openId=OPENID
- 请求方式：GET
- 接口入参：
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| creationId | 是 | Long | 作品唯一标识 |
- 返回值
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": {
        "id": 1,
        "type": "hd",
        "code": "OhujJ3YE",
        "title": "易企秀活动",
        "cover": "Fm0TsFyxSh4FTmz1GmCx64-ZkrD",
        "description": "我用易企秀做了一个超级炫酷的互动H5，快来看看吧。",
        "bizType": 2,
      	"template": 0,
      	"sourceId": 10096,
      	"templateId": 10197,
      	"originTemplateId": 10096,
      	"status": 2,
      	"property": "",
      	"createUser": "100864570a0c4e798fa621c1f3b357aa",
      	"startTime": "2021-01-02 03:04:05",
      	"endTime": "2022-01-02 03:04:05",
      	"createTime": "2021-01-02 03:04:05",
      	"updateTime": "2021-01-02 03:04:05",
      	"publishTime": "2021-01-02 05:00:00"
    },
    "map": {
        "sendPrizes": 8,
        "totalNum": 20,
        "joinLottery": 0,
        "totalPv": 0,
        "totalUv": 0,
        "totalPrizeNum": 12,
        "totalTakeNum": 6,
        "serverTime": 1623318377327,
        "creationId": 10378,
        "surplusPrizes": 892
    },
    "list": null
}
```

- 返回值说明
obj字段同“[作品信息接口](https://hc.eqxiu.cn/doc/35/)”
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| sendPrizes | int | 发放奖品数 |
| totalNum | int | 奖品总数 |
| joinLottery | int | 抽奖参与人次 |
| totalPv | int | 活动总pv |
| totalUv | int | 活动总uv |
| totalPrizeNum | int | 奖品总数 |
| totalTakeNum | int | 奖品总领取数 |
| serverTime | long | 服务器时间 |
| creationId | Long | 作品Id |
| surplusPrizes | int | 剩余奖品总数 |
| shareUrl | String | 分享地址 |
| editUrl | String | 编辑器地址，对接公司需要追加参数secretId=xxx以及Authorization=XXXXX,最终形态类似于https://xxx.eqxiu.cn/xx/xxxx?secretId=xxx&Authorization=XXXXX |

## 更改活动状态

- 接口描述：更改活动作品状态
- 接口地址：/api/v1/editor/hd/activity/status?token=TOKEN&openId=OPENID
- 请求方式：POST
- Content-Type：application/x-www-form-urlencoded
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| creationId | 是 | Long | 作品唯一标识 |
| status | 是 | int | 状态，支持3:暂停，4:结束，2:恢复 |

- 接口出参
```json
{
    "success": true,
    "code": "200",
    "msg": null,
    "obj": 100000,
    "map": {},
    "list": []
}
```

## 奖项列表

- 接口描述：获取设置的奖项列表
- 接口地址：/api/v1/editor/hd/activity/prize/info?token=TOKEN
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| creationId | 是 | Long | 作品唯一标识 |

- 接口出参
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": null,
    "map": null,
    "list": [
        {
            "prizeLevel": 0,
            "takeNum": 4,
            "prizeNum": 296,
            "totalNum": 300,
            "prizeName": "200元优惠券",
            "prizeLevelName": "一等奖",
			"prizeType": 0,
            "redemptionMethod":0,
			"prizeCode":"FU_10000",
			"prizeDesc": "这个是描述"
        },
        {
            "prizeLevel": 1,
            "takeNum": 1,
            "prizeNum": 299,
            "totalNum": 300,
            "prizeName": "200元优惠券",
            "prizeLevelName": "二等奖",
			"prizeType": 0,
            "redemptionMethod":0,
			"prizeCode":"FU_10000",
			"prizeDesc": "这个是描述"
        },
        {
            "prizeLevel": 2,
            "takeNum": 1,
            "prizeNum": 299,
            "totalNum": 300,
            "prizeName": "200元优惠券",
            "prizeLevelName": "三等奖",
			"prizeType": 0,
            "redemptionMethod":0,
			"prizeCode":"",
			"prizeDesc": "这个是描述"
        }
    ]
}
```
- 字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| prizeLevel | int | 奖品等级，从0开始 |
| takeNum | int | 已领取数 |
| prizeNum | int | 剩余奖品数量 |
| totalNum | int | 奖品总数 |
| prizeType | int | 奖品类型：0=礼品，1=优惠券，2=现金红包，3=电子兑奖码，4=虚拟货币 |
| prizeName | String | 奖品名称 |
| prizeLevelName | String | 奖品等级名称 |
| redemptionMethod | int | 兑奖方式：0线下兑奖 1网页兑奖 2淘口令兑奖 5网页兑奖(新) 6外部兑奖 7实物邮寄 8-无须兑奖 |
| prizeCode | String | 奖品编码 |
| prizeDesc | String | 奖品描述 |

## 兑奖码列表-企业

- 接口描述：查询企业电子兑奖码
- 接口地址：/api/v1/editor/hd/giftcode/list?token=TOKEN
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| name | 否 | String | 兑奖码名称 模糊查询 |
| status | 否 | Integer | 状态：0，使用中（已绑定到作品，未发到用户）、1:已发放（已绑定作品，用户中奖）、3:未使用（初始化导入，未绑定作品） |
| code | 否 | String | 兑奖码 |
| pageNo | 是 | Integer | 分页查询，第几页，例如：1 |
| pageSize | 是 | Integer | 分页查询，每页多少个 |

- 接口出参
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": {
        "totalUseKey": 0,
        "totalKeyNums": 1,
        "useIngUseKey": 0,
        "totalNotUseKey": 1
    },
    "map": {
        "pageNo": 1,
        "count": 1,
        "pageSize": 10,
        "end": true
    },
    "list": [
        {
            "id": null,
            "creationId": null,
            "corpId": null,
            "name": "测试001",
            "sortNo": null,
            "nickName": null,
            "headImgUrl": null,
            "openId": null,
            "encodeId": null,
            "prizeLevel": null,
            "code": "1000001",
            "createTime": 1629895516000,
            "status": 0,
            "useTime": null,
            "updateTime": null
        }
    ]
}
```
- list字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| id | Long | 兑奖码数据库标示 |
| name | String | 兑奖码名称 |
| code | String | 兑奖码 |
| creationId | Long | 作品ID |
| prizeLevel | int | 兑奖码所属奖项 |
| status | int | 状态：0，使用中（已绑定到作品，未发到用户）、1:已发放（已绑定作品，用户中奖）、3:未使用（初始化导入，未绑定作品） |
| sortNo | int | 排序字段 |
| nickName | String | 中奖者昵称 |
| headImgUrl | String | 中奖者头像 |
| openId | String | 中奖者用户第三方标示：例如微信openId，第三方用户Id |
| encodeId | String | 中奖者用户唯一标示 |

## 兑奖码列表-个人

- 接口描述：查询个人电子兑奖码
- 接口地址：/api/v1/editor/hd/giftcode/list/my?token=TOKEN
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| name | 否 | String | 兑奖码名称 模糊查询 |
| status | 否 | Integer | 状态：0，使用中（已绑定到作品，未发到用户）、1:已发放（已绑定作品，用户中奖）、3:未使用（初始化导入，未绑定作品） |
| code | 否 | String | 兑奖码 |
| pageNo | 是 | Integer | 分页查询，第几页，例如：1 |
| pageSize | 是 | Integer | 分页查询，每页多少个 |

- 接口出参
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": {
        "totalUseKey": 0,
        "totalKeyNums": 1,
        "useIngUseKey": 0,
        "totalNotUseKey": 1
    },
    "map": {
        "pageNo": 1,
        "count": 1,
        "pageSize": 10,
        "end": true
    },
    "list": [
        {
            "id": null,
            "creationId": null,
            "corpId": null,
            "name": "测试001",
            "sortNo": null,
            "nickName": null,
            "headImgUrl": null,
            "openId": null,
            "encodeId": null,
            "prizeLevel": null,
            "code": "1000001",
            "createTime": 1629895516000,
            "status": 0,
            "useTime": null,
            "updateTime": null
        }
    ]
}
```
- list字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| id | Long | 兑奖码数据库标示 |
| name | String | 兑奖码名称 |
| code | String | 兑奖码 |
| creationId | Long | 作品ID |
| prizeLevel | int | 兑奖码所属奖项 |
| status | int | 状态：0，使用中（已绑定到作品，未发到用户）、1:已发放（已绑定作品，用户中奖）、3:未使用（初始化导入，未绑定作品） |
| sortNo | int | 排序字段 |
| nickName | String | 中奖者昵称 |
| headImgUrl | String | 中奖者头像 |
| openId | String | 中奖者用户第三方标示：例如微信openId，第三方用户Id |
| encodeId | String | 中奖者用户唯一标示 |

## 导入兑奖码

- 接口描述：导入兑奖码，每次对多到处5000条，超出部分无法导入
- 接口地址：/api/v1/editor/hd/giftcode/importByApi?token=TOKEN&openId=OPENID
- 请求方式：POST
- Content-Type：application/json
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| giftCodes | 是 | List | 兑奖码列表 |
| code | 是 | String | 兑奖码 |
| name | 是 | String | 兑奖码名称 |
| bizType | 是 | String | 兑奖码类型，2-企业（默认）3-个人 |

- 接口入参
```json
{
  "bizType": 2,
  "giftCodes": [
    {
      "code": 1000001,
      "name": "测试001"
    },
    {
      "code": 1000002,
      "name": "测试002"
    },
    {
      "code": 1000003,
      "name": "测试003"
    },
    {
      "code": 1000004,
      "name": "测试004"
    }
  ]
}
```

- 接口出参
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": {
        "importNum": 4,
        "formatErrList": [],
        "existList": [],
        "overList": []
    },
    "map": null,
    "list": null
}
```
- 字段说明
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| importNum | 是 | int | 导入数量 |
| formatErrList | 是 | [] | 格式不符合的兑奖码 |
| existList | 是 | [] | 重复导入的兑奖码 |
| overList | 是 | [] | 超过部分 |

## 兑奖（兑奖核销）

- 接口描述：管理员兑奖
- 接口地址： /api/v1/editor/hd/win/prize/exchange?token=TOKEN&openId=OPENID
- 请求方式：POST
- Content-Type：application/x-www-form-urlencoded
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
|  winCode | 是 | String | 兑奖码 |
|  encodeId | 是 | String | 易企秀访客ID |
|  creationId | 是 | Long | 作品ID |

- 接口出参
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": null,
    "map": null,
    "list": null
}
```

## 发货

- 接口描述：管理员手动发货
- 接口地址：/api/v1/editor/hd/win/material/deliver?token=TOKEN
- 请求方式：POST
- Content-Type：application/json
- 接口入参
```json
{
  "logisticsNo":"111111",
  "logisticsCompany":"顺丰",
  "winCode": "MLmbjsT2ng",
  "creationId": 35190,
  "encodeId": "75388638f6bf1a8d0c0df13096933ea6"
}
```
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| logisticsNo | 是 | String | 物流单号 |
| logisticsCompany | 是 | String | 物流公司名称 |
| winCode | 是 | String | 兑奖码 |
| encodeId | 是 | String | 访客ID |
| creationId | 是 | Long | 作品ID |

- 接口出参
```json
{
    "success": true,
    "code": 200,
    "msg": "操作成功",
    "obj": {
      "logisticsNo":"111111",
      "logisticsCompany":"顺丰",
      "deliveryTime","2022-04-26 00:00:00",
      "winId":2323
},
    "map": null,
    "list": null
}
```
- 字段说明
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| logisticsNo | 是 | String | 物流单号 |
| logisticsCompany | 是 | String | 物流公司名称 |
| deliveryTime | 否 | String | 发货时间 |
| winId | 否 | Long | 中奖人id |

## [活动参与信息](https://hc.eqxiu.cn/doc/213/ "活动参与信息")

## 活动口令列表

- 接口描述：获取设置的口令列表
- 接口地址：/api/v1/editor/hd/activity/key/keys?token=TOKEN&openId=OPENID
- 请求方式：GET
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| openId | 是 | String | 作品创建人的用户id |
| activityId | 是 | Long | 作品唯一标识，同creationId |
| keyType | 否 | Integer | 口令类型，默认为1。 1、一人一码 2、抽奖码 |
| pageNo | 是 | Integer | 分页查询，第几页，例如：1 |
| pageSize | 是 | Integer | 分页查询，每页多少个 |

- 接口出参
```json
{
  "success": true,
  "code": 200,
  "msg": "操作成功",
  "obj": {
    "totalUseKey": 0,
    "totalKeyNums": 10,
    "totalNotUseKey": 10
  },
  "map": {
    "pageNo": 1,
    "count": 10,
    "pageSize": 20,
    "end": true
  },
  "list": [
    {
      "id": 732134,
      "code": "9uJpeHaw",
      "keyType": 2,
      "keyNo": "osM1qAlV",
      "createTime": 1675995633000,
      "status": 0,
      "useTime": null,
      "updateTime": null,
      "openId": null,
      "encodeId": null,
      "nickName": null,
      "headImgUrl": null
    },
    {
      "id": 732135,
      "code": "9uJpeHaw",
      "keyType": 2,
      "keyNo": "wz6PTn65",
      "createTime": 1675995633000,
      "status": 0,
      "useTime": null,
      "updateTime": null,
      "openId": null,
      "encodeId": null,
      "nickName": null,
      "headImgUrl": null
    },
    {...}
  ]
}
```
- 字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| list.code | String | 活动code |
| list.keyType | Integer | 口令类型 1、一人一码 2、抽奖码 |
| list.keyNo | String | 口令 |
| list.status | Integer | 口令状态 0-未使用 1-已使用 2-已删除（注意：口令使用状态更新有延迟，一般在10分钟内） |
| list.createTime | Long | 创建时间 |
| obj.totalKeyNums | Integer | 总口令数 |
| obj.totalUseKey | Integer | 已用口令数 |
| obj.totalNotUseKey | Integer | 未使用口令数 |

## [分享奖励类型-自定义]

![](/media/202309/2023-09-11_154940_8205050.4677626489394665.png)
 接口描述：自定义增加抽奖次数接口是可以让企业通过后台接口根据业务需要向某个活动、某个访客用户追加自定义数量的抽奖次数
 要使用此接口，需要在配置作品时，参照上图进行设置。

- 接口地址：/api/v1/editor/hd/chance/custom/add?token=TOKEN
- 请求方式：POST/form-data
- 接口入参
| 参数名 | 必须 | 参数类型 | 参数说明 |
| --- | --- | --- | --- |
| code | 是 | String | 作品活动唯一编码 |
| addChance | 是 | int | 本次增加的抽奖次数-必须是大于0的整数
 |
| encodeId | 否 | String | 易企秀访客唯一标识 |
| thirdUserId | 否 | String | encodeId与thirdUserId至少上传一个且只有在易企秀侧授权登录过，传thirdUserId才能找到对应的访客进行抽奖次数增加encodeId参数的优先级高于thirdUserId，即传了encodeId,执行逻辑会忽略thirdUserId参数|

- 接口出参

```json
{
  "success": true,
  "code": "200",
  "msg": null
    }

```

- 字段说明
| 字段 | 类型 | 说明 |
| --- | --- | --- |
| success | Boolean | 本次请求是否成功 |
| code | String | 返回码  200为成功，其余字符串为请求失败的错误码 |
| msg | String | 详细信息 当请求失败时，会在msg中有详细的中文说明，若请求成功，msg一般为null|