Vapi · Schema

TransferFallbackPlan

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
message object This is the message the assistant will deliver to the customer if the transfer fails.
endCallEnabled boolean This controls what happens after delivering the failure message to the customer. - true: End the call after delivering the failure message (default) - false: Keep the assistant on the call to continue
View JSON Schema on GitHub

JSON Schema

vapi-transferfallbackplan-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TransferFallbackPlan",
  "title": "TransferFallbackPlan",
  "type": "object",
  "properties": {
    "message": {
      "description": "This is the message the assistant will deliver to the customer if the transfer fails.",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "$ref": "#/components/schemas/CustomMessage"
        }
      ]
    },
    "endCallEnabled": {
      "type": "boolean",
      "description": "This controls what happens after delivering the failure message to the customer.\n- true: End the call after delivering the failure message (default)\n- false: Keep the assistant on the call to continue handling the customer's request\n\n@default true",
      "default": true
    }
  },
  "required": [
    "message"
  ]
}