获取频道抽奖记录列表

接口URL

http://api.polyv.net/live/v3/channel/lottery/list-lottery

接口说明

1.获取一段时间内的直播频道抽奖记录列表
2.接口支持https

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
sign true string 校验签名
appId true string 开发者账号下的appId
timestamp true string 13位当前时间的时间戳
channelId true int 频道号
sessionId false string 要查询的直播场次ID
startTime true long 查询的开始日期的13位时间戳
endTime true long 查询的结束日期的13位时间戳
page false int 查询的页数,默认为1
limit false int 查询的每页大小,默认为10

返回错误结果JSON示例

签名错误:
{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
时间戳错误:
{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

返回正确结果JSON示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 10,
        "pageNumber": 1,
        "totalItems": 3,
        "contents": [
            {
                "lotteryId": "feb34vwxyd",
                "channelId": 108888,
                "userId": "edvf2fpec9",
                "sessionId": "f6pxc1w8yb",
                "lotteryRange": "all",
                "actor": null,
                "prize": "测试奖品",
                "amount": 1,
                "preset": null,
                "createdTime": 1563763720000,
                "lastModified": 1563763720000,
                "ext": "{\"collectInfo\":[{\"field\":\"尊姓大名\",\"tips\":\"请输入您的name\"},{\"field\":\"年龄\",\"tips\":\"请输入您的生辰八字\"},{\"field\":\"挖掘机技术哪家强\",\"tips\":\"请回答\"}]}",
                "winnerCount": "1"
            },
            {
                "lotteryId": "feb2ricnjz",
                "channelId": 108888,
                "userId": "edvf2fpec9",
                "sessionId": "f6pxc1w8yb",
                "lotteryRange": "all",
                "actor": null,
                "prize": "测试奖品",
                "amount": 1,
                "preset": null,
                "createdTime": 1563762912000,
                "lastModified": 1563762912000,
                "ext": "{\"collectInfo\":[{\"field\":\"姓名\",\"tips\":\"请输入您的姓名\"},{\"field\":\"手机号码\",\"tips\":\"请输入您的手机号码\"},{\"field\":\"地址\",\"tips\":\"请输入您的收件地址\"}]}",
                "winnerCount": "1"
            },
            {
                "lotteryId": "fd22kkk13e",
                "channelId": 108888,
                "userId": "edvf2fpec9",
                "sessionId": "f6pxc1w8yb",
                "lotteryRange": "all",
                "actor": null,
                "prize": "键盘",
                "amount": 1,
                "preset": null,
                "createdTime": 1560236105000,
                "lastModified": 1560236105000,
                "ext": "{\"collectInfo\":[{\"field\":\"姓名\",\"tips\":\"请输入您的姓名\"},{\"field\":\"手机号码\",\"tips\":\"请输入您的手机号码\"},{\"field\":\"地址\",\"tips\":\"请输入您的收件地址\"}]}",
                "winnerCount": "0"
            }
        ],
        "offset": 0,
        "limit": 3,
        "nextPageNumber": 1,
        "startRow": 1,
        "lastPage": true,
        "prePageNumber": 1,
        "firstPage": true,
        "totalPages": 1,
        "endRow": 3
    }
}

字段说明

字段 类型及范围 说明
code int 接口请求状态码,200表示成功
status string 接口请求状态,"success"表示成功
message string 请求失败时返回的错误信息
data Paginator<LotteryListModel> 抽奖记录的分页结果

数据对象字段说明

Paginator<LotteryListModel>

说明:抽奖记录的分页结果

字段 类型及范围 说明
pageNumber int 当前的页数
totalItems int 总记录数
firstPage boolean 是否为第一页,值为:true/false
lastPage boolean 是否为最后一页,值为:true/false
nextPageNumber int 下一页编号
prePageNumber int 上一页编号
totalPages int 总页数
startRow int 当前页第一条记录在总记录中的位置
endRow int 当前页最后一个记录在总记录中的位置
limit int 当前页记录个数
contents List<LotteryListModel> 抽奖记录列表
LotteryListModel

说明:抽奖记录

字段 类型及范围 说明
lotteryId string 抽奖场次ID
channelId int 频道号
sessionId string 抽奖时的直播场次ID
lotteryRange string, 取值:所有观众:all; 当场直播未中奖用户:notWinning; 已签到用户:signed;头衔: actor;已填问卷用户: questionnaire 抽奖范围
actor string 抽奖范围为按头衔抽奖时的头衔
prize string 奖品名称
amount int 预设中奖人数
preset int 预设中奖观众ID,多个ID 用英文逗号分开
createdTime long 抽奖时间
winnerCount int 实际中奖人数
ext string json 格式的字符串,表示抽奖的额外拓展信息,对应模型类:LotteryListModelExt
LotteryListModelExt

说明:抽奖记录的拓展信息

字段 类型及范围 说明
collectInfo List<CollectInfoFieldModel> 领奖人需要填写的兑奖信息
CollectInfoFieldModel

说明:领奖人需要填写的领奖信息

字段 类型及范围 说明
field string 填写的字段名
tips string 填写的字段提示

PHP请求示例

<?php

//引用config.php
include 'config.php';

$channelId = "322120";
$params = array(
        'appId'=>$appId,
        'startTime'=>1566489821000,
        'endTime'=>time()*1000,
        'channelId'=>$channelId,
        'timestamp'=>$timestamp
    );

//生成sign
$sign = getSign($params); //详细查看config.php文件
$params['sign'] = $sign;

$url="http://api.polyv.net/live/v3/channel/lottery/list-lottery?".http_build_query($params);

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;
?>

签名规则(config.php文件代码查看)

http://dev.polyv.net/2018/liveproduct/l-api/rule/sign/

以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...