保利威文档中心

帮助中心

使用方式

更新时间:2025-07-03 14:46:06

一、开始抽奖活动

Api 方法: startLuckyLottery(activityId: number): Promise<CommonResult<string, Object>>

参数说明:

  • activityId:活动ID,number 类型,必传

返回值说明: Promise<CommonResult<string, Object>> 类型

示例:

const result = await luckyLotteryTarget.startLuckyLottery(123);
if (result.success) {
  console.log('抽奖成功', result.data);
} else {
  console.error('抽奖失败', result.failReason);
}

二、获取幸运抽奖活动列表

Api 方法: getLuckyLotteryActivityList(options?: PageOptions): Promise<PageContent<LuckyLotteryActivityItem>>

参数说明:

  • options:分页参数,PageOptions 类型,选传,默认 {},详细类型说明如下
参数名 说明 类型 必须 默认值
pageNumber 页数 number -
pageSize 页码 number -

返回值说明: 分页数据,Promise<PageContent<LuckyLotteryActivityItem>> 类型,详细类型说明如下

属性名 说明 类型
pageNumber 当前页数 number
pageSize 每页数量 number
totalItems 总记录数 number
totalPages 总页数 number
contents 内容列表 I[]

示例:

const data = await luckyLotteryTarget.getLuckyLotteryActivityList({ pageNumber: 1, pageSize: 10 });
console.log('幸运抽奖活动列表', data.contents);

三、获取幸运抽奖活动详情

Api 方法: getLuckyLotteryActivityById(activityId: number): Promise<LuckyLotteryActivityDetailData>

参数说明:

  • activityId:活动ID,number 类型,必传

返回值说明: Promise<LuckyLotteryActivityDetailData> 类型,详细类型说明如下

属性名 说明 类型
taskId 活动 ID number
lotteryStyle 活动模板 string
activityName 活动名称 string
startTime 活动开始时间,单位:毫秒 number
endTime 活动结束时间,单位:毫秒 number
drawFrequency 抽奖频率 string
drawTimes 抽奖次数 number
winLimit 中奖限制 string
maxWins 最大中奖人数 number
showWinners 是否显示中奖名单 boolean
rules 活动规则 string
noWinSetting 未中奖设置 LuckyLotteryMissSetting
channelIds 频道 ID 列表 Channel[]
prizes 奖品列表 LuckyLotteryPrize[]
status 活动状态 string
reachMaxDrawTimes 是否到达最大抽奖次数 boolean
reachMaxWinTimes 是否到达最大中奖次数 boolean

示例:

const data = await luckyLotteryTarget.getLuckyLotteryActivityById(123);
console.log('幸运抽奖活动详情', data);

四、获取中奖者列表

Api 方法: getLuckyLotteryWinnersList(options: PageOptions & Object): Promise<PageContent<LuckyLotteryWinnersItem>>

参数说明:

  • options:分页参数,包含分页信息和活动ID,PageOptions & Object 类型,必传

返回值说明: 分页数据,Promise<PageContent<LuckyLotteryWinnersItem>> 类型,详细类型说明如下

属性名 说明 类型
pageNumber 当前页数 number
pageSize 每页数量 number
totalItems 总记录数 number
totalPages 总页数 number
contents 内容列表 I[]

示例:

const data = await luckyLotteryTarget.getLuckyLotteryWinnersList({
  pageNumber: 1,
  pageSize: 10,
  taskId: 123
});
console.log('中奖者列表', data.contents);

五、获取幸运抽奖中奖记录

Api 方法: getLuckyLotteryPrizeList(options?: PageOptions): Promise<PageContent<LuckyLotteryPrizeItem>>

参数说明:

  • options:获取参数,包含分页信息,PageOptions 类型,选传,默认 {},详细类型说明如下
参数名 说明 类型 必须 默认值
pageNumber 页数 number -
pageSize 页码 number -

返回值说明: 分页数据,Promise<PageContent<LuckyLotteryPrizeItem>> 类型,详细类型说明如下

属性名 说明 类型
pageNumber 当前页数 number
pageSize 每页数量 number
totalItems 总记录数 number
totalPages 总页数 number
contents 内容列表 I[]

示例:

const data = await luckyLotteryTarget.getLuckyLotteryPrizeList({
  pageNumber: 1,
  pageSize: 10
});
console.log('奖品列表', data.contents);

六、获取中奖领取信息

Api 方法: getLuckyLotteryReceive(recordId: number): Promise<LuckyLotteryReceiveData>

参数说明:

  • recordId:中奖记录行 ID,number 类型,必传

返回值说明: Promise<LuckyLotteryReceiveData> 类型,详细类型说明如下

属性名 说明 类型
receiveType 领取方式 PrizeAcceptType
isReceived 是否已领取 boolean
formList 表单列表 LuckyLotteryReceiveFormItem[]
recordId 奖品行 ID number
taskId 活动 ID number

示例:

const data = await luckyLotteryTarget.getLuckyLotteryReceive(123);
console.log('中奖领取信息', data);

七、提交中奖领取信息

Api 方法: submitLuckyLotteryReceive(options: LuckyLotterySubmitReceiveOptions): Promise<unknown>

参数说明:

  • options:提交参数,LuckyLotterySubmitReceiveOptions 类型,必传,详细类型说明如下
参数名 说明 类型 必须 默认值
taskId 活动 ID number -
recordId 奖品行 ID number -
collectItems 领取信息 LuckyLotterySubmitReceiveItem[] -

返回值说明: Promise<unknown> 类型

示例:

await luckyLotteryTarget.submitLuckyLotteryReceive({
  taskId: 123,
  recordId: 123,
  collectItems: [{ field: '姓名', type: 'text', tips: '请输入姓名', required: true, value: '张三' }],
});
toast('提交成功');
联系客服,在线咨询