导出频道单场抽奖的中奖记录

接口URL

http://api.polyv.net/live/v3/channel/lottery/download-winner-detail

接口说明

(接口调用有频率限制,详细请查看)

1.导出频道的单场抽奖的中奖记录
2.导出表格格式可具体参考直播后台的导出中奖记录功能
3.接口支持https

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
sign true string 校验签名
appId true string 开发者账号下的appId
timestamp true string 13位当前时间的时间戳
channelId true int 频道号
lotteryId true string 抽奖ID

返回正确结果JSON示例

响应成功时,接口将返回文件流,格式为.xls,内容为导出的中奖记录数据。

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

频道不存在

{
    "code": 404,
    "status": "error",
    "message": "channel not found.",
    "data": ""
}

字段说明

参数名 说明
code 响应代码,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 错误时为空串

PHP请求示例

<?php

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

$channelId = "322120";
$params = array(
        'appId'=>$appId,
        'lotteryId'=>"ff9yv31sud",
        'channelId'=>$channelId,
        'timestamp'=>$timestamp
    );

//生成sign
$sign = getSign($params); //详细查看config.php文件
$params['sign'] = $sign;
$url="http://api.polyv.net/live/v3/channel/lottery/download-winner-detail?".http_build_query($params);
echo "<script>window.location.href='$url'</script>";
?>

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

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

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

获取频道单场抽奖的中奖记录

接口URL

http://api.polyv.net/live/v3/channel/lottery/get-winner-detail

接口说明

(接口调用有频率限制,详细请查看)

1.获取频道的单场抽奖的中奖记录
2.接口支持https

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
sign true string 校验签名
appId true string 开发者账号下的appId
timestamp true string 13位当前时间的时间戳
channelId true int 频道号
lotteryId true string 抽奖ID
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": 1,
        "contents": [
            {
                "recordId": "69aacfc0b7",
                "channelId": 108888,
                "lotteryId": "feb34vwxyd",
                "sessionId": "f6pxc1w8yb",
                "viewerId": "plk",
                "viewerName": "测试测试",
                "winnerCode": "789",
                "prize": "测试奖品",
                "name": null,
                "telephone": null,
                "createdTime": 1563763798000,
                "lastModified": 1563765266000,
                "address": null,
                "ext": "{\"receiveInfo\":[{\"field\":\"尊姓大名\",\"value\":\"测试测试\"},{\"field\":\"年龄\",\"value\":\"111\"},{\"field\":\"挖掘机技术哪家强\",\"value\":\"blueshit\"}]}"
            }
        ],
        "offset": 0,
        "limit": 1,
        "nextPageNumber": 1,
        "startRow": 1,
        "lastPage": true,
        "prePageNumber": 1,
        "firstPage": true,
        "totalPages": 1,
        "endRow": 1
    }
}
}

字段说明

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

数据对象字段说明

Paginator<WinnerRecordModel>

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

字段 类型及范围 说明
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<WinnerRecordModel> 中间记录列表
WinnerRecordModel

说明:抽奖记录

字段 类型及范围 说明
recordId string 中奖记录ID
channelId int 频道号
sessionId string 抽奖时的直播场次ID
lotteryId string 抽奖ID
viewerId string 中奖用户ID
viewerName string 中奖用户昵称
winnerCode string 中奖码
prize string 奖品名称
createdTime long 中奖时间
ext string json 格式的字符串,表示中奖记录的额外拓展信息,对应模型类:WinnerRecordModelExt
WinnerRecordModelExt

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

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

说明:中奖记录填写的领奖信息

字段 类型及范围 说明
field string 填写的字段名
value string 填写的字段值

PHP请求示例

<?php

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

$channelId = "322120";
$params = array(
        'appId'=>$appId,
        'lotteryId'=>"ff9yv31sud",
        'channelId'=>$channelId,
        'timestamp'=>$timestamp
    );

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

$url="http://api.polyv.net/live/v3/channel/lottery/get-winner-detail?".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...

获取频道抽奖记录列表

接口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...

查询指定签到ID的签到记录

接口URL

https://api.polyv.net/live/v3/channel/chat/get-checkins

接口说明

(接口调用有频率限制,详细请查看)

通过签到ID获取该次签到记录

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
sign true string 签名
appId true string 开发者账号下的appId
timestamp true string 13位当前时间的时间搓
channelId true int32 频道号
checkinId true string 签到ID

