Vapi · Schema

CallBatchResponse

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
subscriptionLimits object Subscription limits at the end of this batch
results array This is the list of calls that were created.
errors array This is the list of calls that failed to be created.
View JSON Schema on GitHub

JSON Schema

vapi-callbatchresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CallBatchResponse",
  "title": "CallBatchResponse",
  "type": "object",
  "properties": {
    "subscriptionLimits": {
      "description": "Subscription limits at the end of this batch",
      "allOf": [
        {
          "$ref": "#/components/schemas/SubscriptionLimits"
        }
      ]
    },
    "results": {
      "description": "This is the list of calls that were created.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Call"
      }
    },
    "errors": {
      "description": "This is the list of calls that failed to be created.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CallBatchError"
      }
    }
  },
  "required": [
    "results",
    "errors"
  ]
}