查詢歷史聊天資訊

介面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

請求參數

響應成功JSON範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "accountId": "ee7fe7fbda",
            "clientIP": "",
            "content": "123",
            "event": "",
            "id": "9b7b0d20-12b7-11eb-8860-43fdec7e6710",
            "image": "",
            "msgType": "",
            "quote": "",
            "roomId": "157468202",
            "sessionId": "",
            "time": 1603186536120,
            "user": {
                "actor": "管理员",
                "banned": false,
                "channelId": "1574682",
                "clientIp": "",
                "nick": "管理员",
                "pic": "//s1.videocc.net/face.png",
                "roomId": "157468201",
                "sessionId": "fnnjgog6vi",
                "uid": "46a6KWLWMdxQwBShAAAC",
                "userId": "ee7fe7fbda",
                "userType": "manager"
            },
            "userType": "manager",
            "status": "pass",
            "sourceType": "public"
        },
        {
            "accountId": "ee7fe7fbda",
            "clientIP": "",
            "content": "3231",
            "event": "",
            "id": "9ee931d0-12b7-11eb-b668-b35576b339fa",
            "image": "",
            "msgType": "",
            "quote": "",
            "roomId": "157468202",
            "sessionId": "",
            "time": 1603186541876,
            "user": {
                "actor": "管理员",
                "banned": false,
                "channelId": "1574682",
                "clientIp": "",
                "nick": "管理员",
                "pic": "//s1.videocc.net/face.png",
                "roomId": "157468202",
                "sessionId": "fnnjgog6vi",
                "uid": "VQUMlI2l7wcHjiJaAAAC",
                "userId": "ee7fe7fbda",
                "userType": "manager"
            },
            "userType": "manager",
            "status": "pass",
            "sourceType": "public"
        }
    ]
}

響應失敗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": ""
}

欄位說明

content類型說明

content欄位類型受msgType欄位影響，如果msgType為空，則表示普通發言，content為字串類型。如果msgType為其它類型，則content為物件。

msyType為redpaper

表示紅包，content物件為

msyType為chatImg

發送圖片，content物件為

msyType為custom

發送自訂訊息，content物件為