Vapi · Schema

PhoneNumberHookCallRinging

Artificial IntelligenceVoiceAgentsReal-TimeCPaaS

Properties

Name Type Description
on string This is the event to trigger the hook on
filters array Optional filters to decide when to trigger the hook. Currently supports filtering by caller country code.
do array Only the first action will be executed. Additional actions will be ignored.
View JSON Schema on GitHub

JSON Schema

vapi-phonenumberhookcallringing-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PhoneNumberHookCallRinging",
  "title": "PhoneNumberHookCallRinging",
  "type": "object",
  "properties": {
    "on": {
      "type": "string",
      "description": "This is the event to trigger the hook on",
      "enum": [
        "call.ringing"
      ],
      "maxLength": 1000
    },
    "filters": {
      "type": "array",
      "description": "Optional filters to decide when to trigger the hook. Currently supports filtering by caller country code.",
      "items": {
        "$ref": "#/components/schemas/PhoneNumberCallRingingHookFilter"
      }
    },
    "do": {
      "type": "array",
      "description": "Only the first action will be executed. Additional actions will be ignored.",
      "items": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/TransferPhoneNumberHookAction",
            "title": "TransferPhoneNumberHookAction"
          },
          {
            "$ref": "#/components/schemas/SayPhoneNumberHookAction",
            "title": "SayPhoneNumberHookAction"
          }
        ]
      }
    }
  },
  "required": [
    "on",
    "do"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/vapi-phonenumberhookcallringing"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.