Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Live voice agents use a separate WebSocket endpoint from voice-agent realtime sessions. Some event types apply only to specific transports or sideband connections.
These tables describe the event properties and link to their models.
Server events
- session.input_audio.append
- session.output_audio.delta
- session.started
- session.updated
- session.input_audio.muted
- session.input_audio.unmuted
- session.output_audio.fixture.playing
- session.output_audio.fixture.played
- session.instructions.appended
- session.thinking.appended
- session.commentary.appended
- session.input_transcript.delta
- session.output_transcript.delta
- session.delegation.created
- decision.event
- decision.item.created
- decision.item.deleted
- response.event
- session.usage.updated
- session.closed
- error
- info
- transport.dtmf.received
- transport.dtmf.sent
- transport.ringing
- transport.answered
- transport.failed
session.input_audio.append
Schema: OpenAI.LiveInputAudioAppend.
Input audio received from the primary transport and reflected to a Live sideband connection before model-input muting.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
type |
"session.input_audio.append" |
Yes | The event type, always session.input_audio.append. |
audio |
string |
Yes | Base64-encoded raw mono PCM16LE at 24 kHz received from the primary transport, reflected to the sideband before model-input muting. This server event uses the same audio key as the client command, but is not an acknowledgment of it. |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.input_audio.append",
"audio": "AACAAIAAAIAAAP9/AIAAgA=="
}
session.output_audio.delta
Schema: OpenAI.LiveOutputAudioDelta.
An audio chunk generated by the Live model. Decode and play primary WebSocket chunks in delivery order using the configured session audio format. Sideband connections receive reflected output audio with timestamps.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
type |
"session.output_audio.delta" |
Yes | The event type, always session.output_audio.delta. |
delta |
string |
Yes | Base64-encoded raw audio. Primary WebSocket events use the session's configured format; reflected sideband events use mono PCM16LE at 24 kHz. |
start_ms |
OpenAI.integer | No | Inclusive session-relative start in milliseconds. Required on reflected sideband events; omitted on the primary WebSocket. |
end_ms |
OpenAI.integer | No | Exclusive session-relative end in milliseconds. Required on reflected sideband events; omitted on the primary WebSocket. Dropped output frames leave gaps between reflected ranges. |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.output_audio.delta",
"delta": "AACAAIAAAIAAAP9/AIAAgA==",
"start_ms": 1000,
"end_ms": 1200
}
session.started
Schema: OpenAI.LiveServerEventLiveSessionStarted.
Returned when a Live session has started. Contains the resolved session configuration, including server defaults.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
type |
"session.started" |
Yes | The event type, always session.started. default: "session.started". |
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
session |
VoiceAgentLiveSessionResource | Yes | |
conversation_id |
string |
No | Stored conversation ID when effective store is true. Use protocols/voice/live/conversations; this ID differs from session.id. |
Required preview opt-ins: VoiceAgents=V1Preview.
session.updated
Schema: OpenAI.LiveServerEventLiveSessionUpdated.
Returned when a Live session update is accepted. Contains the resolved session configuration after the update.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
type |
"session.updated" |
Yes | The event type, always session.updated. default: "session.updated". |
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
session |
VoiceAgentLiveSessionResource | Yes |
Required preview opt-ins: VoiceAgents=V1Preview.
session.input_audio.muted
Schema: OpenAI.LiveServerEventLiveInputAudioMuted.
Acknowledges a session.input_audio.mute command. An independent input mute sends silence to the model and preserves sideband audio reflection. Fixture playback does not emit this event.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"session.input_audio.muted" |
Yes | The event type, always session.input_audio.muted. default: "session.input_audio.muted". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.input_audio.muted",
"event_id": "evt_muted_001",
"client_event_id": "evt_mute_001"
}
session.input_audio.unmuted
Schema: OpenAI.LiveServerEventLiveInputAudioUnmuted.
Acknowledges a session.input_audio.unmute command, removing the independent input mute. An active audio fixture still pauses inference until playback finishes. Fixture playback does not emit this event.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"session.input_audio.unmuted" |
Yes | The event type, always session.input_audio.unmuted. default: "session.input_audio.unmuted". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.input_audio.unmuted",
"event_id": "evt_unmuted_001",
"client_event_id": "evt_unmute_001"
}
session.output_audio.fixture.playing
Schema: OpenAI.LiveServerEventLiveOutputAudioFixturePlaying.
The existing playback path has accepted the validated audio fixture. This acknowledgment does not identify when the listener receives the first sample. The optional client_event_id echoes the play command.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"session.output_audio.fixture.playing" |
Yes | default: "session.output_audio.fixture.playing". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.output_audio.fixture.playing",
"event_id": "evt_playing_001",
"client_event_id": "evt_play_001"
}
session.output_audio.fixture.played
Schema: OpenAI.LiveServerEventLiveOutputAudioFixturePlayed.
The complete audio fixture has drained from the server mixer and normal inference has resumed. Transport buffers may still contain audio; this event does not prove listener-side completion. The optional client_event_id echoes the play command. This event is not emitted for canceled or failed playback.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"session.output_audio.fixture.played" |
Yes | default: "session.output_audio.fixture.played". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.output_audio.fixture.played",
"event_id": "evt_played_001",
"client_event_id": "evt_play_001"
}
session.instructions.appended
Schema: OpenAI.LiveServerEventLiveInstructionsAppended.
Returned when a session.instructions.append command is accepted into the Live session timeline. Acknowledges the appended instructions without guaranteeing that the model has acted on them.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
start_ms |
OpenAI.integer | Yes | The start of this event on the Live session timeline, in milliseconds from the beginning of the session. |
end_ms |
OpenAI.integer | Yes | The end of this event on the Live session timeline, in milliseconds from the beginning of the session. For appended context, this can equal start_ms. |
type |
"session.instructions.appended" |
Yes | The event type, always session.instructions.appended. default: "session.instructions.appended". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.instructions.appended",
"event_id": "evt_instructions_002",
"client_event_id": "evt_instructions_001",
"start_ms": 1200,
"end_ms": 1400
}
session.thinking.appended
Schema: OpenAI.LiveServerEventLiveThinkingAppended.
Returned when a session.thinking.append command is accepted into the Live session timeline. Acknowledges the added reasoning context without guaranteeing any spoken output.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
start_ms |
OpenAI.integer | Yes | The start of this event on the Live session timeline, in milliseconds from the beginning of the session. |
end_ms |
OpenAI.integer | Yes | The end of this event on the Live session timeline, in milliseconds from the beginning of the session. For appended context, this can equal start_ms. |
type |
"session.thinking.appended" |
Yes | The event type, always session.thinking.appended. default: "session.thinking.appended". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.thinking.appended",
"event_id": "evt_thinking_002",
"client_event_id": "evt_thinking_001",
"start_ms": 4600,
"end_ms": 4800
}
session.commentary.appended
Schema: OpenAI.LiveServerEventLiveCommentaryAppended.
Returned when a session.commentary.append command is accepted into the Live session timeline. Acknowledges the added commentary without guaranteeing exact wording or completed audio playback.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
start_ms |
OpenAI.integer | Yes | The start of this event on the Live session timeline, in milliseconds from the beginning of the session. |
end_ms |
OpenAI.integer | Yes | The end of this event on the Live session timeline, in milliseconds from the beginning of the session. For appended context, this can equal start_ms. |
type |
"session.commentary.appended" |
Yes | The event type, always session.commentary.appended. default: "session.commentary.appended". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.commentary.appended",
"event_id": "evt_commentary_002",
"client_event_id": "evt_commentary_001",
"start_ms": 5200,
"end_ms": 5400
}
session.input_transcript.delta
Schema: OpenAI.LiveServerEventLiveInputTranscriptDelta.
A transcript fragment for user input audio in the Live session. Accumulate fragments in delivery order; these events do not define complete turns or include a transcript-done event.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
start_ms |
OpenAI.integer | Yes | The start of this event on the Live session timeline, in milliseconds from the beginning of the session. |
end_ms |
OpenAI.integer | Yes | The end of this event on the Live session timeline, in milliseconds from the beginning of the session. For appended context, this can equal start_ms. |
delta |
string |
Yes | The transcript text fragment for the audio in this time range. Append fragments in delivery order to build the transcript. |
type |
"session.input_transcript.delta" |
Yes | The event type, always session.input_transcript.delta. default: "session.input_transcript.delta". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.input_transcript.delta",
"event_id": "evt_input_transcript_001",
"delta": "A table for two at seven, please.",
"start_ms": 1600,
"end_ms": 3400
}
session.output_transcript.delta
Schema: OpenAI.LiveServerEventLiveOutputTranscriptDelta.
A transcript fragment for assistant output audio in the Live session. Accumulate fragments in delivery order; these events do not define complete turns or include a transcript-done event.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
start_ms |
OpenAI.integer | Yes | The start of this event on the Live session timeline, in milliseconds from the beginning of the session. |
end_ms |
OpenAI.integer | Yes | The end of this event on the Live session timeline, in milliseconds from the beginning of the session. For appended context, this can equal start_ms. |
delta |
string |
Yes | The transcript text fragment for the audio in this time range. Append fragments in delivery order to build the transcript. |
type |
"session.output_transcript.delta" |
Yes | The event type, always session.output_transcript.delta. default: "session.output_transcript.delta". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.output_transcript.delta",
"event_id": "evt_output_transcript_001",
"delta": "Would you like me to reserve that table?",
"start_ms": 5400,
"end_ms": 7200
}
session.delegation.created
Schema: OpenAI.LiveServerEventLiveDelegationCreated.
Returned when the Live model delegates work to your application, Responses, or Decisions. Contains delegation metadata and the position on the session timeline where the work was delegated.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"session.delegation.created" |
Yes | The event type, always session.delegation.created. default: "session.delegation.created". |
offset_ms |
OpenAI.integer | Yes | The position on the Live session timeline where the delegation was created, in milliseconds from the beginning of the session. |
delegation |
VoiceAgentLiveDelegationItem | Yes | The delegated work identifier and destination. This object contains metadata, not the task text. |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.delegation.created",
"event_id": "evt_delegation_001",
"offset_ms": 3600,
"delegation": {
"id": "del_abc123",
"type": "delegation",
"target": "client"
}
}
decision.event
Schema: OpenAI.LiveServerEventLiveDecisionEvent.
A Decision API event for a Live delegation or transcript trigger. For a trigger, source_event_id identifies the transcript delta that caused this evaluation.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
type |
"decision.event" |
Yes | default: "decision.event". |
event_id |
string |
Yes | The unique ID of this Live server event. |
delegation_id |
Any of: string; null |
Yes | |
trigger_id |
Any of: string; null |
Yes | |
source_event_type |
Any of: "session.input_transcript.delta" or "session.output_transcript.delta"; null |
Yes | |
source_event_id |
Any of: string; null |
Yes | |
event |
OpenAI.LiveDecisionCompleted | Yes |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "decision.event",
"event_id": "evt_decision_1",
"delegation_id": "del_abc123",
"trigger_id": null,
"source_event_type": null,
"source_event_id": null,
"event": {
"type": "decision.completed",
"decision": {
"model": "gpt-6-luna",
"answers": [
{
"type": "predicate",
"name": "damaged",
"probability": 0.95
}
],
"usage": {
"input_tokens": 42,
"input_tokens_details": {
"cached_tokens": 0,
"cache_write_tokens": 0
},
"output_tokens": 0,
"output_tokens_details": {
"reasoning_tokens": 0
},
"total_tokens": 42
}
}
}
}
decision.item.created
Schema: OpenAI.LiveServerEventLiveDecisionItemCreated.
An input item was appended for future decisions.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"decision.item.created" |
Yes | default: "decision.item.created". |
item |
OpenAI.LiveDecisionStoredInputItemParam | Yes |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "decision.item.created",
"event_id": "evt_item_1",
"client_event_id": "browser_1",
"item": {
"id": "msg_browser_1",
"type": "message",
"role": "user",
"content": [
{
"type": "input_text",
"text": "Wikipedia is open."
}
]
}
}
decision.item.deleted
Schema: OpenAI.LiveServerEventLiveDecisionItemDeleted.
An input item was removed from future decisions.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"decision.item.deleted" |
Yes | default: "decision.item.deleted". |
item_id |
string |
Yes |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "decision.item.deleted",
"event_id": "evt_item_deleted_1",
"client_event_id": "remove_browser_1",
"item_id": "msg_browser_1"
}
response.event
Schema: OpenAI.LiveServerEventLiveResponseEvent.
A streaming Responses API event from a backend delegated to by the Live session. Use the outer delegation_id to associate the nested stream with its Live delegation.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"response.event" |
Yes | The event type, always response.event. default: "response.event". |
delegation_id |
Any of: string; null |
No | |
event |
object with additional values of any |
Yes | The nested Responses streaming event. Dispatch on its type field. Response lifecycle snapshots omit input and clear instructions, tools, and output to keep messages small; consume granular output events for the generated content. |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "response.event",
"event_id": "evt_response_002",
"delegation_id": "del_responses123",
"event": {
"type": "response.output_text.delta",
"item_id": "msg_abc123",
"output_index": 0,
"content_index": 0,
"delta": "An outdoor table is available at 7 PM.",
"sequence_number": 3,
"logprobs": []
}
}
session.usage.updated
Schema: OpenAI.LiveServerEventLiveSessionUsageUpdated.
Reports cumulative Live audio usage and, when available, the most recent context-window usage. Delegated Responses token usage is reported separately in response.event events.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"session.usage.updated" |
Yes | The event type, always session.usage.updated. default: "session.usage.updated". |
usage |
OpenAI.LiveSessionUsage | Yes | The cumulative Live audio usage so far. |
context_window |
OpenAI.LiveContextWindowUsage | No | The latest measured Live context-window usage. Omitted when the context limit is unknown. |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "session.usage.updated",
"event_id": "evt_usage_001",
"usage": {
"seconds": 32.5
},
"context_window": {
"usage_ratio": 0.12
}
}
session.closed
Schema: OpenAI.LiveServerEventLiveSessionClosed.
Returned after the Live session finishes finalizing, with the close reason, final session snapshot, and cumulative audio usage. A connection closing without this event does not confirm successful finalization.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"session.closed" |
Yes | The event type, always session.closed. default: "session.closed". |
reason |
"close_requested" or "expired" or "content" or "remote_hangup" or "connection_lost" |
Yes | Why the Live session ended: close_requested for an application close or hangup request, expired for the session duration limit, content for a safety filter, remote_hangup for a graceful remote disconnect, or connection_lost for an unexpected primary or upstream disconnection. default: "close_requested". |
session |
VoiceAgentLiveSessionResource | Yes | |
usage |
OpenAI.LiveSessionUsage | Yes | The final cumulative Live audio usage after session finalization. |
Required preview opt-ins: VoiceAgents=V1Preview.
error
Schema: OpenAI.LiveServerEventLiveErrorEvent.
Reports an error in the Live session, such as an invalid client command. Use error.client_event_id, when present, to identify the command that caused the error.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"error" |
Yes | The event type, always error. default: "error". |
error |
OpenAI.LiveLiveError | Yes | Details of the Live error and the client command that caused it, when known. |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "error",
"event_id": "evt_error_001",
"error": {
"type": "invalid_request_error",
"code": "unknown_parameter",
"message": "Unknown parameter: 'session.voice'.",
"param": "session.voice",
"client_event_id": "evt_invalid_001"
}
}
info
Schema: OpenAI.LiveServerEventLiveInfoEvent.
An informational notice about the Live session, such as the event permissions applied to a frontend data channel.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | The unique ID of the Live server event. |
client_event_id |
string |
No | The event_id of the client command associated with this server event, when supplied. |
type |
"info" |
Yes | The event type, always info. default: "info". |
code |
string |
Yes | A machine-readable code for the notice, such as data_channel_permissions. |
message |
string |
Yes | A human-readable explanation of the Live session notice. |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "info",
"event_id": "evt_info_001",
"code": "data_channel_permissions",
"message": "The frontend data channel is configured with restricted event permissions."
}
transport.dtmf.received
Schema: OpenAI.LiveServerEventLiveTransportDtmfReceived.
A SIP DTMF keypress received from the caller. Delivered only to sideband observers.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
type |
"transport.dtmf.received" |
Yes | default: "transport.dtmf.received". |
event_id |
string |
Yes | |
event |
string |
Yes | minLength: 1. maxLength: 1. pattern: "^[0-9A-D*#]$". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "transport.dtmf.received",
"event_id": "event_dtmf_1",
"event": "5"
}
transport.dtmf.sent
Schema: OpenAI.LiveServerEventLiveTransportDtmfSent.
A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to sideband observers; this is not a client command.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
type |
"transport.dtmf.sent" |
Yes | default: "transport.dtmf.sent". |
event_id |
string |
Yes | |
event |
string |
Yes | minLength: 1. maxLength: 1. pattern: "^[0-9A-D*#]$". |
client_event_id |
string |
No | The event_id of the client command, when supplied. |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "transport.dtmf.sent",
"event_id": "event_dtmf_2",
"event": "#"
}
transport.ringing
Schema: OpenAI.LiveServerEventLiveTransportRinging.
The outbound SIP provider leg is ringing or providing early media. Delivered only to sideband observers.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | |
session_id |
string |
Yes | The canonical Live session ID. |
type |
"transport.ringing" |
Yes | default: "transport.ringing". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "transport.ringing",
"event_id": "event_call_1",
"session_id": "live_u0_123"
}
transport.answered
Schema: OpenAI.LiveServerEventLiveTransportAnswered.
The outbound SIP provider leg answered and media is established. Delivered only to sideband observers.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | |
session_id |
string |
Yes | The canonical Live session ID. |
type |
"transport.answered" |
Yes | default: "transport.answered". |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "transport.answered",
"event_id": "event_call_2",
"session_id": "live_u0_123"
}
transport.failed
Schema: OpenAI.LiveServerEventLiveTransportFailed.
An asynchronous outbound SIP setup failure. Delivered only to sideband observers.
All of: OpenAI.LiveServerEvent.
| Property | Type | Required | Description |
|---|---|---|---|
event_id |
string |
Yes | |
session_id |
string |
Yes | The canonical Live session ID. |
type |
"transport.failed" |
Yes | default: "transport.failed". |
error |
OpenAI.LiveTransportCallError | Yes |
Required preview opt-ins: VoiceAgents=V1Preview.
Example event:
{
"type": "transport.failed",
"event_id": "event_call_4",
"session_id": "live_u0_123",
"error": {
"type": "call_error",
"code": "provider_invite_failed",
"message": "provider rejected the call",
"param": ""
}
}