Skip to navigation

Play status callback

View as MarkdownOpen in Claude

Sent to the status_url of a calling.play command when playback changes state. params.state is playing, paused, finished, or error.

Status callbacks are advisory, best-effort notifications — delivery can be delayed or fail silently, so don’t gate time-critical actions on receiving one. See Status callback reliability.

Payload

The payload of this webhook request is an object.
event_typeenumRequired

The type of event. Always calling.call.play for play status callbacks.

Allowed values:
event_channelstringRequired
The channel the event was delivered on.
timestampdoubleRequired
When the event was sent, as a Unix timestamp in seconds.
project_idstringRequiredformat: "uuid"
Your project ID.
space_idstringRequiredformat: "uuid"
Your Space ID.
paramsobjectRequired
The play operation and its new state.

Response

200
Webhook received