Command acknowledgements

Shared contract for commands accepted before a domain outcome is verified.
View as Markdown

Command acknowledgements report that the gateway accepted or dispatched a command. They use the uniform command.<canonical_command>.accepted namespace. Domain events such as recording.became_available, room.deleted, playback.started, and playback.failed report verified outcomes.

All command acknowledgements use the shared CommandAcceptedEvent contract.

FieldPresenceDescription
eventRequiredOne canonical command.*.accepted value from the catalog below.
timestampRequiredRFC 3339 / ISO 8601 UTC time when the command was accepted and the acknowledgement was emitted.
operation_uuidConditionalRequired when the command response includes an operation. Omitted for call dial, room delete, and room-member volume.
session_uuidConditionalTarget Session for session-scoped commands.
room_idConditionalTarget Room for room-scoped commands. At least one of session_uuid or room_id is always present; member-volume acknowledgements contain both.

Only information necessary to interpret the accepted command extends this base: dial correlation (direction, type, to, from), recording identity and access (recording_uuid, pull_url), playback inputs (urls, offset_ms), or the requested volume/direction.

If an acknowledgement ever carries an additional date-time with a specific meaning, that field uses <meaning>_at. The event’s own occurrence time always remains timestamp.

Catalog

Command acknowledgementTargetoperation_uuidExtension fields
command.call.dial.acceptedsession_uuidOmitteddirection, type, to, from
command.playback.pause.acceptedsession_uuidRequired
command.playback.resume.acceptedsession_uuidRequired
command.playback.seek.acceptedsession_uuidRequiredoffset_ms
command.playback.restart.acceptedsession_uuidRequired
command.recording.start.acceptedsession_uuid or room_idRequiredrecording_uuid, pull_url, expires_at
command.recording.mask.acceptedsession_uuidRequiredrecording_uuid; optional pull_url + expires_at pair
command.recording.unmask.acceptedsession_uuidRequiredrecording_uuid; optional pull_url + expires_at pair
command.room.delete.acceptedroom_idOmitted
command.room.member.volume.acceptedsession_uuid, room_idOmittedvolume, direction
command.room.playback.start.acceptedroom_idRequiredurls
command.room.playback.pause.acceptedroom_idRequired
command.room.playback.resume.acceptedroom_idRequired
command.room.playback.stop.acceptedroom_idRequired
command.room.playback.volume.acceptedroom_idRequiredvolume
command.websocket.pause.acceptedsession_uuidRequired
command.websocket.resume.acceptedsession_uuidRequired
command.websocket.mute.acceptedsession_uuidRequired
command.websocket.unmute.acceptedsession_uuidRequired
command.websocket.flush.acceptedsession_uuidRequired

Category reference pages show concrete examples and the verified domain events that can follow each acknowledgement.