返回错误结果JSON示例

签名错误:
{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
非法频道号:
{
    "code": 403,
    "status": "error",
    "message": "illegal channel id: 372228",
    "data": ""
}

返回正确结果JSON示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "checkinid": "e45f4d20-f5fe-11e9-bb7b-0fb636",
            "nickname": "广州观众/86958",
            "checked": "Y",
            "indate": "2019-10-24",
            "id": 523520,
            "sessionId": "fh6o6k46kx",
            "time": 1571881076840,
            "userid": "1571881038428",
            "roomid": "372228"
        }
    ]
}

返回结果data表示成功修改的数量.

字段说明

字段 说明
code 返回码
status 返回状态
message 返回信息
data 操作结果

数据对象字段说明

字段 类型及范围 说明
checkinid string 签到时间
nickname string 签到学员名称
checked string 签到Y,未签到N
indate string 签到日期
id int32 签到记录主键
sessionId string 场次号
time long 签到时间
userid string 签到学员ID
roomid string 房间号

PHP请求示例

<?php

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

//接口需要的参数(非sign)赋值
$appId = "XXXXXXXX";
$channelId = "127075";
$checkinId = "xxxxxx";
$timestamp = "123123123123";
$params = array(
        'appId'=>$appId,
        'checkinId'=>$checkinId,
        'channelId'=>$channelId,
        'timestamp'=>$timestamp
    );
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

$url="https://api.polyv.net/live/v3/channel/chat/get-checkin?appId=$appId&channelId=$channelId&checkinId=$checkinId&sign=$sign&timestamp=$timestamp";

$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...

查询指定直播场次sessionId的签到场次记录

接口URL

https://api.polyv.net/live/v3/channel/chat/checkin-by-sessionId

接口说明

(接口调用有频率限制,详细请查看)

通过直播场次sessionId获取直播发起签到记录

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
sign true string 签名
appId true string 开发者账号下的appId
timestamp true string 13位当前时间的时间戳
channelId true int32 频道号
sessionId true string 场次号

返回错误结果JSON示例

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

返回正确结果JSON示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "createtime": "2019-10-24 09:37:51",
            "checkinid": "e45f4d20-f5fe-11e9-bb7b-0fb636",
            "sessionId": "fh6o6k46kx",
            "roomid": "372228"
        },
        {
            "createtime": "2019-10-24 09:46:41",
            "checkinid": "204cae80-f600-11e9-bb7b-0fb636",
            "sessionId": "fh6o6k46kx",
            "roomid": "372228"
        }
    ]
}

返回结果data表示成功修改的数量.

字段说明

字段 类型及范围 说明
code int32 返回码
status string 返回状态
message string 返回信息
data string 操作结果

数据对象字段说明

字段 类型及范围 说明
createtime string 签到时间
checkinid string 签到ID
sessionId string 场次号
roomid string 房间号

PHP请求示例

<?php

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

//接口需要的参数(非sign)赋值
$userId = "XXXXXXXX";
$channelId = "127075";
$sessionId = "xxxxxx";
$timestamp = "123123123123";
$params = array(
        'appId'=>$appId,
        'sessionId'=>$sessionId,
        'channelId'=>$channelId,
        'timestamp'=>$timestamp
    );
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法

$url="https://api.polyv.net/live/v3/channel/chat/checkin-by-sessionId?appId=$appId&channelId=$channelId&sessionId=$sessionId&sign=$sign&timestamp=$timestamp";

$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...

分页查询问卷结果

接口URL

https://api.polyv.net/live/v3/channel/questionnaire/list-answer-records

接口说明

(接口调用有频率限制,详细请查看)

1、接口用于分页查询直播问卷的答题结果及统计
2、接口支持https

