Query Interactive Listener Event List

Updated: 2026-05-22 10:16:23

API Description

由业务服务端调用，查询指定频道下当前仍挂在监听队列中的互动监听任务列表；
接口支持 HTTPS 协议。

API URL

https://api.polyv.net/live/v5/chat/redirect/channel/interaction_event/list

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS; HTTPS is recommended for security.
status is calculated by the server based on the current time and the task's startTime, endTime: waiting (Not Started), running (In Progress), ended (Ended).
The list is queried by channel; the same channel may contain other valid tasks left over from historical activities. During integration testing, it is recommended to use save/remove or clean up via the management console.

Request Parameters

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 used to generate the signature is critical for communication data security. It must not be 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
roomId	true	String(1,100)	Channel ID (query parameter)

Examples

Request Example:

GET https://api.polyv.net/live/v5/chat/redirect/channel/interaction_event/list?roomId=412738

Response JSON (Success):

{
  "code": 200,
  "status": "success",
  "message": "获取成功",
  "data": {
    "list": [
      {
        "taskId": "task_sign_001",
        "activityId": "activity_20250521_001",
        "type": "signCount",
        "startTime": 1747785600000,
        "endTime": 1747785660000,
        "status": "running",
        "signCount": 1
      }
    ]
  }
}

When there are no valid tasks, data.list is an empty array [].

Response Parameters

Parameter	Type	Description
code	Integer	200 indicates success; 400 indicates parameter validation failure; 500 indicates business error or server exception
status	String	`success` / `fail` / `error`
message	String	e.g., "Successfully retrieved" or specific error description
data	Object	Contains `list` (array of task objects)

data.list Element Fields

Parameter	Type	Description
taskId	String	Task ID
activityId	String	Activity ID
type	String	Task type, see save API taskList.type
startTime	Number	Start time (millisecond timestamp)
endTime	Number	End time (millisecond timestamp)
status	String	`waiting` \| `running` \| `ended`
userTags	String[]	List of user tag IDs (optional)
payload	String	Custom payload (optional)
onlineTime	Number	Returned when `type` is `onlineTime`
signCount	Number	Returned when `type` is `signCount`
likesCount	Number	Returned when `type` is `likesCount`
speakCount	Number	Returned when `type` is `speakCount`
speakContent	String	Returned when `type` is `speakCount`
customCount	Number	Returned when `type` is `customCount`
eventType	String	Returned when `type` is `customCount`
loginDays	Number	Returned when `type` is `loginDays`
minOnlineTimePerDay	Number	Returned when `type` is `loginDays`
logicType	String	`AND` \| `OR` (optional)
allDone	String	`Y` \| `N` (optional)
isUnlock	String	`Y` \| `N` (optional)
parentTaskId	String	Parent task ID (optional)

Error Examples

Parameter Validation Failure:

{
  "code": 400,
  "status": "fail",
  "message": "缺少参数roomId"
}

Channel and Account Mismatch:

{
  "code": 400,
  "status": "fail",
  "message": "roomId非法"
}

Missing x-auth-user-id:

{
  "code": 400,
  "status": "fail",
  "message": "accountId is required"
}

Server Exception:

{
  "code": 500,
  "status": "error",
  "message": "获取失败"
}

(The specific message depends on the actual error message.)

Live Streaming Server API