你的位置：首页 / 云直播 / 聊天室

查询频道禁言列表

由发表

接口URL

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

接口说明

获取禁言列表

返回结果支持格式

JSON

请求方式

GET

请求参数

参数名 必选 类型及范围 说明
sign true string 签名
appId true string 开发者账号下的appId
timestamp true string 13位当前时间的时间戳
channelId true int32 频道号
type true string 禁言类型,ip/userId
toGetSubRooms false int 是否获取子频道，0：不获取，1：获取

返回错误结果JSON示例

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

返回正确结果JSON示例

1、type为userId时，返回禁言用户userId
{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        "1574927917080"
    ]
}
2、type为ip时，返回禁言列表ip
{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        "59.41.162.172"
    ]
}

字段说明

字段 类型及范围 说明
code int32 返回码
status string 返回状态
message string 返回信息
data string[] 操作结果:ip数组或userId数组

PHP请求示例

<?php

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

//接口需要的参数（非sign）赋值
$appId = "XXXXXXXX";
$channelId = "127075";
$timestamp = "123123123123";
$type = "ip";
$params = array(
        'appId'=>$appId,
        'channelId'=>$channelId,
        'timestamp'=>$timestamp,
        'type'=>$type
    );

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

$url = "https://api.polyv.net/live/v3/channel/chat/get-banned-list?appId=$appId&channelId=$channelId&type=$type&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/chat/list-kicked

接口说明

获取踢人列表

返回结果支持格式

JSON

请求方式

POST

请求参数

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

返回错误结果JSON示例

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

返回正确结果JSON示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "banned": false,
            "channelId": "358106",
            "clientIp": "59.41.162.172",
            "kickRefer": "userId",
            "nick": "45",
            "pic": "//livestatic.videocc.net/v_462/assets/wimages/missing_face.png",
            "roomId": "358106",
            "uid": "ozoWBbESU33dIYO7AABH",
            "userId": "1574927917080",
            "userType": "slice"
        }
    ]
}

字段说明

字段 类型及范围 说明
code int32 返回码
status string 返回状态
message string 返回信息
data object 操作结果
banned boolean 是否禁言
channelId int32 频道号
clientIp string 用户ip
kickRefer string 踢人方式：userId, ip
nick string 昵称
pic string 头像图片地址
roomId int32 房间号
uid string 聊天室socketid
userId string 用户userId
userType string 用户身份：管理员 manager，讲师 teacher， 助教 assistant， 嘉宾 guest，参与者 viewer，观看者 slice/student

PHP请求示例

<?php

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

//接口需要的参数（非sign）赋值
$appId = "XXXXXXXX";
$channelId = "127075";
$timestamp = "123123123123";
$params = array(
        'appId'=>$appId,
        'channelId'=>$channelId,
        'timestamp'=>$timestamp
    );

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

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

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

查询频道严禁词/禁言IP列表

由发表

点击这里查看旧版

接口URL

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

接口说明

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

请求方式

GET

请求参数

参数名 必选 类型 说明
appId 是 string 从API设置中获取，在直播系统登记的appId
timestamp 是 long 当前13位毫秒级时间戳，3分钟内有效
sign 是 string 签名，为32位大写的MD5值
channelId 是 int 频道ID
type 否 string 查询类型： ip 禁言ip，badword 严禁词，不传默认为badword

响应成功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方法

//加上sign参数一起提交post
$data = array(
    'appId'=>$appId,
    'timestamp'=>$timestamp,
    'sign'=>$sign,
    'nickname'=>$nickname,
    'actor'=>$actor,
    'passwd'=>$passwd,
    'channelId'=>$channelId
);
print_r($data);
$uri = "http://api.polyv.net/live/v3/channel/account/updateTeacher";
$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $uri);
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...

通过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。

起步

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

http://dev.polyv.net/2019/liveproduct/l-api/zbglgn/pdcz/get-chat-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,
    version: '2.0',
    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，三分屏场景下学员需设置为slice
accountId String 否 直播账号userId，用于开启全局严禁词
token String 是 校验码
mediaChannelKey String 是 连麦相关参数
version String 是 版本号，默认为2.0
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: ""
    }

DEMO下载

demo

以上内容是否对您有帮助？根本没有帮助文档较差文档一般文档不错文档很好
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...