判断该用户是否是被踢出用户
更新时间:2022-05-23 17:54:01
接口URL
http://api.polyv.net/live/v3/channel/chat/is-kicked
接口说明
1、作用:判断该用户是否是被踢出的用户。
2、接口支持https协议
支持格式
JSON
请求方式
POST
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| roomId | 是 | string | 频道号\房间号 |
| userId | 是 | string | 用户userId |
响应成功JSON示例
{
"code": 200,
"data": true,
"message": "",
"status": "success"
}
响应失败JSON示例:
未输入appId
{
"code": 400,
"status": "error",
"message": "appId is required.",
"data": ""
}
appId不正确
{
"code": 400,
"status": "error",
"message": "application not found.",
"data": ""
}
时间戳错误
{
"code": 400,
"status": "error",
"message": "invalid timestamp.",
"data": ""
}
签名错误
{
"code": 403,
"status": "error",
"message": "invalid signature.",
"data": ""
}
字段说明
| 参数名 | 说明 |
|---|---|
| code | 响应代码,成功为200,失败为400,签名错误为401,异常错误500 |
| status | 成功为success,失败为error |
| message | 错误时为错误提示消息 |
| data | true(是被踢出的用户)/false(不是被踢出的用户) |
php请求示例
?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;
?>
