Vapi · JSON Structure

Vapi Campaign Structure

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

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

Properties

status endedReason name assistantId workflowId squadId phoneNumberId dialPlan schedulePlan customers id orgId createdAt updatedAt calls callsCounterScheduled callsCounterQueued callsCounterInProgress callsCounterEndedVoicemail callsCounterEnded

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/draft/2020-12/schema",
  "name": "Campaign",
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "endedReason": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "assistantId": {
      "type": "string"
    },
    "workflowId": {
      "type": "string"
    },
    "squadId": {
      "type": "string"
    },
    "phoneNumberId": {
      "type": "string"
    },
    "dialPlan": {
      "type": "array"
    },
    "schedulePlan": {
      "type": "string"
    },
    "customers": {
      "type": "array"
    },
    "id": {
      "type": "string"
    },
    "orgId": {
      "type": "string"
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    },
    "calls": {
      "type": "object"
    },
    "callsCounterScheduled": {
      "type": "number"
    },
    "callsCounterQueued": {
      "type": "number"
    },
    "callsCounterInProgress": {
      "type": "number"
    },
    "callsCounterEndedVoicemail": {
      "type": "number"
    },
    "callsCounterEnded": {
      "type": "number"
    }
  }
}