ListEventSubEvent API for Callback Record Retrieval - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries callback records.

Operation description

Maximum query span: 7 days.
Minimum query granularity: 1 minute.
Maximum query range: data from the last 7 days.

QPS limit

The single-user QPS limit for this operation is 50 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.

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:ListEventSubEvent

list

*Rtc

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

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the subscribed application.	9qb1****
SubscribeId	string	No	The subscribe ID. You can obtain the subscribe ID from the response parameters of the CreateEventSub operation by using a parameter query.	ad53276431c****
StartTime	integer	Yes	The start time, expressed as a UNIX timestamp. Unit: seconds.	1698195600
EndTime	integer	Yes	The end time, expressed as a UNIX timestamp. Unit: seconds.	1698201013
PageSize	integer	Yes	The number of records per page. Valid values: 1 to 100.	10
PageNo	integer	Yes	The page number. Valid values: 1 and greater.	20

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	CC8CB656-A7BA-1811-9D6B-4CC187E988BD
Count	integer	The total number of callback records returned on the current page.	1
HasMore	boolean	Indicates whether there is a next page.	false
Logs	array<object>	The callback records.
	object	The callback records.
AppId	string	The ID of the subscribed application.	9qb1****
SubId	string	The subscription event ID.	ad53276431c****
MessageId	string	The callback record ID.	875d5266cbabb1834cc84a105cf6****
Data	string	The callback content details.	{\"MsgId\":\"875d5266cbabb1834cc84a105cf68454\",\"MsgTimestamp\":1697545591,\"SubscribeId\":\"09be0d2254cb5a89f4cbd86403ec5343\",\"AppId\":\"xxx\",\"ChannelId\":\"9099\",\"Contents\":[{\"Event\":\"UserEvent\",\"UserEvent\":{\"UserId\":\"linux_test\",\"EventTag\":\"Leave\",\"SessionId\":\"je7y2sBZJZQ0VBJZrh4LnBkxvGH2WyVs\",\"Timestamp\":1697545591,\"ChannelProfile\":\"interactive_live\",\"US\":5068748604047364,\"Reason\":1,\"Role\":1,\"TerminalType\":6,\"UserType\":2}}]}
Cost	integer	The callback duration. Unit: milliseconds.	22
Time	string	The time when the callback record was generated. The time is in the UTC+8 time zone. Format: yyyy-MM-dd hh:mm:ss.SSS.	2023-10-17 20:26:31.988
Url	string	The callback URL.	http://****.com/callback
Code	integer	The error code. A value of 200 indicates a successful callback.	200

Examples

Success response

JSON format

{
  "RequestId": "CC8CB656-A7BA-1811-9D6B-4CC187E988BD",
  "Count": 1,
  "HasMore": false,
  "Logs": [
    {
      "AppId": "9qb1****",
      "SubId": "ad53276431c****",
      "MessageId": "875d5266cbabb1834cc84a105cf6****",
      "Data": "{\\\"MsgId\\\":\\\"875d5266cbabb1834cc84a105cf68454\\\",\\\"MsgTimestamp\\\":1697545591,\\\"SubscribeId\\\":\\\"09be0d2254cb5a89f4cbd86403ec5343\\\",\\\"AppId\\\":\\\"xxx\\\",\\\"ChannelId\\\":\\\"9099\\\",\\\"Contents\\\":[{\\\"Event\\\":\\\"UserEvent\\\",\\\"UserEvent\\\":{\\\"UserId\\\":\\\"linux_test\\\",\\\"EventTag\\\":\\\"Leave\\\",\\\"SessionId\\\":\\\"je7y2sBZJZQ0VBJZrh4LnBkxvGH2WyVs\\\",\\\"Timestamp\\\":1697545591,\\\"ChannelProfile\\\":\\\"interactive_live\\\",\\\"US\\\":5068748604047364,\\\"Reason\\\":1,\\\"Role\\\":1,\\\"TerminalType\\\":6,\\\"UserType\\\":2}}]}",
      "Cost": 22,
      "Time": "2023-10-17 20:26:31.988",
      "Url": "http://****.com/callback",
      "Code": 200
    }
  ]
}

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.