Vapi · Schema

CreateWebCustomerDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
numberE164CheckEnabled	boolean	This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it. Use cases: - `false`: To allow non-E164 numbe
extension	string	This is the extension that will be dialed after the call is answered.
assistantOverrides	object	These are the variable values that will be used to replace template variables in the assistant messages. Only variable substitution is supported in web chat - other assistant properties cannot be over
number	string	This is the number of the customer.
sipUri	string	This is the SIP URI of the customer.
name	string	This is the name of the customer. This is just for your own reference. For SIP inbound calls, this is extracted from the `From` SIP header with format `"Display Name" `.
email	string	This is the email of the customer.
externalId	string	This is the external ID of the customer.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateWebCustomerDTO",
  "title": "CreateWebCustomerDTO",
  "type": "object",
  "properties": {
    "numberE164CheckEnabled": {
      "type": "boolean",
      "description": "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.\n\nUse cases:\n- `false`: To allow non-E164 numbers like `+001234567890`, `1234`, or `abc`. This is useful for dialing out to non-E164 numbers on your SIP trunks.\n- `true` (default): To allow only E164 numbers like `+14155551234`. This is standard for PSTN calls.\n\nIf `false`, the `number` is still required to only contain alphanumeric characters (regex: `/^\\+?[a-zA-Z0-9]+$/`).\n\n@default true (E164 check is enabled)",
      "default": true
    },
    "extension": {
      "type": "string",
      "description": "This is the extension that will be dialed after the call is answered.",
      "maxLength": 10,
      "example": null
    },
    "assistantOverrides": {
      "description": "These are the variable values that will be used to replace template variables in the assistant messages.\nOnly variable substitution is supported in web chat - other assistant properties cannot be overridden.",
      "allOf": [
        {
          "$ref": "#/components/schemas/ChatAssistantOverrides"
        }
      ]
    },
    "number": {
      "type": "string",
      "description": "This is the number of the customer.",
      "minLength": 3,
      "maxLength": 40
    },
    "sipUri": {
      "type": "string",
      "description": "This is the SIP URI of the customer."
    },
    "name": {
      "type": "string",
      "description": "This is the name of the customer. This is just for your own reference.\n\nFor SIP inbound calls, this is extracted from the `From` SIP header with format `\"Display Name\" <sip:username@domain>`.",
      "maxLength": 40
    },
    "email": {
      "type": "string",
      "description": "This is the email of the customer.",
      "maxLength": 40
    },
    "externalId": {
      "type": "string",
      "description": "This is the external ID of the customer.",
      "maxLength": 40
    }
  }
}