Vapi · Schema

ServerMessageToolCalls

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. "tool-calls" is sent to call a tool.
toolWithToolCallList	array	This is the list of tools calls that the model is requesting along with the original tool configuration.
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.
toolCallList	array	This is the list of tool calls that the model is requesting.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ServerMessageToolCalls",
  "title": "ServerMessageToolCalls",
  "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. \"tool-calls\" is sent to call a tool.",
      "enum": [
        "tool-calls"
      ]
    },
    "toolWithToolCallList": {
      "type": "array",
      "description": "This is the list of tools calls that the model is requesting along with the original tool configuration.",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/FunctionToolWithToolCall",
            "title": "FunctionToolWithToolCall"
          },
          {
            "$ref": "#/components/schemas/GhlToolWithToolCall",
            "title": "GhlToolWithToolCall"
          },
          {
            "$ref": "#/components/schemas/MakeToolWithToolCall",
            "title": "MakeToolWithToolCall"
          },
          {
            "$ref": "#/components/schemas/BashToolWithToolCall",
            "title": "BashToolWithToolCall"
          },
          {
            "$ref": "#/components/schemas/ComputerToolWithToolCall",
            "title": "ComputerToolWithToolCall"
          },
          {
            "$ref": "#/components/schemas/TextEditorToolWithToolCall",
            "title": "TextEditorToolWithToolCall"
          },
          {
            "$ref": "#/components/schemas/GoogleCalendarCreateEventToolWithToolCall",
            "title": "GoogleCalendarCreateEventToolWithToolCall"
          }
        ]
      }
    },
    "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"
        }
      ]
    },
    "toolCallList": {
      "description": "This is the list of tool calls that the model is requesting.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ToolCall"
      }
    }
  },
  "required": [
    "toolWithToolCallList",
    "toolCallList"
  ]
}