Polyv Help Center

Help Center

Determine if the User is a Kicked-Out User

Updated: 2022-05-23 17:54:01

Interface URL

http://api.polyv.net/live/v3/channel/chat/is-kicked

Interface Description

1、作用:判断该用户是否是被踢出的用户。
2、接口支持https协议

Supported Format

JSON

Request Method

POST

Request Parameters

Parameter Required Type Description
roomId Yes string Channel ID / Room ID
userId Yes string User userId

Successful Response JSON Example

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

Failed Response JSON Example:

No appId provided

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}

Incorrect appId

{
    "code": 400,
    "status": "error",
    "message": "application not found.",
    "data": ""
}

Timestamp error

{
    "code": 400,
    "status": "error",
    "message": "invalid timestamp.",
    "data": ""
}

Signature error

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

Field Description

Parameter Description
code Response code: 200 for success, 400 for failure, 401 for signature error, 500 for exception error
status success for success, error for failure
message Error prompt message when an error occurs
data true (user is kicked out) / false (user is not kicked out)

PHP Request Example

?php
//引用config.php
include 'config.php';

$params = array(
  'appId' => $appId,
  'timestamp' => $timestamp,
  'roomId' => $roomId,
  'userId' => $userId
);

//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$params['sign'] = $sign;

$url = "http://api.polyv.net/live/v3/channel/chat/is-kicked?".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, 0);
$res = curl_exec($curl);
curl_close($curl);

echo $res;
?>
联系客服,在线咨询