获取活动信息
接口描述:获取活动基本信息以及基本数据统计
接口地址:/api/v1/editor/hd/activity/info?token=TOKEN&openId=OPENID
请求方式:GET
接口入参:
参数名 必须 参数类型 参数说明 creationId 是 Long 作品唯一标识 返回值
返回值说明
obj字段同“作品信息接口”字段 类型 说明 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:恢复 接口出参
奖项列表
接口描述:获取设置的奖项列表
接口地址:/api/v1/editor/hd/activity/prize/info?token=TOKEN
请求方式:GET
接口入参
参数名 必须 参数类型 参数说明 creationId 是 Long 作品唯一标识 接口出参
字段说明
字段 类型 说明 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-无须兑奖 startRedemptionTime String 兑奖开始时间 格式 yyyy-MM-dd HH:mm:ss endRedemptionTime String 兑奖结束时间 格式 yyyy-MM-dd HH:mm:ss prizeCode String 奖品编码 prizeDesc String 奖品描述 redemptionDesc String 兑奖须知 redemptionAddr String 兑奖地址
兑奖码列表-企业
接口描述:查询企业电子兑奖码
接口地址:/api/v1/editor/hd/giftcode/list?token=TOKEN
请求方式:GET
接口入参
参数名 必须 参数类型 参数说明 name 否 String 兑奖码名称 模糊查询 status 否 Integer 状态:0,使用中(已绑定到作品,未发到用户)、1:已发放(已绑定作品,用户中奖)、3:未使用(初始化导入,未绑定作品) code 否 String 兑奖码 pageNo 是 Integer 分页查询,第几页,例如:1 pageSize 是 Integer 分页查询,每页多少个 接口出参
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 分页查询,每页多少个 接口出参
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-个人 接口入参
接口出参
字段说明
参数名 必须 参数类型 参数说明 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 接口出参
发货
接口描述:管理员手动发货
接口地址:/api/v1/editor/hd/win/material/deliver?token=TOKEN
请求方式:POST
Content-Type:application/json
接口入参
参数名 必须 参数类型 参数说明 logisticsNo 是 String 物流单号 logisticsCompany 是 String 物流公司名称 winCode 是 String 兑奖码 encodeId 是 String 访客ID creationId 是 Long 作品ID 接口出参
字段说明
参数名 必须 参数类型 参数说明 logisticsNo 是 String 物流单号 logisticsCompany 是 String 物流公司名称 deliveryTime 否 String 发货时间 winId 否 Long 中奖人id
活动参与信息
活动口令列表
接口描述:获取设置的口令列表
接口地址:/api/v1/editor/hd/activity/key/keys?token=TOKEN&openId=OPENID
请求方式:GET
接口入参
参数名 必须 参数类型 参数说明 openId 是 String 作品创建人的用户id creationId 是 Long 作品唯一标识 keyType 否 Integer 口令类型,默认为1。 1、一人一码 2、抽奖码 pageNo 是 Integer 分页查询,第几页,例如:1 pageSize 是 Integer 分页查询,每页多少个 接口出参
字段说明
字段 类型 说明 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 未使用口令数
自定义增加抽奖次数接口
接口描述:自定义增加抽奖次数接口是可以让企业通过后台接口根据业务需要向某个活动、某个访客用户追加自定义数量的抽奖次数
接口地址:/api/v1/editor/hd/chance/custom/add?token=TOKEN
请求方式:POST/form-data
接口入参
参数名 必须 参数类型 参数说明 id 是 Long 作品活动唯一ID code 是 String 作品活动编码 addChance 是 int 本次增加的抽奖次数-必须是大于0的整数 encodeId 否 String 易企秀访客唯一标识 thirdUserId 否 String encodeId、thirdUserId、mobile至少上传一个,如果改访客没有在易企秀侧授权登录过则会提前注册,如果传了多个参数优先级:encodeId>thirdUserId>mobile mobile 否 String 手机号 接口出参
字段说明
字段 类型 说明 success Boolean 本次请求是否成功 code String 返回码 200为成功,其余字符串为请求失败的错误码 msg String 详细信息 当请求失败时,会在msg中有详细的中文说明,若请求成功,msg一般为null 查询抽奖次数明细
接口描述:查询抽奖次数明细
接口地址:/api/v1/editor/creation/hd/lottery/count/detail?token=TOKEN
请求方式:GET
接口入参
参数名 必须 参数类型 参数说明 thirdOpenId 是 String 作品创建人的用户id,微信授权-微信的openId、手机授权-手机号、自定义授权-userId creationId 是 Long 作品唯一标识 channelKey 否 String 自定义授权需要,为访客集成返回的channelKey 接口出参
字段说明
字段 类型 说明 currentChance Integer 当前用户剩余可抽奖次数 chanceLimit obj 系统限制的抽奖次数明细,-1为无限 chanceUsed obj 已使用次数明细,-1为无限 chanceRemaining obj 剩余次数明细,-1为无限
说明:currentChance为当前用户可使用的抽奖机会,计算方式为:currentChance = min(当日剩余次数, 当月剩余次数, 总的剩余次数, 渠道限制剩余次数, 渠道限制总数剩余次数) + 分享奖励剩余次数 + 其他奖励剩余次数
查询访客养成数据
接口描述:查询访客养成数据
接口地址:/api/v1/editor/cultivate/info?token=TOKEN
请求方式:GET
接口入参
参数名 必须 参数类型 参数说明 thirdUserId 是 String 自定义授权三方访客ID creationId 是 Long 作品唯一标识 接口出参
字段说明
字段 类型 说明 consumeNutrient Integer 用户消耗养料数 signTimes Integer 用户累计签到次数 lastSignDate String 最后签到日期(年月日 currStage Integer 当前阶段 continuousTimes Integer 连续签到天数 currNutrient Integer 用户当前养料数
查询养成排行榜
接口描述:查询养成排行榜
接口地址:/api/v1/editor/cultivate/ranking?token=TOKEN
请求方式:GET
接口入参
参数名 必须 参数类型 参数说明 creationId 是 Long 作品唯一标识 creationCode 是 String 作品编号 limitNo 否 Integer 排行榜条数 接口出参
字段说明
字段 类型 说明 rank Integer 排名 currUnit Integer 养成等级 encodeId Srtring 用户唯一标识【易企秀】 type int 授权用户类型,1微信,2手机,3自定义 corpId String 企业唯一标识 nickName String 微信昵称,customerInfo.type为1时 mobile String 手机号,customerInfo.type为2时 headImgUrl String 微信信息,customerInfo.type为1时 thirdAppId String 微信信息,appId thirdOpenId String 微信信息,openId thirdUserId String customerInfo.type为3时,三方用户ID
查询指定用户养成排名
接口描述:查询指定用户养成排名
接口地址:/api/v1/editor/cultivate/user/ranking?token=TOKEN
请求方式:GET
接口入参
参数名 必须 参数类型 参数说明 creationId 是 Long 作品唯一标识 creationCode 是 String 作品编号 thirdOpenId 是 String 作品创建人的用户id,微信授权-微信的openId、手机授权-手机号、自定义授权-userId 接口出参
字段说明
字段 类型 说明 rank Integer 排名 currUnit Integer 养成等级 encodeId Srtring 用户唯一标识【易企秀】 type int 授权用户类型,1微信,2手机,3自定义 corpId String 企业唯一标识 nickName String 微信昵称,customerInfo.type为1时 mobile String 手机号,customerInfo.type为2时 headImgUrl String 微信信息,customerInfo.type为1时 thirdAppId String 微信信息,appId thirdOpenId String 微信信息,openId thirdUserId String customerInfo.type为3时,三方用户ID