返回格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId int 频道号
page int 页号,默认为1
pageSize int 每页大小,默认为10
startDate string 开始时间,格式:2018-12-10
endDate string 结束时间,格式:2018-12-10

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageNumber": 1,
        "totalItems": 3,
        "contents": [
            {
                "questionnaireId": "f7g2gtgtsd",
                "customQuestionnaireId": "xxxd33333",
                "questionnaireTitle": "ttt",
                "lastModified": 1544147881000,
                "endTime": 1544147981000,
                "questionStats": {
                    "questions": [
                        {
                            "questionId": "f7g2gtgtt9",
                            "score": 10,
                            "totalScore": 10,
                            "total": 2,
                            "correctCount": 1,
                            "d": 0,
                            "e": 0,
                            "f": 0,
                            "h": 0,
                            "i": 0,
                            "j": 0,
                            "c": 0,
                            "a": 1,
                            "b": 1,
                            "g": 0
                        },
                        {
                            "questionId": "f7g2gtgtyg",
                            "score": 10,
                            "totalScore": 10,
                            "total": 2,
                            "correctCount": 1,
                            "d": 0,
                            "e": 0,
                            "f": 0,
                            "h": 0,
                            "i": 0,
                            "j": 0,
                            "c": 0,
                            "a": 1,
                            "b": 1,
                            "g": 0
                        }
                    ],
                    "total": 2
                },
                "users": [
                    {
                        "viewerId": "1544406042082",
                        "nickname": "广州观众/98347",
                        "totalScore": 20,
                        "answers": [
                            {
                                "questionId": "f7g2gtgtt9",
                                "questionName": "a",
                                "answer": "A",
                                "score": 10,
                                "type": "R"
                            },
                            {
                                "questionId": "f7g2gtgtyg",
                                "questionName": "b",
                                "answer": "A",
                                "score": 10,
                                "type": "R"
                            }
                        ]
                    },
                    {
                        "viewerId": "oL0En04rCbHNSNdey_rFMAkLT-Ps",
                        "nickname": "ilyq69",
                        "submitTime": 1564384274000,
                        "totalScore": 0,
                        "answers": [
                            {
                                "questionId": "f7g2gtgtt9",
                                "questionName": "a",
                                "answer": "B",
                                "score": 0,
                                "type": "R"
                            },
                            {
                                "questionId": "f7g2gtgtyg",
                                "questionName": "b",
                                "answer": "B",
                                "score": 0,
                                "type": "R"
                            }
                        ]
                    }
                ]
            }
        ],
        "endRow": 3,
        "startRow": 1,
        "firstPage": true,
        "lastPage": true,
        "nextPageNumber": 1,
        "prePageNumber": 1,
        "totalPages": 1,
        "limit": 3,
        "offset": 0
    }
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

频道号格式错误

{
  "code": 400, 
  "status": "error", 
  "message": "param is not digit: dsadasd", 
  "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500(http状态码也跟code相同)
status 成功为success,失败为error
message 错误时为错误提示消息
data 成功时,返回用户答题结果及各个题目的统计信息的分页信息
pageNumber 当前页数
totalItems 总条数
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
limit 当前页数据条数
contents 频道的问卷信息和统计结果,是数组格式
questionnaireId 问卷ID,string
customQuestionnaireId 用户自定义问卷ID,string
questionnaireTitle 问卷名称,string
lastModified 问卷最后修改时间,13位毫秒级时间戳
endTime 问卷结束答题时间,13位毫秒级时间戳
questionStats 问卷下各个问题的答题统计
questionStats.total 题目的答题人数,int
questionStats.questions 题目的答题统计信息,数组[]
questionStats.questions[].questionId 题目ID,string
questionStats.questions[].questionName 题目名称,string
questionStats.questions[].score 题目分数,int
questionStats.questions[].totalScore 题目的总得分,int
questionStats.questions[].correctCount 题目的答对人数,int
questionStats.questions[].a-g 选择项a到g分别的答题人数,int
users 观看端提交答题的信息
users[].viewerId 提交问卷的用户ID,string
users[].nickname 提交问卷的用户昵称,string
users[].submitTime 提交问卷的用户答题时间,13位毫秒级时间戳
users[].totalScore 提交问卷的用户的总得分,int
users[].answers[] 用户每道题目的答题情况,数组 []
users[].answers[].questionId 题目ID,string
users[].answers[].questionName 题目名称,string
users[].answers[].answer 提交的题目答案,string
users[].answers[].score 用户答题的得分,string
users[].answers[].type 题目的类型,string,R 单选题 ,C 多项题 ,Q 问答题

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => 195770,
  'startDate' => '2018-12-08',
  'endDate' => '2018-12-10'  
);

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

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

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, 1);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>

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

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

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

查询频道问卷详情

接口URL

https://api.polyv.net/live/v3/channel/questionnaire/detail

