查询频道严禁词列表

接口URL

http://api.polyv.net/live/v3/channel/badword/list

接口说明

1、接口用于获取频道的严禁词列表
2、接口支持https

支持格式

JSON

请求方式

GET

请求参数

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

响应成功JSON示例:

{
  "code": 200, 
  "status": "success", 
  "message": "", 
  "data": [
    "2222", 
    "5555", 
    "yyyy", 
    "7777"
  ]
}

响应失败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
status 成功为success,失败为error
message 错误时为错误提示消息
data 成功响应时为严禁词数组

php请求示例

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

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

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

$url = "http://api.polyv.net/live/v3/user/badword/list?".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, 0);
$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/account/updateTeacher

接口说明

1、作用:修改频道的讲师相关信息
2、接口支持https协议

支持格式

JSON

请求方式

POST

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
channelId string 频道ID
nickname string 讲师昵称
actor string 讲师头衔
passwd string 频道密码
avatar string 头像图片地址
如果为空,则使用默认头像
sign string 签名,为32位大写的MD5值

响应成功JSON示例:

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

响应异常JSON示例:

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

字段说明

参数名 类型 说明
code int http code值
status string 状态值
message string 提示的信息
data string 相应的结果

php请求示例

<?php
//接口需要的参数(非sign)赋值
$channelId = "127075";
$nickname = "王老师";
$actor = "这是头衔";
$passwd = "qwsa21";

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

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

$url = "http://api.polyv.net/live/v3/channel/account/updateTeacher?appId=$appId&timestamp=$timestamp&sign=$sign&nickname=$nickname&actor=$actor&passwd=$passwd";

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
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...

通过HTTP接口在聊天室发送消息

接口URL

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

接口说明

可指定发言者的头像、头衔、昵称,无需连接聊天室,通过HTTP接口发送聊天文本内容

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前时间的秒级时间戳(13位)
sign string 签名,为32位大写的MD5值
channelId int 频道号
adminIndex int 管理员索引,可以指定多个管理员发送消息,默认只有一个管理员
msg string 发送的文本消息
pic string 管理员头像
nickName string 昵称,最大为8个长度,超出会被截断
actor string 头衔,最大为4个长度,超出会被截断,不传参数则表示无头衔
freeReview string 当频道开启审核后消息是否需要经过审核,Y表示不需要,N表示需要,默认为N

操作成功响应示例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": "发送成功"
}

操作失败响应示例

签名错误

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

缺少参数 channelId

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

响应字段说明

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

php请求示例

<?php
//引用config.php
include 'config.php';
$channelId = '123456';
$pic = 'http://xxxx.jpg';
$nickName = 'tom';
$msg = 'test';
$actor = 'admin';
$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'channelId' => $channelId,
  'msg' => $msg,
  'pic' => $pic,
  'nickName' => $nickName,
  'actor' => $actor
);

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$url="http://api.polyv.net/live/v3/channel/chat/send-admin-msg?appId=$appId&timestamp=$timestamp&channelId=$channelId&sign=$sign&msg=$msg&pic=$pic&nickName=$nickName&actor=$actor";

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

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

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

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

查询账号严禁词列表

接口URL

https://api.polyv.net/live/v3/user/badword/list

接口说明

1、接口用于获取账号下通用设置的严禁词列表
2、接口支持https

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

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

响应成功JSON示例:

{
  "code": 200, 
  "status": "success", 
  "message": "", 
  "data": [
    "2222", 
    "5555", 
    "yyyy", 
    "7777"
  ]
}

响应失败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
status 成功为success,失败为error
message 错误时为错误提示消息
data 成功响应时为严禁词数组

php请求示例

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

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

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

$url = "http://api.polyv.net/live/v3/user/badword/list?".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, 0);
$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/user/badword/delete

接口说明

1、接口用于删除账号通用设置的严禁词,支持批量
2、接口支持https

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp long 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
words string 要删除的严禁词,多个以英文逗号,分隔

响应成功JSON示例:

{
  "code": 200, 
  "status": "success", 
  "message": "", 
  "data": [
    "2222", 
    "5555", 
    "yyyy", 
    "7777"
  ]
}

响应失败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 should not be empty: words", 
  "data": ""
}

字段说明

参数名 说明
code 响应代码,成功为200,失败为400,签名错误为401,异常错误500
status 成功为success,失败为error
message 错误时为错误提示消息
data 成功响应时为删除后剩下的严禁词数组

