Create Interaction Monitoring Event

API Description

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

API URL

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

Request Method

POST

API Constraints

1. The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
2. This API monitors once based on the start/end time. For long-term subscriptions per live session (automatic callback of UV/PV for the session after class), use Save Session Interaction Monitoring Subscription.

Request Parameter Description

Request Body Parameter Description

Callback Description (POST Request)

Content Array Object Description

Data List Description

Callback Response Description

The callback interface response body must meet one of the following conditions, otherwise the system will retry and abandon the callback after 5 consecutive failures:

• The value of the code field is 200
• The value of the status field is success

Tasks Parameter Description

Example

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

Request body JSON parameters:

{
    "channelId": 5392252,
    "tasks": [
        {
          "type":"signCount",
          "signCount": 2,
          "startTime": 1733888246000,
          "endTime":   1733888426000
        }
    ],
    "callbackUrl" : "http://callback/write",
    "allDone": "Y"
}

Response body JSON:

{
  "code": 200,
  "status": "success",
  "requestId": "5b7d9087-c632-4607-93de-ed3da2c7a4cf",
  "data": {
    "activityId": "95564091-b835-11ef-9283-17521e995374",
    "list": [
      {
        "taskId": "95564090-b835-11ef-9283-17521e995374",
        "result": {
          "status": "success",
          "message": "",
          "code": 200,
          "data": ""
        }
      }
    ]
  },
  "message": "添加任务成功",
  "success": true
}

Response Parameter Description

Error Parameter Description

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source code 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.

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 新建监听事件
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void createTest() 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/save";
    //业务参数
    Integer channelId = 5004544;
    String activityName = "demoData";
    Integer taskRule = 1;
    Long startTime = 1722035312584;
    Long endTime = 1722036312584;
    List<Task> tasks = new ArrayList();
    
    //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("tasks", tasks);
    jsonMap.put("callbackUrl", "http://callback/write");
    jsonMap.put("allDone", "Y");
    
    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

For global system error descriptions, see Global Error Description

Success Example

{
  "code": 200,
  "status": "success",
  "requestId": "5b7d9087-c632-4607-93de-ed3da2c7a4cf",
  "data": {
    "activityId": "95564091-b835-11ef-9283-17521e995374",
    "list": [
      {
        "taskId": "95564090-b835-11ef-9283-17521e995374",
        "result": {
          "status": "success",
          "message": "",
          "code": 200,
          "data": ""
        }
      }
    ]
  },
  "message": "添加任务成功",
  "success": true
}

Error Example

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

{
    "code": 200,
    "status": "success",
    "requestId": "29fc71ae-110f-43f2-87f0-4d60a6c743ff",
    "data": {
        "list": [
            {
                "taskId": "2368e870-b835-11ef-9283-17521e995374",
                "result": {
                    "status": "error",
                    "message": "time is too long",
                    "code": 505,
                    "data": {}
                }
            }
        ],
        "activityId": "2368e871-b835-11ef-9283-17521e995374"
    },
    "message": "添加任务成功",
    "success": true
}