Get user events
Get user events
https://api.agora.io/dev/v2/project/<appid>/rtm/vendor/user_events
This method gets the user events from the address specified by the Agora Signaling server. Events you acquire using this API are removed from the server. You cannot retrieve the same event twice.
The Signaling backend stores a maximum of 2,000 events, with the latest event replacing the oldest when this limit is exceeded. The backend returns a maximum of 1,000 events per request, and the number of requests for each app ID must not exceed 10 per second.
Agora does not guarantee event time sequence across geographical regions. Events pulled from different regions may contain duplicates since synchronization only occurs within regions, not across them.
Request
Path parameters
The App ID of your Agora project.
This endpoint does not require any query parameters or a request body.
Response
- If the returned status code is
200, the request was successful. The response body contains the result of the request.
OK
- result string
The result of this request.
success: The request succeeds.failed: The request fails.
- request_id string
The unique ID of this request.
- events array
An array of login and logout events. Each event object contains:
- user_id string
The corresponding user ID.
- type string
Event type:
Login: The user logged in to Signaling.Logout: The user logged out of Signaling.
- ms integer
Number of milliseconds since January 1, 1970 (UTC) to the UTC time when the server receives the message.
- If the returned status code is not
200, the request failed. The response body includes the error code and description. Refer to status codes to understand the possible reasons for failure.