Vapi · JSON Structure

Vapi Phone Number Structure

Type: object Properties: 16
AIVoice AIVoice AgentsConversational AITelephonyReal-TimeTranscriptionText-to-SpeechLLMAgentsMCP

ByoPhoneNumber is a JSON Structure definition published by Vapi, describing 16 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

fallbackDestination hooks provider numberE164CheckEnabled id orgId createdAt updatedAt status name assistantId workflowId squadId server number credentialId

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/draft/2020-12/schema",
  "name": "ByoPhoneNumber",
  "type": "object",
  "properties": {
    "fallbackDestination": {
      "type": "string"
    },
    "hooks": {
      "type": "array"
    },
    "provider": {
      "type": "string"
    },
    "numberE164CheckEnabled": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "orgId": {
      "type": "string"
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "assistantId": {
      "type": "string"
    },
    "workflowId": {
      "type": "string"
    },
    "squadId": {
      "type": "string"
    },
    "server": {
      "type": "string"
    },
    "number": {
      "type": "string"
    },
    "credentialId": {
      "type": "string"
    }
  }
}