移除频道聊天审核内容

接口URL

https://api.polyv.net/live/v3/channel/chat/remove-censor-content

接口说明

1、作用:用于移除聊天审核内容接口
2、接口支持https协议

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前时间的秒级时间戳(13位)
sign string 签名,为32位大写的MD5值
channelId int 频道号
id string 聊天审核内容ID

操作成功响应示例

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

操作失败响应示例

签名错误

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

响应字段说明

名称 类型 说明
code string 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data string 成功返回信息

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => '123456',
  'id' => 'sdadada'
);

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

$url = "https://api.polyv.net/live/v3/channel/chat/remove-censor-content?".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/chat/update-censor-enabled

接口说明

1、作用:用于更新聊天审核开关接口
2、接口支持https协议

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前时间的秒级时间戳(13位)
sign string 签名,为32位大写的MD5值
channelId int 频道号

操作成功响应示例

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

操作失败响应示例

签名错误

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

响应字段说明

名称 类型 说明
code string 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data boolean 设置成功返回当前聊天审核开关类型,开启为true,没开启为false

php请求示例

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

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => '123456'
);

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

$url = "https://api.polyv.net/live/v3/channel/chat/update-censor-enabled?".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...

获取调用聊天室接口所需的sign接口

接口URL

https://api.polyv.net/live/v3/channel/monitor/get-room-sign

接口说明

1、作用:用于用于获取调用聊天室接口所需的sign
2、接口支持https协议

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前时间的秒级时间戳(13位)
sign string 签名,为32位大写的MD5值
channelId int 频道号

操作成功响应示例

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

操作失败响应示例

签名错误

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

响应字段说明

名称 类型 说明
code string 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data string 成功返回聊天室接口所需的sign

php请求示例

<?php

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

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

//生成sign
$sign = getSign($params); //详细查看config.php文件
$params['sign'] = $sign;
$url="https://api.polyv.net/live/v3/channel/monitor/get-room-sign?".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

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

接口说明

1、作用:用于获取聊天审核开关接口
2、接口支持https协议

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前时间的秒级时间戳(13位)
sign string 签名,为32位大写的MD5值
channelId int 频道号

操作成功响应示例

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

操作失败响应示例

签名错误

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

响应字段说明

名称 类型 说明
code string 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data boolean 成功返回是否开启了聊天审核开关,开启为true,没开启为false

php请求示例

<?php

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

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

//生成sign
$sign = getSign($params); //详细查看config.php文件
$params['sign'] = $sign;
$url="https://api.polyv.net/live/v3/channel/chat/get-censor-enabled?".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

https://api.polyv.net/live/v3/channel/monitor/get-info

接口说明

1、作用:用于获取直播监控信息
2、接口支持https协议

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前时间的秒级时间戳(13位)
sign string 签名,为32位大写的MD5值
channelId int 频道号

操作成功响应示例

{
  "code": 200,
  "message": "",
  "status": "success",
  "data": {
    "userId": "xxxxx",
    "status": "N",
    "banPush": "N",
    "scene": "alone",
    "debugEnabled": "N",
    "marqueeEnabled": "Y",
    "consultingMenuEnabled": "Y",
    "cdnType": "uc",
    "sign": "xxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "roomIds": "",
    "roomSign": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "chatTranslateEnabled": "Y",
    "showCustomMessageEnabled": "Y",
    "chatAdmin": {
      "channelId": xxxxxx,
      "type": "admin",
      "nickname": "管理员",
      "actor": "管理员",
      "avatar": "//s1.videocc.net/face.png",
      "createdTime": 1588678231000,
      "lastModified": 1588678231000
    },
    "chatToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "chatEnabled": "Y"
  }
}

操作失败响应示例

签名错误

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

响应字段说明

