Query all virtual player playback tasks within a room using this interface.

Endpoint URL

• Request method: POST
• URL: CommsEase provides the following two API request URLs. For the V3 resources, you need to specify cname in the URL. You can call any one of the APIs according to your business needs.
  • https://logic-dev.netease.im/v2/api/task/list
  • https://logic-dev.netease.im/v3/api/task/list?cname={cname}

Path parameter:

API throttling

The default limit is 50 calls/second. If the request rate exceeds this limit, it may return error code 429.

Request parameters

• Set the Header in the request according to the request structure.
• The Body of the request must be in JSON format, with the following parameter descriptions:

Response fields

Example

Sample request

json{
    "cid":1144509608259296
    "taskType": 2,  // Constant 2 
}

Sample response

json{
    "code":200，
    "errmsg":"",
    "result": [{
        "cid": 1144509608259296,
        "taskId": "2a784467d647bb87b60b719f6fa56333",
        "data":{
            "streamUrl": "rtmp://example.yunxin.io/live/class32/101",
            "uid": 101,
            "idleTimeout": 300,
            "playTs": 1575508644,
            "mediaType":0, // 0: audio stream， 1: video stream， 2: audio and video stream
            "volume":100, // Set the volume level within the range of [0, 200]. Default is 100, indicating original sound playback. Values above 100 increase the volume, while values below 100 decrease it.
            "repeatTime":1 // number of repeated playback. Default value is 1. Use -1 to indicate infinite looping until the task stops.
            }
        }
    ]       
}

Status Code

A code of 200 in the response indicates a successful call. For other code values, refer to the online media stream status codes based on the code and errmsg to identify the issue.