Vapi · Schema

ServerMessageResponseTransferDestinationRequest

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
destination	object	This is the destination you'd like the call to be transferred to.
message	object	This is the message that will be spoken to the user as the tool is running.
error	string	This is the error message if the transfer should not be made.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ServerMessageResponseTransferDestinationRequest",
  "title": "ServerMessageResponseTransferDestinationRequest",
  "type": "object",
  "properties": {
    "destination": {
      "description": "This is the destination you'd like the call to be transferred to.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/TransferDestinationAssistant",
          "title": "Assistant"
        },
        {
          "$ref": "#/components/schemas/TransferDestinationNumber",
          "title": "Number"
        },
        {
          "$ref": "#/components/schemas/TransferDestinationSip",
          "title": "Sip"
        }
      ]
    },
    "message": {
      "description": "This is the message that will be spoken to the user as the tool is running.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/ToolMessageStart",
          "title": "ToolMessageStart"
        },
        {
          "$ref": "#/components/schemas/ToolMessageComplete",
          "title": "ToolMessageComplete"
        },
        {
          "$ref": "#/components/schemas/ToolMessageFailed",
          "title": "ToolMessageFailed"
        },
        {
          "$ref": "#/components/schemas/ToolMessageDelayed",
          "title": "ToolMessageDelayed"
        }
      ]
    },
    "error": {
      "type": "string",
      "description": "This is the error message if the transfer should not be made."
    }
  }
}