Batch Delete Multiple Chat Messages in a Channel

Updated: 2023-01-31 11:32:33

API Description

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

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure security. API calls have frequency limits. See details
When passing 10 chat message IDs in ids, if one chat message ID does not exist, the other 9 chat messages will be deleted and a code=200 success response will be returned.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
channelId	true	String	Channel ID
ids	true	String	Chat message IDs (multiple IDs separated by commas). This parameter is obtained from Query Channel Chat Messages

Example

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

Form Parameters:

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure See global error description
status	String	Response status text
message	String	Response description. When code is 400 or 500, it provides additional error details
data	String	On success, returns "remove chat contents success"; on failure, returns empty

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download source code. After downloading, add it to your own source code project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

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

}

Response Example

For global error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API