ListEventSub API Reference for Channel Event Subscriptions - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries events from channels to which you subscribe.

Operation description

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:ListEventSub

list

*Rtc

acs:live::{#accountId}:rtc/{#AppId}

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	9qb1****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08
Subscribers	array<object>	The events.
	object	The information about the event.
SubId	string	The ID of the event.	09be0d2254cb5a89f4cbd86403ec****
ChannelId	string	The ID of the channel to which you subscribe.	testmodify
Events	array	The type of the event. Valid values: ChannelEvent: channel event. For example, the channel is opened or closed. UserEvent: user event. For example, a user joins or leaves the channel.
	string	The subscribed event.	ChannelEvent
CallbackUrl	string	The callback URL.	http://****.com/callback
CreateTime	string	The time when the subscription was created. The time is displayed in UTC+8. Format: yyyy-MM-dd hh:mm:ss.	2023-08-18 10:14:49
ModifyTime	string	The time when the subscription was modified. The time is displayed in UTC+8. Format: yyyy-MM-dd hh:mm:ss.	2023-08-18 10:14:49
Users	array	The users whose events are returned. Use either this parameter or Roles.
	string	Triggers callbacks only for events of this user. Not recommended for use with Roles.	testUser
Roles `deprecated`	integer	The role of the user whose events are returned. Valid values: 1: streamer 2: viewer An empty value or a value other than 1 and 2 indicates that events of all users in the channel are returned. Note This parameter is deprecated. When you create a subscription, this parameter is no longer supported.	1

Examples

Success response

JSON format

{
  "RequestId": "AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08",
  "Subscribers": [
    {
      "SubId": "09be0d2254cb5a89f4cbd86403ec****",
      "ChannelId": "testmodify",
      "Events": [
        "ChannelEvent"
      ],
      "CallbackUrl": "http://****.com/callback",
      "CreateTime": "2023-08-18 10:14:49",
      "ModifyTime": "2023-08-18 10:14:49",
      "Users": [
        "testUser"
      ],
      "Roles": 1
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Illegal input parameters
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.