异步裁剪直播录制文件

接口URL

https://api.polyv.net/live/v3/channel/record/clip

接口说明

1、接口用于裁剪直播录制视频文件
2、该接口为文件裁剪过程为异步处理过程
3、接口支持https
4、该接口裁剪视频的最小粒度仅支持到单位为秒(s)的裁剪

请求方式

POST

请求参数

参数名 必选 类型 说明
appId string 管理员的appId
timestamp long 13位当前时间戳
sign string 签名值
channelId string 频道ID
fileId string 文件ID
reserveTimeFrame string 裁剪后要保留的时间区间
误差说明:
(1)裁剪区间存在一定的时间误差;
(2)误差原因:由于m3u8的视频裁剪是精确到每片ts, 所以裁剪时会判断裁剪要移除的时间区间所包含的ts片,进行裁剪移除;
格式要求:
(1)start、end值是单位为秒的数值,格式为:[{"start":xx, "end":xx},{"start":xx, "end":xx}];
(2)多个区间请按照时间顺序从小到大排列;
(3)时间区间不允许重叠;
(4)时间区间不得超过100个限制;
【示例:裁剪后要保留的是第1s到第14s, 以及第25s到第30s的区间,则传入的字符串为 [{"start":1, "end":14},{"start":25, "end":30}] 】
callbackUrl string 裁剪成功或失败回调的url(回调详细请查看文档最后 " 回调说明 " 一栏)
autoConvert string 是否自动转存回放(Y:是,N:否)不传默认为N
fileName string 裁剪后文件名

响应成功JSON示例:

// 提交的视频正在裁剪处理中
{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "submit success."
}

响应失败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": "record file not exist",
    "data": ""
}
// 要裁剪的文件无m3u8地址
{
    "code": 400,
    "status": "error",
    "message": "record file m3u8 not exist",
    "data": ""
}
// 要裁剪的文件无m3u8地址
{
    "code": 400,
    "status": "error",
    "message": "record file m3u8 not exist",
    "data": ""
}
// 要裁剪的文件无mp4地址
{
    "code": 400,
    "status": "error",
    "message": "record file mp4 not exist",
    "data": ""
}
// 要裁剪的时间区间存在问题
{
    "code": 400,
    "status": "error",
    "message": "record file clip timeFrame error",
    "data": ""
}
// 要裁剪的时间区间超过100个限制
{
    "code": 400,
    "status": "error",
    "message": "clip time frame over 100 limit",
    "data": ""
}

字段说明

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

php请求示例

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

$params = array(
  'appId' => "填写获取到的appId",
  'timestamp' => "填写13位时间戳",
  'channelId' => "填写频道号",
  'fileId' => "填写录制文件ID",
  'reserveTimeFrame' => "[{\"start\":0, \"end\":14},{\"start\":25, \"end\":34}]",
  'fileName' => "裁剪测试",
  'callbackUrl'=> "http://demo.polyv.net/wfy/test.php"
);

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


$url="https://api.polyv.net/live/v3/channel/record/clip";

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);
   $file_contents = curl_exec($ch);
   curl_close($ch);
   return $file_contents;
}

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

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

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

回调说明

该接口为异步处理,如果需要获取合并的结果,可以在请求接口时提交callbackUrl 参数,在程序合并成功后,会对callbackUrl 进行回调通知

回调参数

参数 说明
status 接口处理结果,取值:success(成功),error(出错)
channelId 频道号,成功时返回
fileId 裁剪后的文件ID,成功时返回
clippedFileId 裁剪前的文件ID,成功时返回
fileUrl 合并后的MP4的地址,成功时返回
timestamp 回调的当前时间戳
sign 接口安全校验串,加密规则:用户的AppSecret(应用密匙)+timestamp 得到的字符串进行md5加密
actualTimeFrame 真实裁剪的时间区间(经过urlencode的字符串,decode后的字符串格式为:[{"start":xx, "end":xx},{"start":xx, "end":xx}])
fileName 文件名(经过urlencode的字符串)
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

获取答题卡单道题目的答题汇总

接口URL

http://api.polyv.net/live/v3/channel/question/detail

接口说明

1、接口用于获取答题卡单道题目的答题汇总
2、接口支持https

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId string 频道号
questionId string 题目ID,从题目列表中获取
times int 第几次的答题详情,用于同一道题发送了多次的情况,从题目列表中获取

