接口URL
http://api.polyv.net/live/v2/chat/{userId}/addBadWords
接口说明
1、作用：批量导入频道严禁词
2、接口URL中的{userId}为 直播账号ID
3、接口支持https协议
请求方式
POST
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | 是 | string | 从API设置中获取，在直播系统登记的appId |
| sign | 是 | string | 签名，32位大写MD5值 |
| timestamp | 是 | string | 当前13位毫秒级时间戳，3分钟内有效 |
| words | 是 | string | 严禁词，json的数组格式，例如["forbiddenWords1"] |
| channelId | 否 | int | 频道ID，非必填，不填添则设置为通用设置内的严禁词 |
响应成功JSON示例
{
code: 200,
status: "success",
message: "",
data: {
userId: "eh4yoozloc",
count: 2
}
}
响应异常JSON示例
{
code: 400,
status: "error",
message: "invalid timestamp.",
data: ""
}
响应参数
| 参数名 | 说明 |
|---|---|
| status | 响应状态 |
| data | 响应结果 |
| code | http响应状态码 |
| msg | 异常错误信息 |
| userId | 用户Id |
| count | 为该频道严禁词的数量，如果修改全部频道，count为该该账户严禁词的全部数量 |
PHP请求示例
<?php
//引用config.php
include 'config.php';
//接口需要的参数（非sign）赋值
$userId="XXXXXXXX";
$channelId = 127075;
$words ='["forbiddenWords1","forbiddenWords2"]';
$params = array(
'appId'=>$appId,
'channelId'=>$channelId,
'words'=>$words,
'timestamp'=>$timestamp
);
//生成sign
$sign = getSign($params); //详细查看config.php文件的getSign方法
$data = array(
'appId' => $appId,
'timestamp' => $timestamp,
'sign' => $sign,
'channelId' => $channelId,
'words' => $words
);
$url="http://api.polyv.net/live/v2/chat/{$userId}/addBadWords";
$ch = curl_init() or die ( curl_error() );
curl_setopt( $ch, CURLOPT_URL, $url);
curl_setopt( $ch, CURLOPT_POSTFIELDS, $data);
curl_setopt ($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT, 360);
$response = curl_exec ( $ch );
curl_close ( $ch );
echo $response;
?>
Loading...