Vapi · Schema

CallHookFilter

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
type string This is the type of filter - currently only "oneOf" is supported
key string This is the key to filter on (e.g. "call.endedReason")
oneOf array This is the array of possible values to match against
View JSON Schema on GitHub

JSON Schema

vapi-callhookfilter-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CallHookFilter",
  "title": "CallHookFilter",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "This is the type of filter - currently only \"oneOf\" is supported",
      "enum": [
        "oneOf"
      ],
      "maxLength": 1000
    },
    "key": {
      "type": "string",
      "description": "This is the key to filter on (e.g. \"call.endedReason\")",
      "maxLength": 1000
    },
    "oneOf": {
      "description": "This is the array of possible values to match against",
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 1000
      }
    }
  },
  "required": [
    "type",
    "key",
    "oneOf"
  ]
}