名称 类型 说明
code string 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data object 成功返回信息
data.userId string 用户ID
data.status string 当前是否是直播状态(Y/N)
data.banPush string 是否是禁止推流状态(Y/N)
data.scene string 当前直播场景 ("alone" : 普通直播;"topclass" : 大班课;"ppt" : 三分屏 )
data.debugEnabled string 是否开启了调试模式(Y/N)
data.marqueeEnabled string 跑马灯开关(Y/N)
data.consultingMenuEnabled string 咨询提问开关(Y/N)
data.cdnType string cdn类型
data.sign string 频道号房间聊天室sign
data.roomIds string 多房间ID
data.roomSign string 多房间聊天室sign
data.chatTranslateEnabled string 聊天室翻译开关(Y/N)
data.showCustomMessageEnabled string 是否展示自定义消息开关(Y/N)
data.chatToken string 聊天室token
data.chatAdmin object 聊天室管理员信息对象
data.chatAdmin.channelId int 聊天室对应频道号
data.chatAdmin.type string 聊天室角色类型
data.chatAdmin.nickname string 聊天室管理员昵称
data.chatAdmin.actor string 聊天室管理员头衔
data.chatAdmin.avatar string 聊天室管理员头像
data.chatAdmin.createdTime string 聊天室管理员创建时间
data.chatAdmin.lastModified string 聊天室管理员更新时间

php请求示例

<?php

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

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

//生成sign
$sign = getSign($params); //详细查看config.php文件
$params['sign'] = $sign;
$url="https://api.polyv.net/live/v3/channel/monitor/get-info?".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

https://api.polyv.net/live/v3/user/statistics/viewlog

接口说明

1、作用:分页获取用户的观看日志
2、接口支持https协议

返回结果支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId true string 从API设置中获取,在直播系统登记的appId
timestamp true string 当前13位毫秒级时间戳,3分钟内有效
sign true string 签名,32位大写MD5值
page true string 页数
pageSize string 每页显示的数据条数,默认每页显示1000条数据
startDate true 请查看下方注意点 string 查询开始时间,格式:yyyy-MM-dd
endDate true 请查看下方注意点 string 查询结束时间,格式:yyyy-MM-dd
channelId false int 频道ID

注意
1. 如果查询一段时间的记录,可以传:startDate、endDate (startDate和endDate 必须在同一个月);

响应成功JSON示例:

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": {
        "pageNumber": 1, 
        "totalItems": 3, 
        "contents": [
{
"playId": "1520501687122X1438160",
"userId": "1c6dc3c666",
"channelId": 151462,
"playDuration": 341,
"stayDuration": 361,
"flowSize": 10028116,
"sessionId": "eyz0awxrlh",
"param1": "1520499775580",
"param2": "广州观众/78614",
"param3": "live",
"param4": "",
"param5": "",
"ipAddress": "59.42.41.1",
"country": "中国",
"province": "广东",
"city": "广州",
"isp": "/南沙区电信",
"referer": "https://live.polyv.cn/watch/151462",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Safari/537.36",
"operatingSystem": "Mac OS X",
"browser": "Chrome",
"isMobile": "N",
"currentDay": "2018-03-08",
"createdTime": 1520501705000,
"lastModified": 1520504494000
}, 
{
"playId": "1520501157256X1429802",
"userId": "1c6dc3c666",
"channelId": 151462,
"playDuration": 29,
"stayDuration": 528,
"flowSize": 1068201,
"sessionId": "eyz0awxrlh",
"param1": "1520499775580",
"param2": "广州观众/78614",
"param3": "live",
"param4": "",
"param5": "",
"ipAddress": "59.42.41.1",
"country": "中国",
"province": "广东",
"city": "广州",
"isp": "/南沙区电信",
"referer": "https://live.polyv.cn/watch/151462",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Safari/537.36",
"operatingSystem": "Mac OS X",
"browser": "Chrome",
"isMobile": "N",
"currentDay": "2018-03-08",
"createdTime": 1520501664000,
"lastModified": 1520504494000
}, 
            {
"playId": "1520500551108X1714565",
"userId": "1c6dc3c666",
"channelId": 151462,
"playDuration": 18,
"stayDuration": 20,
"flowSize": 3048444,
"sessionId": "eyz0awxrlh",
"param1": "1520499775580",
"param2": "广州观众/78614",
"param3": "live",
"param4": "",
"param5": "",
"ipAddress": "59.42.40.205",
"country": "中国",
"province": "广东",
"city": "广州",
"isp": "/南沙区电信",
"referer": "https://live.polyv.cn/watch/151462",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Safari/537.36",
"operatingSystem": "Mac OS X",
"browser": "Chrome",
"isMobile": "N",
"currentDay": "2018-03-08",
"createdTime": 1520500572000,
"lastModified": 1520503294000
}
        ], 
        "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": "startDate and endDate can not be empty.",
    "data": ""
}