php请求示例

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

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

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

$url = "http://api.polyv.net/live/v3/user/badword/delete?".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, 0);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>

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

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

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

直播聊天室JS-SDK

介绍

为方便开发者快速接入页面聊天室功能,保利威提供了带有默认样式的聊天室的JS-SDK。如需使用聊天室其他功能和事件,请参考聊天室API

DEMO

demo

起步

1、html代码

<div id="wrap"></div>

2、引入css

<link rel="stylesheet" href="https://player.polyv.net/jssdk/polyv-chatroom.min.css">

3、引入js

<script src="https://player.polyv.net/jssdk/polyv-chatroom.min.js"></script>

4、请求token

需要先请求以下接口获取token和mediaChannelKey,传给js-sdk

https://api.polyv.net/live/watchtoken/gettoken?ts=xxxx&sign=xxx
ts: 时间戳
sign: md5校验码
注:sign生成规则:md5(ts+"polyvsign")

https://api.polyv.net/live/v3/channel/common/get-token

5、新建对象

var chatroom = new PolyvChatRoom({
    roomId: '268682',
    userId: '153075602311',
    nick: '游客',
    pic: 'http://livestatic.videocc.net/assets/wimages/missing_face.png',
    token: token,
    mediaChannelKey: mediaChannelKey,
    container: '#wrap',
    width: 300,
    height: 600,
    userType: '',
    roomMessage: function(data) {
        // TODO
        // data为聊天室socket消息,当有聊天室消息时会触发此方法
        console.log(data);
    }
});

相关参数说明

名称 类型 是否必须 说明
roomId String 频道号
userId String 用户唯一id
pic String 用户头像
nick String 用户昵称,默认为‘游客’
userType String 用户类型,普通学员:student,云课堂学员:slice,讲师:teacher,管理员:manager,助教:assistant,嘉宾:guest,默认为student
accountId String 直播账号userId,用于开启全局严禁词
token String 校验码
mediaChannelKey String 连麦相关参数
roomMessage Function 聊天室消息回调函数
container String DOM选择器,HTML元素,用于嵌入默认聊天室样式

注:以下参数只有在传了container参数时才生效

名称 类型 是否必须 说明
width Number container宽度,默认300px
height Number container高度,默认600px
showUserList Boolean 是否显示在线列表。PC端默认开启,移动端默认关闭。当关闭时,tabData若含有在线列表对象也不显示
enableSetNickname Boolean 是否开启设置昵称功能,默认为false
enableWelcome Boolean 是否开启欢迎语,默认为true
enableFlower Boolean 是否开启送花功能,默认为true
enableLike Boolean 是否开启点赞,默认为true
enableOnlyTeacher Boolean 是否开启只看讲师功能,默认为true
enableBulletin Boolean 是否开启公告,默认为true
enableAsk Boolean 是否开启提问,默认为true
tabData Array 自定义菜单栏
customChatColor Object 自定义消息颜色(新增)
apiPrefix Object 自定义域名(新增)

自定义菜单栏

tabData: 对象数组,每个对象包含两个属性name,type,默认包含聊天tab

name: 菜单栏名称

type: 菜单栏类型,若不是已有内置类型,会嵌入一个不包含任何内容的div元素到页面

已有内置类型

type 说明
chat 互动聊天
user-list 在线列表
ask 提问

自定义消息颜色

说明:修改消息字体/背景颜色,可针对自己/普通用户/管理员/讲师/助教/嘉宾修改

名称 类型 是否必须 说明
selfBgColor String 自己消息背景颜色,默认为 #8bc34a
selfColor String 自己消息颜色,默认为 #fff
otherBgColor String 普通用户消息背景颜色,默认为 #fff
otherColor String 普通用户消息颜色,默认为 #546e7a
specialBgColor String 特殊用户消息背景颜色,可以统一设置管理员/讲师/助教/嘉宾的背景颜色,默认为 #fff
specialColor String 特殊用户消息颜色,可以统一设置管理员/讲师/助教/嘉宾的消息颜色,默认为 #2196f3
managerBgColor String 管理员消息背景颜色
managerColor String 管理员消息颜色
teacherBgColor String 讲师消息背景颜色
teacherColor String 讲师消息颜色
assistantBgColor String 助教消息背景颜色
assistantColor String 助教消息颜色
guestBgColor String 嘉宾消息背景颜色
guestColor String 嘉宾消息颜色

自定义域名

