获取历史聊天信息

接口URL

http://api.polyv.net/live/v2/chat/{channelId}/getHistory

接口说明

1、作用:查询一段时间内的聊天记录,时间格式为yyyy-MM-dd 或 yyyy-MM-dd HH:mm:ss。
如未提交具体时间,只提交了日期,开始时间默认为日期当天的 00:00:00,结束时间为日期当天的23:59:59
2、接口支持https协议
3、接口URL中的{channelId}为 频道ID

支持格式

JSON

请求方式

GET,POST

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
startDay String 聊天记录的开始时间,格式要求为yyyy-MM-dd(如:2017-08-01)或者 yyyy-MM-dd HH:mm:ss (如:2017-08-01 16:30:12)
endDay string 聊天记录的结束时间,要求同上
appId string 从API设置中获取,在直播系统登记的appId
page int 获取第几页聊天记录,默认为1
limit int 每页记录数,默认为1000
timestamp string 当前13位毫秒级时间戳,3分钟内有效
sign string 签名,32位大写MD5值

响应成功JSON示例:

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "clientIP": "",
            "content": "你好,这是测试聊天",
            "id": "b14a05a0-88a1-11e7-9b6c-b5f4f2197652",
            "image": "",
            "roomId": "108888",
            "time": 1503561370362,
            "user": {
                "clientIp": "",
                "nick": "测试",
                "pic": "//livestatic.videocc.net/v_69/assets/wimages/missing_face.png",
                "roomId": "108888",
                "uid": "diRdMsz0VZ6rivf6ARIt",
                "userId": "1503561347640",
                "userType": "student"
            }
        },
        {
            "clientIP": "",
            "content": "欢迎使用保利威视!",
            "id": "bf9c8e70-88a1-11e7-9b6c-b5f4f2197652",
            "image": "",
            "roomId": "108888",
            "time": 1503561394391,
            "user": {
                "clientIp": "",
                "nick": "测试",
                "pic": "//livestatic.videocc.net/v_69/assets/wimages/missing_face.png",
                "roomId": "108888",
                "uid": "diRdMsz0VZ6rivf6ARIt",
                "userId": "1503561347640",
                "userType": "student"
            }
        }
    ]
}

响应失败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": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

频道号错误

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

开始时间为空

{
    "code": 400,
    "status": "error",
    "message": "startDay can not be empty.",
    "data": ""
}

结束时间为空

{
    "code": 400,
    "status": "error",
    "message": "endDay can not be empty.",
    "data": ""
}

开始时间格式不正确 (正确格式为yyyy-MM-dd)

{
    "code": 400,
    "status": "error",
    "message": "the startDay is no right.",
    "data": ""
}

开始时间格式不正确 (正确格式为yyyy-MM-dd)

{
    "code": 400,
    "status": "error",
    "message": "the endDay is no right.",
    "data": ""
}

结束时间晚于开始时间

{
    "code": 400,
    "status": "error",
    "message": "the endDay can not be earlier than the startDay.",
    "data": ""
}

其他错误

{
    "code": 400,
    "status": "error",
    "message": "无法访问聊天室数据",
    "data": ""
}

字段说明

参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
clientIP 用户IP
content 聊天内容
id 聊天消息id
image 图片消息的图片地址
roomId 频道号
time 发送消息时的时间戳
clientIp 用户IP
nick 观众昵称
pic 观众头像
roomId 频道号
uid socket分配的id
userId 用户唯一标示
userType 用户类型,目前有teacher(老师)、assistant(助教)、manager(管理员)、slice(云课堂学员)

php请求示例

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

//接口需要的参数(非sign)赋值
$channelId = "127075";
$startDay = "2017-08-24";
$endDay = "2018-08-24";

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

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

//接口请求url
$url = "http://api.live.polyv.net/v2/chat/$channelId/getHistory?appId=$appId&timestamp=$timestamp&sign=$sign&startDay=$startDay&endDay=$endDay";

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

?>

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

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

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