批量删除频道多条聊天记录

接口描述

1、根据聊天的id删除对应聊天记录
2、接口支持批量删除操作
3、接口支持https

接口URL

http://api.polyv.net/live/v3/channel/chat/remove-contents

在线API调用

请求方式

POST

接口约束

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

2、ids中传10个聊天记录id,其中1个聊天记录id不存在时,会删除9条聊天记录并返回code=200成功

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

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

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

channelId

true

String

频道号

ids

true

String

聊天记录对应的id(多个id使用英文逗号隔开),该参数获取自【查询频道聊天记录

示例

https://api.polyv.net/live/v3/channel/chat/remove-contents

表单参数:

appId=frlr1zazn3&sign=195255A27C1FB410378598AA140B5D2C&ids=c71c7240-86cd-11eb-a963-e9bab7dc4d86&channelId=2202970&timestamp=1621843538655

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

message

String

响应描述信息,当code为400或者500的时候,辅助描述错误原因

data

String

响应成功返回"remove chat contents success",失败返回空

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 批量删除频道多条聊天记录
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testRemoveChatContents() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/channel/chat/remove-contents";
    String channelId = "2202970";
    String ids = "c71c7240-86cd-11eb-a963-e9bab7dc4d86";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("ids", ids);

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试批量删除频道多条聊天记录:{}", response);
    //do somethings

}

响应示例

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

成功示例

{
	"code": 200,
	"status": "success",
	"message": "",
	"data": "remove chat contents success"
}

异常示例

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

Last updated