Vapi · Schema

ServerMessageSpeechUpdate

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
phoneNumber	object	This is the phone number that the message is associated with.
type	string	This is the type of the message. "speech-update" is sent whenever assistant or user start or stop speaking.
status	string	This is the status of the speech update.
role	string	This is the role which the speech update is for.
turn	number	This is the turn number of the speech update (0-indexed).
timestamp	number	This is the timestamp of the message.
artifact	object	This is a live version of the `call.artifact`. This matches what is stored on `call.artifact` after the call.
assistant	object	This is the assistant that the message is associated with.
customer	object	This is the customer that the message is associated with.
call	object	This is the call that the message is associated with.
chat	object	This is the chat object.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ServerMessageSpeechUpdate",
  "title": "ServerMessageSpeechUpdate",
  "type": "object",
  "properties": {
    "phoneNumber": {
      "description": "This is the phone number that the message is associated with.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/CreateByoPhoneNumberDTO",
          "title": "ByoPhoneNumber"
        },
        {
          "$ref": "#/components/schemas/CreateTwilioPhoneNumberDTO",
          "title": "TwilioPhoneNumber"
        },
        {
          "$ref": "#/components/schemas/CreateVonagePhoneNumberDTO",
          "title": "VonagePhoneNumber"
        },
        {
          "$ref": "#/components/schemas/CreateVapiPhoneNumberDTO",
          "title": "VapiPhoneNumber"
        },
        {
          "$ref": "#/components/schemas/CreateTelnyxPhoneNumberDTO",
          "title": "TelnyxPhoneNumber"
        }
      ]
    },
    "type": {
      "type": "string",
      "description": "This is the type of the message. \"speech-update\" is sent whenever assistant or user start or stop speaking.",
      "enum": [
        "speech-update"
      ]
    },
    "status": {
      "type": "string",
      "description": "This is the status of the speech update.",
      "enum": [
        "started",
        "stopped"
      ]
    },
    "role": {
      "type": "string",
      "description": "This is the role which the speech update is for.",
      "enum": [
        "assistant",
        "user"
      ]
    },
    "turn": {
      "type": "number",
      "description": "This is the turn number of the speech update (0-indexed)."
    },
    "timestamp": {
      "type": "number",
      "description": "This is the timestamp of the message."
    },
    "artifact": {
      "description": "This is a live version of the `call.artifact`.\n\nThis matches what is stored on `call.artifact` after the call.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Artifact"
        }
      ]
    },
    "assistant": {
      "description": "This is the assistant that the message is associated with.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateAssistantDTO"
        }
      ]
    },
    "customer": {
      "description": "This is the customer that the message is associated with.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CreateCustomerDTO"
        }
      ]
    },
    "call": {
      "description": "This is the call that the message is associated with.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Call"
        }
      ]
    },
    "chat": {
      "description": "This is the chat object.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Chat"
        }
      ]
    }
  },
  "required": [
    "type",
    "status",
    "role"
  ]
}