名称 类型 是否必须 说明
socketHost String 聊天室域名,默认为chat.polyv.net
chatApi String 聊天室接口域名,默认为apichat.polyv.net

其他

获取chat对象

var chat = chatroom.chat;

获取socket对象

var socket = chat.socket;

发送聊天消息

chat.send('hello');

获取聊天历史记录

chat.getHistoryMessage(start, end)
.then(function (data) {
    // TODO
    console.log(data);
});

说明

名称 是否必须 说明
start 开始下标,默认为0
end 结束下标,默认为10

获取在线列表

chat.getUserList(page, len)
.then(function (data) {
    // TODO
    console.log(data);
});

说明

名称 是否必须 说明
page 页码,默认为1
len 条数,默认为100

sendMessage

说明:自己发言会触发此消息,会在roomMessage返回,也可以通过chat对象监听
例如:

    chat.on(events.SEND_MESSAGE, (event, data) => {
        // TODO
    });

返回数据:

    EVENT: "sendMessage"
    content: "自己发言"
    currentUser: true
    custom: false
    formatTime: "2019-04-25 18:06"
    imgchat: false
    mySelfSend: true
    reward: false
    time: 1556186781080
    user: {
        nick: "polyv",
        pic: "http://livestatic.videocc.net/assets/wimages/missing_face.png",
        userId: "1530756023116",
        roomId: "",
        channelId: ""
    }
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...

频道发送管理员聊天信息

接口URL

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

接口说明

1、接口用于发送聊天消息
2、接口支持https

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
channelId int 频道ID
content String 聊天信息内容
role String 发送人角色(目前为只提供管理员角色,值为"ADMIN")

响应成功JSON示例:

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": "The message send 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": "param should not be empty: channelId",
    "data": ""
}
{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: content",
    "data": ""
}
{
    "code": 400,
    "status": "error",
    "message": "param should not be empty: role",
    "data": ""
}

角色类型错误

{
    "code": 400,
    "status": "error",
    "message": "illegal chat role",
    "data": ""
}

请求出错了

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": "The network is error, please try again!"
}

字段说明

参数名 说明
code 请求结果代码,成功为200 错误为400,签名错误为403,接口错误为500
status 请求结果,成功时为"success"错误时为"error"
message 错误信息,请求成功时为空串,错误时错误信息
data 请求成功为数据内容,错误为空串

php请求示例

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

$channelId="183950";
$content="test";
$role='ADMIN';

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

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

$url = "http://api.polyv.net/live/v3/channel/chat/send?appId=".$appId."&channelId=".$channelId."&content=".$content."&role=".$role."&timestamp=".$timestamp."&sign=".$sign;

$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
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/v2/chat/{channelId}/getQuestion

接口说明

1、接口用于获取咨询提问记录
2、接口URL中的{channelId}为 频道ID
3、接口支持https

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值
begin int 起始下标,从0开始
end int 结束下标,-1表示不分页

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [{
        "id": "ee83ea70-43be-11e8-ad5a-cf5b830e2a70",
        "user": {
            "nick": "小明",
            "pic": "//livestatic.videocc.net/v_109/assets/wimages/missing_face.png",
            "userId": "1524134770059",
            "userType": "student"
        },
        "s_userId": null,
        "event": "S_QUESTION",
        "content": "十万个为什么",
        "time": 1524134795927
    }, {
        "id": "be852840-ddef-11e8-8732-3d35cdd2dfa4",
        "user": {
            "nick": "讲师",
            "pic": "//livestatic.videocc.net/uploaded/images/webapp/avatar/default-teacher.png",
            "userId": "d217e5a2e2bf37aee61f42cf2059ebc6",
            "userType": "teacher"
        },
        "content": "是吗",
        "time": 1541088239812,
        "s_userId": "1541086126963",
        "event": "T_ANSWER"
    }]
}

响应失败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": 500, 
    "status": "fail", 
    "message": "api error.", 
    "data": ""
}

字段说明

参数名 说明
code 请求结果代码,成功为200 错误为400,签名错误为403,接口错误为500
status 请求结果,成功时为"success"错误时为"error"
message 错误信息,请求成功时为空串,错误时错误信息
data 请求成功为数据内容,错误为空串
id 信息id
content 内容
time 时间,13位时间戳
nick 发言人昵称
userId 发言人ID
userType 发言人类型值
event 消息类型,讲师回答:T_ANSWER,学生提问:S_QUESTION
s_userId 提问者ID

php请求示例

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

