Delete Interaction Listener Event

Updated: 2025-06-13 17:58:33

API Description

1、删除互动监听事件
2、接口支持https协议

API URL

https://api.polyv.net/live/v4/channel/interaction-event/delete

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
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 stored or used directly on the client. 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

Request Body Parameter Description

Parameter	Required	Type	Description
channelId	true	Integer	Channel ID
taskIds	true	Array	Task ID collection; when allDone=Y, pass the activityId. When allDone=N, pass the taskId to be deleted

Example

https://api.polyv.net/live/v4/channel/interaction-event/delete?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318

Request body JSON parameters:

{
    "channelId": 5392252,
    "taskIds": [
      "11qwaqwa"
    ]
}

Response body JSON:

{
    "code": 200,
    "status": "success",
    "requestId": "97b1d5b923494a3f864c4fe718cf8c96.75.17338881638035489",
    "data": true,
    "success": true
}

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure
status	String	Response result, determined by business logic, returns success on success, error on failure
success	Boolean	Response result, determined by business logic, returns true on success, false on failure
data	Boolean	Whether the listener deletion was successful
error	Object	Error information when status code is non-200 See Error Field Description
requestId	String	Request ID, a unique UUID generated for each request, used only for troubleshooting and debugging, should not be tied to business logic

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error cause
desc	String	Error description, corresponding to error.code

Java Request Example

For quick integration of the base code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. HttpUtil.java and LiveSignUtil.java in the test cases are included in the download file.

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

import java.util.ArrayList;

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

/**
 * 删除监听事件
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void deleteTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    String url = "https://api.polyv.net/live/v4/channel/interaction-event/delete";
    //业务参数
    Integer channelId = 5004544;
    String activityName = "demoData";
    Long startTime = 1722035312584;
    Long endTime = 1722036312584;

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

    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("channelId", channelId);
    jsonMap.put("taskIds", new ArrayList<String>());

    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);

    log.info("测试删除监听事件：{}", response);
    //do somethings

}

Response Example

See Global Error Description for system-wide error descriptions.

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "e9eb12f0-5d55-482a-8a47-62863d04772c",
    "data": true,
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API