查询的开始时间大于结束时间

{
    "code": 400,
    "status": "error",
    "message": "startDate can not great endDate.",
    "data": ""
}

查询的时间跨月了

{
    "code": 400,
    "status": "error",
    "message": "unable cross month query",
    "data": ""
}

非法的频道ID

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

字段说明

参数名 说明
code 响应的状态码,例如:200
status 响应状态
message 异常错误信息
data 响应结果集
pageNumber 当前的页数
totalItems 总的条数
contents 查询的结果列表
playId 表示此次播放动作的ID
userId 用户ID
channelId 频道号
playDuration 播放时长
stayDuration 停留时长
flowSize 流量大小
sessionId 直播场次ID
param1 使用POLYV观看页的观众ID
param2 使用POLYV观看页的观众昵称
param3 观看类型:取值 live(直播)、vod(回放)
param4/5 POLYV系统参数
ipAddress IP地址
country 国家
province 省份
city 城市
isp ISP运营商
referer 播放视频页面地址
userAgent 用户设备
operatingSystem 操作系统
browser 浏览器
isMobile 是否为移动端
currentDay 日志查询日期 (格式为:yyyy-MM-dd)
createdTime 日志创建日期 (13位时间戳)
lastModified 日志更新日期 (13位时间戳)
firstPage 是否为第一页,值为:true/false
lastPage 是否为最后一页,值为:true/false
nextPageNumber 下一页编号
prePageNumber 上一页编号
totalPages 总页数
startRow 当前页第一个视频在回放视频中的位置
endRow 当前页最后一个视频在回放视频中的位置
limit 当前页视频个数

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$startDate = "2020-03-12";  
$endDate = "2020-03-30";  
$page = "1"; //页数
$pageSize="10";//每页显示的数据

$params = array(
    'appId'=>$appId,
    'startDate'=>$startDate,
    'endDate'=>$endDate,
    'page'=>$page,
    'pageSize'=>$pageSize,
    'timestamp'=>$timestamp
  );

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

//接口请求url
$url = "http://api.polyv.net/live/v3/user/statistics/viewlog?appId=$appId&startDate=startDate&endDate=endDate&page=$page&pageSize=$pageSize&timestamp=$timestamp&sign=$sign";

//输出接口请求结果
echo file_get_contents($url);

?>

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

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

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

查询场次信息列表

接口URL

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

接口说明

获取直播的场次信息列表
接口支持https

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
sign true string 校验签名
appId true string 开发者账号下的appId
timestamp true string 13位当前时间的时间戳
channelId false int 频道ID,当不传频道ID就是查询用户下所有频道的场次
start false long 开始时间,格式: 13位时间戳
end false long 结束时间,格式:13位时间戳

返回正确结果JSON示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":[
        {
            "sessionId":"fmwuubgojd",
            "channelId":1362350,
            "channelAccount":null,
            "liveType":"alone",
            "streamName":"4d57ea01de1587722394602020e",
            "createdTime":1588038557000,
            "lastModified":1588038557000,
            "pushClient":"mac"
        },
        {
            "sessionId":"fmsv7rte20",
            "channelId":1362350,
            "channelAccount":null,
            "liveType":"alone",
            "streamName":"4d57ea01de1587722394602020e",
            "createdTime":1587725914000,
            "lastModified":1587725914000,
            "pushClient":"mac"
        },
        {
            "sessionId":"fmsutw2fn5",
            "channelId":1362350,
            "channelAccount":null,
            "liveType":"alone",
            "streamName":"4d57ea01de1587722394602020e",
            "createdTime":1587725075000,
            "lastModified":1587725075000,
            "pushClient":"mac"
        }
    ]
}

