Room Playback overview

Room Playback plays URL-based audio into a room for every member to hear. Start with Play audio in room, then seek, pause or resume, set volume, or stop.

When to use

Use Room Playback when everyone in a Room should hear the same audio, such as an announcement or prerecorded message.

To play finite files, include type: "files" and a non-empty urls array. The type field is required.

These commands return 202 Accepted when accepted for processing. Every command accepts an optional Operation-Id request header containing a lowercase UUID v4; the response returns the selected value as operation_uuid, generating one when the header is omitted. Use Idempotency-Key separately for safe retries.

Every playback that starts produces exactly one terminal event: room.playback.ended or room.playback.failed. The terminal event’s operation_uuid correlates it with the original play request. When playback is stopped through the API, the stop request’s own 202 Accepted response carries its separate effective operation_uuid.

Room Playback controls the shared mix. Use session playback for audio aimed at one session.