獲取頻道聊天審核內容

更新時間：2022-09-02 18:08:07

介面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值,`生成簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在客戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器獲取回應資料`【詳見簽名生成規則】
channelId	是	int	頻道號
apiVersion	否	string	介面版本，當apiVersion為3.1時，以下參數才有效
order	否	string	排序,ASC順序、DESC倒序，預設ASC
page	否	int	分頁頁碼、預設1
pageSize	否	int	分頁大小，預設10

操作成功回應範例

{
  "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':雲課堂學生）
data.pageSize	int	分頁大小，當參數apiVersion為3.1時返回
data.pageNumber	int	當前頁碼，當參數apiVersion為3.1時返回
data.totalPages	int	總頁數，當參數apiVersion為3.1時返回

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>";
?>