响应失败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 int 接口请求状态码,200表示成功
status string 接口请求状态,"success"表示成功
message string 请求失败时返回的错误信息
data 列表 查询的结果
data.sessionId string 场次ID
data.channelId int 频道ID
data.channelAccount string 子账号ID
data.liveType string 频道对应的场景
data.streamName string 直播的流名称
data.createdTime long 创建时间,13位的时间戳
data.lastModified long 最后修改时间,13位的时间戳
data.pushClient string 推流的客户端

PHP请求示例

<?php

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

$type = "mic";
$params = array(
        'appId'=>$appId,
        'channelId'=>$channelId,
        'start'=>$start,
        'end'=>$end,        
        'timestamp'=>$timestamp
    );

//生成sign
$sign = getSign($params); //详细查看config.php文件
$params['sign'] = $sign;
$url="http://api.polyv.net/live/v3/channel/session/simple-list?".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

https://api.polyv.net/v2/video/{userid}/audit-video

接口说明

修改视频审核状态的接口

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
userid string 用户ID
ptime string 当前时间的毫秒级时间戳(13位),3分钟内有效
vid string 视频ID
reviewResult string 审核的状态,例如:pass,目前仅支持pass
sign string 签名,为40位大写的SHA1值

JSON示例

{
  code: 200,
  status: "success",
  message: "success",
  data: ""
}
{
  code: 400,
  status: "error",
  message: "vid不能为空",
  data: ""
}
{
  code: 400,
  status: "error",
  message: "reviewResult不能为空",
  data: ""
}
{
  code: 400,
  status: "error",
  message: "reviewResult值不对",
  data: ""
}
{
  code: 400,
  status: "error",
  message: "视频ID和用户不对应",
  data: ""
}
{
  code: 400,
  status: "error",
  message: "账号没有操作该接口的权限",
  data: ""
}
{
  code: 400,
  status: "error",
  message: "视频不存在",
  data: ""
}
{
  code: 400,
  status: "error",
  message: "只有审核不通过的视频才可以修改审核状态",
  data: ""
}
{
  code: 400,
  status: "error",
  message: "视频被判定为确认违规,无法修改审核状态,如有疑问请联系客服处理",
  data: ""
}

字段说明

字段 说明
status 成功/失败状态
code 成功/失败代码
message 成功/失败信息
data 成功/失败数据

php请求示例

<?php
  $userid="8f8482aaab";
  $secretkey="AiDQw1mAmi";
  $vid="8f8482aaab8fe7ea12e3314a11a061fc_8";
  $reviewResult="pass";
  $ptime=time()*1000;
  $str="ptime=$ptime&reviewResult=$reviewResult&vid=$vid".$secretkey;
  $sign=strtoupper(sha1($str));
  $url="http://api.polyv.net/v2/video/$userid/audit-video?ptime=$ptime&reviewResult=$reviewResult&vid=$vid&sign=$sign";
  $content = file_get_contents($url);
  echo $content;
?>

签名规则

将请求参数(sign除外)按照参数名字典顺序排列,用“&”连接参数名与参数值,并在最后加上secretkey的值,生成40位大写的SHA1值,作为sign。

以下是示例过程:

1. 将请求参数按照参数名字典顺序排列为:

reviewResult="pass"
ptime="1476753635000";
vid="8f8482aaab8fe7ea12e3314a11a061fc_8";

2. 连接字符串 用“&”连接参数名与参数值,并在最后加上secretkey的值,生成40位大写的SHA1值,作为sign(本示例的值为AiDQw1mAmi),如下:

ptime=1476753635000&reviewResult=pass&vid=8f8482aaab8fe7ea12e3314a11a061fc_8AiDQw1mAmi

3. 生成签名sign

sign为40位大写的SHA1值:

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

获取账单列表

接口URL

http://api.polyv.net/live/v3/finance/bill/list

接口说明

分页获取帐号日账单列表
接口支持https

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
sign true string 校验签名
appId true string 开发者账号下的appId
timestamp true string 13位当前时间的时间戳
type false string 账单类型,live:云直播,mic:连麦 , 默认:live
page false int 第几页
pageSize false int 每页大小
startDay false string 开始时间,格式:YYYY-MM-DD
endDay false string 结束时间,格式:YYYY-MM-DD

