Listen on the event stream of a particular room.
GET {{baseUrl}}/events ?from=s3456_9_0&timeout=43067668&room_id=Ut aliqua cupidatat eiusmod
This will listen for new events related to a particular room and return
them to the caller. This will block until an event is received, or until
the timeout
is reached.
This API is the same as the normal /events
endpoint, but can be
called by users who have not joined the room.
Note that the normal /events
endpoint has been deprecated. This
API will also be deprecated at some point, but its replacement is not
yet known.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
from | string | The token to stream from. This token is either from a previous | |
request to this API or from the initial sync API. | |||
timeout | number | The maximum time in milliseconds to wait for an event. | |
room_id | string | The room ID for which events should be returned. |
RESPONSES
status: OK
{"start":"s3456_9_0","end":"s3457_9_0","chunk":[{"$ref":"../../event-schemas/examples/m.room.message$m.text.yaml"}]}