接口说明

(接口调用有频率限制,详细请查看)

1、接口用于查询频道问卷详情
2、问卷ID 可以从获取频道问卷列表中获取
3、接口支持https

返回结果格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId int 频道号
questionnaireId string 问卷id

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "questionnaireId": "fefg598lfj",
        "customQuestionnaireId": "ddddxxx222",
        "channelId": 108888,
        "userId": "edvf2fpec9",
        "name": "测试问卷_1564105496583",
        "status": "forbidden",
        "createdTime": 1564105498000,
        "lastModified": 1564105498000,
        "endTime": 1564105580000,
        "questions": [
            {
                "questionId": "3839e04e78",
                "channelId": 108888,
                "userId": "edvf2fpec9",
                "name": "您觉得课程怎么样",
                "type": "C",
                "option1": "好",
                "option2": "很好",
                "option3": "非常好",
                "option4": "超级好",
                "option5": "以上都对",
                "createdTime": 1564105498000,
                "lastModified": 1564105498000,
                "answer": "",
                "note": null,
                "templateId": null,
                "status": "draft",
                "times": 0,
                "tips1": null,
                "tips2": null,
                "tips3": null,
                "tips4": null,
                "tips5": null,
                "required": "Y",
                "scoreEnabled": "N",
                "option6": "",
                "option7": "",
                "option8": "",
                "option9": "",
                "option10": "",
                "score": null,
                "itemType": 0
            },
            {
                "questionId": "847cd79c2f",
                "channelId": 108888,
                "userId": "edvf2fpec9",
                "name": "您从哪里获取该课程",
                "type": "C",
                "option1": "自己找到",
                "option2": "好友推荐",
                "option3": "媒体文章",
                "option4": "",
                "option5": "",
                "createdTime": 1564105498000,
                "lastModified": 1564105498000,
                "answer": "",
                "note": null,
                "templateId": null,
                "status": "draft",
                "times": 0,
                "tips1": null,
                "tips2": null,
                "tips3": null,
                "tips4": null,
                "tips5": null,
                "required": "Y",
                "scoreEnabled": "N",
                "option6": "",
                "option7": "",
                "option8": "",
                "option9": "",
                "option10": "",
                "score": null,
                "itemType": 0
            },
            {
                "questionId": "c908c81e80",
                "channelId": 108888,
                "userId": "edvf2fpec9",
                "name": "今后还会不会来",
                "type": "R",
                "option1": "会",
                "option2": "不会",
                "option3": "",
                "option4": "",
                "option5": "",
                "createdTime": 1564105498000,
                "lastModified": 1564105498000,
                "answer": "",
                "note": null,
                "templateId": null,
                "status": "draft",
                "times": 0,
                "tips1": null,
                "tips2": null,
                "tips3": null,
                "tips4": null,
                "tips5": null,
                "required": "Y",
                "scoreEnabled": "N",
                "option6": "",
                "option7": "",
                "option8": "",
                "option9": "",
                "option10": "",
                "score": null,
                "itemType": 0
            },
            {
                "questionId": "6dba1e90da",
                "channelId": 108888,
                "userId": "edvf2fpec9",
                "name": "请问您对课程有不满意的地方吗",
                "type": "Q",
                "option1": "",
                "option2": "",
                "option3": "",
                "option4": "",
                "option5": "",
                "createdTime": 1564105498000,
                "lastModified": 1564105498000,
                "answer": "",
                "note": null,
                "templateId": null,
                "status": "draft",
                "times": 0,
                "tips1": null,
                "tips2": null,
                "tips3": null,
                "tips4": null,
                "tips5": null,
                "required": "Y",
                "scoreEnabled": "N",
                "option6": "",
                "option7": "",
                "option8": "",
                "option9": "",
                "option10": "",
                "score": null,
                "itemType": 0
            }
        ]
    }
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

问卷ID不存在