返回正确结果JSON示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 2,
        "pageNumber": 1,
        "totalItems": 78,
        "contents": [
            {
                "userId": "ee7fe7fbda",
                "inmonth": "2020-03",
                "currentDay": "2020-03-25",
                "total": 1,
                "billingType": "duration",
                "email": "moshunwei@polyv.net",
                "unit": "分钟",
                "consumerType": "后付费",
                "productType": "云直播"
            },
            {
                "userId": "ee7fe7fbda",
                "inmonth": "2020-03",
                "currentDay": "2020-03-24",
                "total": 40,
                "billingType": "duration",
                "email": "moshunwei@polyv.net",
                "unit": "分钟",
                "consumerType": "后付费",
                "productType": "云直播"
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": false,
        "nextPageNumber": 2,
        "prePageNumber": 1,
        "limit": 2,
        "totalPages": 39,
        "endRow": 2,
        "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": "invalid bill type",
    "data": ""
}

字段说明

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

数据对象字段说明

Paginator<BillDailyModel>

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

字段 类型及范围 说明
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<BillDailyModel> 账单列表
BillDailyModel

说明:抽奖记录

字段 类型及范围 说明
userId string 用户userId
inmonth string 账期
currentDay string 消费日期
total int 使用分钟数,单位分钟
billingType string 账单类型,live:云直播,mic:连麦
email string 邮箱
unit string 单位
consumerType string 计费项
productType long 产品项

PHP请求示例

<?php

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

$type = "mic";
$params = array(
        'appId'=>$appId,
        'type'=>$type,
        'timestamp'=>$timestamp
    );

//生成sign
$sign = getSign($params); //详细查看config.php文件
$params['sign'] = $sign;
$url="http://api.polyv.net/live/v3/finance/bill/list?".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/finance/bill/list-detail

接口说明

分页获取帐号日账单列表
接口支持https

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
sign true string 校验签名
appId true string 开发者账号下的appId
timestamp true string 13位当前时间的时间戳
type false string 账单类型,live:云直播,mic:连麦 , 默认:live
page false int 第几页
pageSize false int 每页大小
startDay false string 开始时间,格式:YYYY-MM-DD
endDay false string 结束时间,格式:YYYY-MM-DD
channelId false int 频道号

返回正确结果JSON示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 2,
        "pageNumber": 1,
        "totalItems": 123,
        "contents": [
            {
                "id": "xx",
                "total": 1,
                "channelId": 431596,
                "joinTime": "09:46:35",
                "leaveTime": "09:46:38",
                "resumeDate": "2020-03-25",
                "uid": "1585100782973",
                "productType": "云直播",
                "desc": "回放",
                "nick": "肇庆观众/87907"
            },
            {
                "id": "xxx",
                "total": 2,
                "channelId": 902256,
                "joinTime": "15:09:06",
                "leaveTime": "15:10:39",
                "resumeDate": "2020-03-24",
                "uid": "60806543b2",
                "productType": "云直播",
                "desc": "直播",
                "nick": "huahua li"
            }
        ],
        "startRow": 1,
        "firstPage": true,
        "lastPage": false,
        "nextPageNumber": 2,
        "prePageNumber": 1,
        "limit": 2,
        "totalPages": 62,
        "endRow": 2,
        "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": "invalid bill type",
    "data": ""
}

字段说明

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

数据对象字段说明

Paginator<BillDetailModel>

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

字段 类型及范围 说明
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<BillDetailModel> 账单列表
BillDetailModel

说明:抽奖记录

字段 类型及范围 说明
id string 字符串,连麦和云直播有不同,连麦自曾,云直播可能为空
total int 总消费时长,单位分钟
channelId string 频道号
joinTime int 加入时间
leaveTime string 离开时间
resumeDate string 消费时间
productType string 产品项
uid string 使用者Id
desc string 明细
nick long 昵称

PHP请求示例

<?php

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

$type = "mic";
$params = array(
        'appId'=>$appId,
        'type'=>$type,
        'timestamp'=>$timestamp
    );

//生成sign
$sign = getSign($params); //详细查看config.php文件
$params['sign'] = $sign;
$url="http://api.polyv.net/live/v3/finance/bill/list-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...