响应成功JSON示例:

// 成功
{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "question": [
            {
                "count": 155,
                "tips": "",
                "option": "7"
            },
            {
                "count": 88,
                "tips": "",
                "option": "8"
            },
            {
                "count": 24,
                "tips": "",
                "option": "9"
            },
            {
                "count": 135,
                "tips": "",
                "option": "10"
            }
        ],
        "total": 402,
        "answer": "",
        "correctRecord": 0,
        "title": "请您为选手打分",
        "type": "S",
        "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": ""
}

字段说明

参数名 说明
code 响应的状态码,例如:200
status 响应状态
message 异常错误信息
data 响应结果集
data.question 问题的各选项统计列表
data.question[0].option 问题的选项
data.question[0].count 问题选项的选择数量
data.question[0].count 问题选项的提示
data.total 回答问题的总数量
data.correctRecord 正确回答问题的总数量
data.answer 问题的答案
data.title 问题内容
data..type 题目类型("R":单选,"C":多选,"S": 评分, "Q": 问答, "V": 投票)
data.itemType 答题卡为0,问答为1

php请求示例

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

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

$url = "http://api.polyv.net/live/v3/channel/question/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/question/answer-record/list-by-page

接口说明

1、接口用于分页获取某次答题的答题观众列表
2、接口支持https

请求方式

GET

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
channelId string 频道号
questionId string 题目ID,从题目列表中获取
times int 第几次的答题详情,用于同一道题发送了多次的情况,从题目列表中获取
page int 页号,默认为1
pageSize int 每页条数,默认为20

响应成功JSON示例:

// 成功
{
  "code": 200,
  "status": "success",
  "message": null,
  "data": {
    "endRow": 2,
    "contents": [
      {
        "questionId": "text",
        "costTime": 60,
        "viewerId": "",
        "submitTime": 6,
        "nickname": "",
        "submitTimeFormat": "text",
        "channelId": 3,
        "times": 1,
        "answer": "",
        "sessionId": "text",
        "costTimeFormat": "",
        "viewerAnswer": "",
        "type": "",
        "correct": "N",
        "name": ""
      }
    "firstPage": false,
    "lastPage": true,
    "limit": 0,
    "nextPageNumber": 0,
    "offset": 7,
    "pageNumber": 1,
    "pageSize": 0,
    "prePageNumber": 7,
    "startRow": 4,
    "totalItems": 0,
    "totalPages": 9,
    "nulla5af": 58983375
  }
}

响应失败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 响应结果集
data.pageNumber 页数
data.limit 每页记录数
data.totalItems 记录总数
data.firstPage 是否为第一页,值为:true/false
data.lastPage 是否为最后一页,值为:true/false
data.nextPageNumber 下一页编号
data.prePageNumber 上一页编号
data.totalPages 总页数
data.startRow 当前页第一条记录所在列表中的位置
data.endRow 当前页最后一条记录所在列表中的位置
data.contents[0].viewerId 观众Id
data.contents[0].nickname 观众昵称
data.contents[0].type 题目类型("R":单选,"C":多选,"S": 评分, "Q": 问答, "V": 投票)
data.contents[0].channelId 频道ID
data.contents[0].questionId 问题ID
data.contents[0].name 问题
data.contents[0].answer 问题答案
data.contents[0].correct 是否正确,Y 正常,N 不正确
data.contents[0].viewerAnswer 观众ID
data.contents[0].sessionId 直播场次Id
data.contents[0].times 同一道题发送多次,区分不同次数的
data.contents[0].submitTime 答题时间,时间戳
data.contents[0].submitTimeFormat 格式化的答题时间,格式为:yyyy/MM/dd HH:mm:ss
data.contents[0].costTime 答题耗时,单位秒
data.contents[0].costTimeFormat 格式化的答题耗时

php请求示例

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

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

$url = "https://api.polyv.net/live/v3/channel/question/answer-record/list-by-page?".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/question/list-interact-record

接口说明

1、接口用于获取每场直播的答题卡发送记录列表
2、接口支持https

请求方式

GET

请求参数

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

响应成功JSON示例:

// 成功
{
  "code": 200,
  "status": "success",
  "message": null,
  "data": {
    "endRow": 8,
    "contents": [
      {
        "status": 11,
        "questionId": "asdfg12311",
        "sessionId": "zxcvbasdfg",
        "name": "今天天气怎么样",
        "createdTime": 1589007127629,
        "type": "R",
        "channelId": 100000,
        "userId": "poiu12wsde,
        "times": 1
      }
    ],
    "firstPage": true,
    "lastPage": false,
    "limit": 10,
    "nextPageNumber": 8,
    "offset": 10,
    "pageNumber": 10,
    "pageSize": 9,
    "prePageNumber": 10,
    "startRow": 5,
    "totalItems": 8,
    "totalPages": 3,
    "occaecate": 62485716
  }
}

响应失败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 响应结果集
data.pageNumber 页数
data.limit 每页记录数
data.totalItems 记录总数
data.firstPage 是否为第一页,值为:true/false
data.lastPage 是否为最后一页,值为:true/false
data.nextPageNumber 下一页编号
data.prePageNumber 上一页编号
data.totalPages 总页数
data.startRow 当前页第一条记录所在列表中的位置
data.endRow 当前页最后一条记录所在列表中的位置
data.contents[0].questionId 题目ID
data.contents[0].name 题目名称
data.contents[0].type 题目类型("R":单选,"C":多选,"S": 评分, "Q": 问答, "V": 投票)
data.contents[0].channelId 频道ID
data.contents[0].userId 用户ID
data.contents[0].sessionId 直播场次ID
data.contents[0].times 第几次发题
data.contents[0].status 发题状态(11 : 答题中, 12:结束答题,13:将答题结果发送给学员)
data.contents[0].createdTime 创建时间

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/question/list-interact-record?".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/chat/get-censor-content

接口说明

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": {
    "total": 1,
    "jsonList": [{
        "content": "2222",
        "id": "3e46f9b0-8f3c-11ea-ab59-cf9e43099504",
        "roomId": "421810",
        "status": "censor",
        "time": 1588729949374,
        "user": {
            "banned": false,
            "channelId": "421810",
            "clientIp": "61.144.147.235",
            "nick": "233",
            "pic": "https://s1.videocc.net/face.png",
            "roomId": "421810",
            "sessionId": "flrqsfma26",
            "uid": "pzQ-bhKFIA9BUU5DAKfE",
            "userId": "1588729887414",
            "userType": "slice"
        }
    }]
  }
}

