更新聊天审核开关

接口描述

1、更新聊天审核开关
2、接口支持https协议

接口URL

https://api.polyv.net/live/v3/channel/chat/update-censor-enabled

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名
必选
类型
说明

appId

true

String

timestamp

true

Long

当前13位毫秒级时间戳，3分钟内有效

sign

true

String

channelId

是

int

频道号

enabled

否

string

开关 Y/N, 不传时根据当前开关值进行开启/关闭

示例

http://api.polyv.net/live/v3/channel/chat/update-censor-enabled?appId=frlr1zazn3&sign=FD701BFA3DCE2C7DCC362A904DBF48B0&timestamp=1636536555144&channelId=3335806&enabled=Y

响应参数描述

名称
类型
说明

code

string

响应代码，成功为200，失败为400，签名错误为403，异常错误500

status

string

成功为success，失败为error

message

string

错误时为错误提示消息

data

boolean

设置成功返回当前聊天审核开关类型，开启为true，没开启为false

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(getClass());

@Test
public void testUpdateCensorEnabled() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/chat/update-censor-enabled";
    String channelId = "3335806";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("enabled", "Y");
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postFormBody(url, null);
    
    log.info("测试更新聊天审核开关：{}", response);
    //do somethings
        
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

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

异常示例

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

Last updated

Was this helpful?