更新聊天審核開關
更新時間:2022-09-02 18:08:07
介面URL
https://api.polyv.net/live/v3/channel/chat/update-censor-enabled
介面說明
1、作用:用於更新聊天審核開關介面
2、介面支援https協定
支援格式
JSON
請求方式
POST
請求數限制
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,
'timestamp' => $timestamp,
'channelId' => '123456'
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;
$url = "https://api.polyv.net/live/v3/channel/chat/update-censor-enabled?".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, 1);
$res = curl_exec($curl);
curl_close($curl);
echo $res;
?>