{
    "code": 400,
    "data": "",
    "message": "questionnaire is not exist",
    "status": "error"
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
questionnaireId 问卷ID
customQuestionnaireId 用户自定义问卷ID
channelId 频道ID
userId 用户ID
name 问卷名称
status 问卷状态
createdTime 问卷创建时间
endTime 停止问卷时间
questions 问卷问题列表

问卷问题模型类question

参数名 说明
questionId 问题ID
name 问题题目
type 问题类型,取值:R 单选;C 多选;S 评星题;Q 问答
option1~10 选项A~G 的内容
createdTime 创建时间
lastModified 最后修改时间
scoreEnabled 是否计分,取值Y、N
score 题目分值
required 是否必填,取值Y、N
answer 问题答案

php请求示例

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

$params = array(
    'appId' => $appId,
    'timestamp' => $timestamp,
    'channelId' => 108888,
    'questionnaireId' =>'xxxaaa'
);

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

$url = "https://api.polyv.net/live/v3/channel/questionnaire/detail?".http_build_query($params);

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_URL, $url);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>

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

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

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

查询频道问卷列表

接口URL

https://api.polyv.net/live/v3/channel/questionnaire/list

接口说明

(接口调用有频率限制,详细请查看)

1、接口用于获取频道的问卷列表
2、接口支持https

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId string 频道号
startTime long 查询的记录的开始时间,13位位毫秒级时间戳
endTime long 查询的记录的结束时间,13位毫秒级时间戳
page int 页号,默认为1
pageSize int 每页条数,默认为10

注意:要按时间区间查询时,startTime 和 endTime 必须同时传参才能生效

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 10,
        "pageNumber": 1,
        "totalItems": 2,
        "contents": [
            {
                "questionnaireId": "fefg598lfj",
                "channelId": 108888,
                "userId": "edvf2fpec9",
                "name": "测试问卷_1564105496583",
                "status": "forbidden",
                "createdTime": 1564105498000,
                "lastModified": 1564105498000,
                "endTime": 1564105580000,
                "customQuestionnaireId": "xxxxxx"
            },
            {
                "questionnaireId": "fefg4s724k",
                "channelId": 108888,
                "userId": "edvf2fpec9",
                "name": "测试问卷",
                "status": "forbidden",
                "createdTime": 1564105469000,
                "lastModified": 1564105469000,
                "endTime": 1564105487000,
                "customQuestionnaireId": "xxxxxx"
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": true,
        "nextPageNumber": 1,
        "prePageNumber": 1,
        "limit": 2,
        "endRow": 2,
        "totalPages": 1,
        "offset": 0
    }
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

字段说明

参数名 说明
code 响应的状态码,例如:200
status 响应状态
message 异常错误信息
data 响应结果集
pageNumber 当前的页数
totalItems 总的条数
contents 查询的结果列表
questionnaireId 问卷ID
channelId 频道ID
userId 用户ID
name 问卷名称
status 问卷状态,取值:saved(已保存),published (已发布),forbidden (问卷已完成填写)
createdTime 问卷创建时间
lastModified 问卷最后修改时间
endTime 停止提交问卷时间
customQuestionnaireId 用户自定义问卷ID
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
startRow 当前页第一个视频在回放视频中的位置
endRow 当前页最后一个视频在回放视频中的位置
limit 当前页视频个数

php请求示例

<?php
//引用config.php
include 'config.php';
$params = array(
    'appId' => $appId,
    'timestamp' => $timestamp,
    'channelId' => 108888
);

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

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

$curl = curl_init();
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 500);
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_URL, $url);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>

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

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

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

发送打赏消息

接口URL

http://api.polyv.net/live/v3/channel/chat/send-reward-msg

接口说明

(接口调用有频率限制,详细请查看)

  1. 用于发送打赏消息
  2. 请求成功后,服务器会向聊天室的用户广播打赏消息,详见直播聊天室API接口
  3. 接口支持https

返回结果支持格式

JSON

请求方式

POST

请求参数

参数名 必选 类型 说明
channelId int 频道ID
appId string 账号的应用ID,在后台的“开发设置”获取
timestamp long 13位毫秒级时间戳
sign string 签名,为32位大写的MD5值
nickname string 打赏者昵称
avatar string 打赏者头像
viewerId string 打赏者ID
donateType string 打赏类型,取值:cash 现金打赏,good 道具打赏
content string 打赏内容:礼物打赏为礼物名称,现金打赏为金额
goodImage string 礼物打赏时为礼物图片,现金打赏时为空
sessionId string 直播场次ID

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": 0
}

响应失败JSON示例:

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

appId不正确

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

时间戳错误

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

频道号格式错误

{
  "code": 400,
  "status": "error",
  "message": "param is not digit: 输入的错误频道号",
  "data": ""
}

