Get Chat Review Status
Updated: 2022-09-02 18:08:07
Interface URL
https://api.polyv.net/live/v3/channel/chat/get-censor-enabled
Interface Description
1. Purpose: Used to retrieve the chat review status setting.
2. The interface supports the HTTPS protocol.
Supported Format
JSON
Request Method
GET
Request Rate Limit
TRUE
Request Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| appId | Yes | string | Obtained from API settings, the appId registered in the live streaming system. |
| timestamp | Yes | string | Current time in seconds (13-digit timestamp). |
| sign | Yes | String | Signature, a 32-character uppercase MD5 value. The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client side. All API calls must be relayed through the customer's own server to the POLYV server to obtain response data. See signature generation rules |
| channelId | Yes | int | Channel ID. |
Example of Successful Response
{
"code": 200,
"message": "",
"status": "success",
"data": true
}
Example of Failed Response
Signature Error
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
Response Field Description
| Name | Type | Description |
|---|---|---|
| code | string | Response code: 200 for success, 400 for failure, 403 for signature error, 500 for server error. |
| status | string | "success" for success, "error" for failure. |
| message | string | Error message when an error occurs. |
| data | boolean | Returns whether the chat review switch is enabled: true if enabled, false if disabled. |
PHP Request Example
<?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>";
?>
