Event reference

View as Markdown

Realtime Media Streams (RTMS) uses events and messages to establish connections, manage state, and deliver media data. Events are organized into three categories based on their scope and applicability.

Event categories

RTMS events fall into three categories. Understanding which categories apply to your implementation helps you integrate the correct event handlers.

CategoryApplies toDescription
Universal eventsMeetings, Webinars, Video SDK, Contact CenterProtocol handshakes, keep-alive operations, session and stream state management, and media data delivery. Required for all RTMS implementations.
Session eventsMeetings, Webinars, Video SDKReal-time updates about session activity including participants, active speaker, screen sharing, video state, and in-meeting chat groups.
Contact Center eventsContact CenterVoice call lifecycle, transfers, conferences, supervisor monitoring, IVR streaming, and queue operations.

Which events do I need?

Your RTMS implementation requires different event categories depending on your product.

For Meetings, Webinars, or Video SDK:

For Contact Center:

Getting started

To begin working with RTMS events:

  1. Review Universal events to understand the connection handshake and media delivery protocol.
  2. Check the product-specific event reference for your implementation (Session events or Contact Center events).
  3. Refer to Data type definitions for detailed field value specifications.