Schema

Schema name: RealtimeServerEventInputAudioBufferDtmfEventReceived

{
  "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema)": {
    "kind": "HttpDeclTypeAlias",
    "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived",
    "docstring": "**SIP Only:** Returned when an DTMF event is received. A DTMF event is a message that\nrepresents a telephone keypad press (0–9, *, #, A–D). The `event` property\nis the keypad that the user press. The `received_at` is the UTC Unix Timestamp\nthat the server received the event.\n",
    "ident": "InputAudioBufferDtmfEventReceivedEvent",
    "type": {
      "kind": "HttpTypeObject",
      "members": [
        {
          "ident": "event"
        },
        {
          "ident": "received_at"
        },
        {
          "ident": "type"
        }
      ]
    },
    "childrenParentSchema": "object",
    "children": [
      "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) event",
      "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) received_at",
      "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) type"
    ]
  },
  "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) event": {
    "kind": "HttpDeclProperty",
    "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/event",
    "deprecated": false,
    "key": "event",
    "docstring": "The telephone keypad that was pressed by the user.",
    "type": {
      "kind": "HttpTypeString"
    },
    "optional": false,
    "nullable": false,
    "schemaType": "string",
    "children": []
  },
  "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) received_at": {
    "kind": "HttpDeclProperty",
    "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/received_at",
    "deprecated": false,
    "key": "received_at",
    "docstring": "UTC Unix Timestamp when DTMF Event was received by server.\n",
    "type": {
      "kind": "HttpTypeNumber"
    },
    "optional": false,
    "nullable": false,
    "schemaType": "integer",
    "children": []
  },
  "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) type": {
    "kind": "HttpDeclProperty",
    "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/type",
    "deprecated": false,
    "key": "type",
    "docstring": "The event type, must be `input_audio_buffer.dtmf_event_received`.",
    "type": {
      "kind": "HttpTypeUnion",
      "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/type",
      "types": [
        {
          "kind": "HttpTypeLiteral",
          "literal": "input_audio_buffer.dtmf_event_received"
        }
      ]
    },
    "optional": false,
    "nullable": false,
    "schemaType": "enum",
    "childrenParentSchema": "enum",
    "children": [
      "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) type > (member) 0"
    ]
  },
  "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) type > (member) 0": {
    "kind": "HttpDeclReference",
    "type": {
      "kind": "HttpTypeLiteral",
      "literal": "input_audio_buffer.dtmf_event_received"
    }
  }
}