操作失败响应示例

签名错误

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

响应字段说明

名称 类型 说明
code string 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data object 成功返回信息
data.total int 审核聊天数量
data.jsonList array 审核聊天内容列表
data.jsonList[0].content string 聊天消息内容
data.jsonList[0].id string 聊天消息ID
data.jsonList[0].roomId string 聊天房间号
data.jsonList[0].status string 聊天消息状态,"censor":待审核
data.jsonList[0].time string 聊天消息时间戳
data.jsonList[0].user object 聊天用户信息
data.jsonList[0].user.banned boolean 用户是否被封禁
data.jsonList[0].user.channelId string 频道号
data.jsonList[0].user.clientIp string 客户IP
data.jsonList[0].user.nick string 昵称
data.jsonList[0].user.pic string 头像
data.jsonList[0].user.uid string socketId
data.jsonList[0].user.roomId string 房间号
data.jsonList[0].user.sessionId string 场次ID
data.jsonList[0].user.userId string 用户ID
data.jsonList[0].user.userType string 消息发言人类型('monitor':监控者, 'assistant':助教, 'viewer':特邀观众, 'guest':嘉宾, 'teacher':讲师,、 'manager':管理员, 'slice':云课堂学生)

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-content?".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/pass-censor-content

接口说明

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

返回结果支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前时间的秒级时间戳(13位)
sign string 签名,为32位大写的MD5值
channelId int 频道号
passType string 通过类型,“all”: 全部通过, “time”:当前时间段通过, “id”:通过聊天审核内容ID通过
id string 聊天审核内容ID(当passType为“id”时必传)
time long 13位时间戳(当passType为“time”时必传),会通过所传时间戳之前的所有聊天审核内容消息

操作成功响应示例

{
  "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',
  'passType' => 'id',
  'id' => 'sdadada'
);

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

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