Vonage · Schema

CreateCallRequest

CommunicationMessagingTelecommunicationsVideo ConferencingVoiceSMSVerification

Properties

Name Type Description
to array
from object
ncco array Vonage Call Control Object instructions.
record boolean Record the call.
answer_url array Answer webhook URL.
event_url array Event webhook URL.
View JSON Schema on GitHub

JSON Schema

vonage-createcallrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateCallRequest",
  "title": "CreateCallRequest",
  "type": "object",
  "required": [
    "to",
    "from",
    "ncco"
  ],
  "properties": {
    "to": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "phone",
              "sip",
              "websocket",
              "vbc"
            ]
          },
          "number": {
            "type": "string"
          }
        }
      }
    },
    "from": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "number": {
          "type": "string"
        }
      }
    },
    "ncco": {
      "type": "array",
      "description": "Vonage Call Control Object instructions.",
      "items": {
        "type": "object"
      }
    },
    "record": {
      "type": "boolean",
      "description": "Record the call."
    },
    "answer_url": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Answer webhook URL."
    },
    "event_url": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Event webhook URL."
    }
  }
}