道具打赏时未提交道具图片

{
  "code": 400,
  "status": "error",
  "message": "param should not be empty:goodImage",
  "data": ""
}

发送失败

{
    "code": 400,
    "status": "error",
    "message": "send message failure",
    "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 暂无作用

请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => "108888",
  'nickname' => "wenen",
  'avatar' => "https://livestatic.videocc.net/uploaded/images/webapp/avatar/default-teacher.png",
  'viewerId' => "123",
  'donateType' => "good",
  'content' => "黄钻",
  'goodImage' => "http://livestatic.videocc.net/uploaded/images/webapp/channel/donate/06-star.png"
);

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法


$url="http://api.polyv.net/live/v3/channel/chat/send-reward-msg";

function post($url, $post_data = '', $timeout = 5){
   $ch = curl_init();
   curl_setopt ($ch, CURLOPT_URL, $url);
   curl_setopt ($ch, CURLOPT_POST, 1);
   if($post_data != ''){
      curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
   }

   curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
   curl_setopt ($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
   curl_setopt($ch, CURLOPT_HEADER, false);
   curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
   $file_contents = curl_exec($ch);
   curl_close($ch);
   return $file_contents;
}

$params["sign"] = $sign;
echo post($url,http_build_query($params));
?>

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

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

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

设置抽奖中奖者信息

接口URL

http://api.polyv.net/live/v3/channel/chat/add-receive-info

接口说明

(接口调用有频率限制,详细请查看)

1、用于提交中奖者填写的信息
2、只能成功保存一次观众中奖信息
3、中奖信息需在7天内提交保存,否则会失效
4、接口支持https

返回结果支持格式

JSON

请求方式

POST

请求参数

参数名 必选 类型 说明
channelId string 频道ID
appId string 账号的应用ID,在后台的“开发设置”获取
timestamp long 13位毫秒级时间戳
sign string 签名,为32位大写的MD5值
lotteryId string 抽奖场次ID
winnerCode string 中奖码
viewerId string 中奖者ID
name string 中奖者姓名,如果传姓名,必须传中奖者手机号码,receiveInfo字段不需要传(无效)
telephone string 中奖者手机号码,如果传手机号,必须传中奖者姓名,receiveInfo字段不需要传(无效)
receiveInfo string 自定义字段数据,数据类型为数组JSON[{"field":"姓名","value":"测试"},{"field":"手机","value":"13412345678"}] field:字段名称,value:字段值,如果传这个参数,name和telephone字段不需要传(无效)

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "保存成功",
    "data": ""
}

响应失败JSON示例:

手机号码格式错误

{
    "code": 400,
    "status": "fail",
    "message": "手机号码格式错误",
    "data": ""
}

重复提交(已经成功提交过中奖信息后则不能再次请求)

{
    "code": 400,
    "status": "fail",
    "message": "请勿重复提交",
    "data": ""
}

中奖码不存在

{
    "code": 400,
    "status": "fail",
    "message": "中奖码不存在",
    "data": ""
}

抽奖场次ID错误

{
    "code": 400,
    "status": "fail",
    "message": "illegal lottery id: 错误的ID",
    "data": ""
}

有参数未提交

{
  "code": 400,
  "status": "error",
  "message": "param should not be empty:未提交的参数名",
  "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 暂无作用

请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => "108888",
  'lotteryId' => "f76did5ldj",
  'viewerId' => "viewerId1231",
  'winnerCode' => "12121212123",
  'name' => "wenwenwen",
  'telephone' => "15625123456"
);

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法


$url="http://api.polyv.net/live/v3/channel/chat/add-receive-info";

function post($url, $post_data = '', $timeout = 5){
   $ch = curl_init();
   curl_setopt ($ch, CURLOPT_URL, $url);
   curl_setopt ($ch, CURLOPT_POST, 1);
   if($post_data != ''){
      curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
   }

   curl_setopt ($ch, CURLOPT_RETURNTRANSFER, 1);
   curl_setopt ($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
   curl_setopt($ch, CURLOPT_HEADER, false);
   curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));
   $file_contents = curl_exec($ch);
   curl_close($ch);
   return $file_contents;
}

$params["sign"] = $sign;
echo post($url,http_build_query($params));
?>

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

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

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