取得聊天審核開關

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

介接URL

https://api.polyv.net/live/v3/channel/chat/get-censor-enabled

介接說明

1、用途：用於取得聊天審核開關介接
2、介接支援https協定

支援格式

JSON

請求方式

GET

請求數限制

TRUE

請求參數

參數名	必填	類型	說明
appId	是	string	從API設定中取得，在直播系統登記的appId
timestamp	是	string	當前時間的秒級時間戳（13位）
sign	是	String	簽名，為32位大寫的MD5值,`生成簽名的appSecret密鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在客戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名生成規則】
channelId	是	int	頻道號

操作成功回應範例

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

操作失敗回應範例

簽名錯誤

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

回應欄位說明

名稱	類型	說明
code	string	回應代碼，成功為200，失敗為400，簽名錯誤為403，異常錯誤500
status	string	成功為success，失敗為error
message	string	錯誤時為錯誤提示訊息
data	boolean	成功回傳是否開啟了聊天審核開關，開啟為true，沒開啟為false

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-enabled?".http_build_query($params);
echo "<script>window.location.href='$url'</script>";
?>