$channelId="183950";

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

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

$url = "http://api.polyv.net/live/v2/chat/".$channelId."/getQuestion?appId=".$appId."&timestamp=".$timestamp."&sign=".$sign;


$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/v2/channels/{channelId}/get-question-result

接口说明

1、获取频道的问答统计结果
2、接口支持https协议

支持格式

JSON

请求方式

GET,POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,为32位大写的MD5值
startTime string 开始时间,格式:yyyy-MM-dd HH:mm:ss
endTime string 结束时间,格式:yyyy-MM-dd HH:mm:ss

响应成功JSON示例:

{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"questionId": "1c6dc3c666",
"channelId": 10001,
"type": "radio",
"startTime": "2018-03-26 10:30:45.0",
"option1": 100,
"option2": 200,
"option3": 4000,
"option4": 3999,
"option5": null,
"endTime": "2018-03-26 10:47:06.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 请求状态响应码
status 请求状态
message 错误信息
data 用户的分钟数相关信息
questionId 题目ID,字符串
channelId 频道ID,整型
type 问答类型,radio为单选,judge为判断题
startTIme 开始时间,格式:yyyy-MM-dd HH:mm:ss
endTIme 结束时间,格式:yyyy-MM-dd HH:mm:ss
option1 第一个选择项的答题人数,如果是判断题就是正确选择项的答题人数
option2 第二个选择项的答题人数,如果是判断题就是错误选择项的答题人数
option3 第三个选择项的答题人数
option4 第四个选择项的答题人数
option5 第五个选择项的答题人数

php请求示例

<?php

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


/接口需要的参数(非sign)赋值
$params = array(
    'appId'=>$appId,
    'startTime'=>$startTime,    
    'endTime'=>$endTime,    
    'timestamp'=>$timestamp
  );

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

//接口请求url
$url = "http://api.live.polyv.net/v2/channels/$channelId/get-question-result?appId=".$appId."&timestamp=".$timestamp."&sign=".$sign."&startTime=".$startTime."&endTime".$endTime;
//输出接口请求结果
echo file_get_contents($url);

?>

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

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

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

设置聊天室管理员信息

接口URL

http://api.polyv.net/live/v2/channelSetting/{channelId}/set-chat-admin

接口说明

1、设置聊天室管理员信息,提交参数都不能为空。
2、头像要求:只能为jpg、jpeg、png三种格式,大小不能超过2Mb。
3、接口支持https协议
4、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
nickname string 管理员昵称,长度不能超过8
actor string 管理员头衔,长度不能超过4
avatar MultipartFile 管理员头像,支持jpg、jpeg、png三种格式,大小不能超过2Mb
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值

响应成功JSON示例:

设置引导页,未上传图片

{
    code: 200,
    status: "success",
    message: "",
    data: "修改成功"
}

响应失败JSON示例:

未输入appId

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

appId不正确

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

时间戳错误

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

频道号错误

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

签名错误

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

没有输入nickname

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

nickname长度不合法

{
    "code": 400,
    "status": "error",
    "message": "昵称长度不能大于 8.",
    "data": ""
}

图片大于2Mb

{
    "code": 400,
    "status": "error",
    "message": "image oversize error.",
    "data": ""
}

图片格式错误

{
    "code": 400,
    "status": "error",
    "message": "image format error.",
    "data": ""
}

其他错误

{
    "code": 400,
    "status": "error",
    "message": "修改失败",
    "data": ""
}

字段说明

参数名 说明
code 请求结果代码,成功为200 错误为400
status 请求结果,成功时为"success"错误时为"error"
message 错误信息,请求成功时为空,错误时错误信息
data 成功请求时为"success",如果上传图片则为图片url

php请求示例

<?php

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

//接口需要的参数(非sign)赋值
$channelId = "137720";
$nickname = "管理员昵称";
$actor = "这是头衔";
$avatar = 'C:\Users\polyv\Desktop\avatar_test.png';

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

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

$data = array(
    'appId' => $appId,
    'timestamp' => $timestamp,
    'nickname' => $nickname,
    'actor' => $actor,
    'sign' => $sign,
    'avatar' => new CURLFile(realpath($avatar))
);
$url = "http://api.polyv.net/live/v2/channelSetting/$channelId/set-chat-admin";
$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt( $ch, CURLOPT_POSTFIELDS, $data);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$reponse = curl_exec ( $ch );
curl_close ( $ch );
print_r($reponse);

?>

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

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

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