Vapi · Schema

TransportConfigurationTwilio

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
provider string
timeout number The integer number of seconds that we should allow the phone to ring before assuming there is no answer. The default is `60` seconds and the maximum is `600` seconds. For some call flows, we will add
record boolean Whether to record the call. Can be `true` to record the phone call, or `false` to not. The default is `false`. @default false
recordingChannels string The number of channels in the final recording. Can be: `mono` or `dual`. The default is `mono`. `mono` records both legs of the call in a single channel of the recording file. `dual` records each leg
View JSON Schema on GitHub

JSON Schema

vapi-transportconfigurationtwilio-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TransportConfigurationTwilio",
  "title": "TransportConfigurationTwilio",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "enum": [
        "twilio"
      ]
    },
    "timeout": {
      "type": "number",
      "description": "The integer number of seconds that we should allow the phone to ring before assuming there is no answer.\nThe default is `60` seconds and the maximum is `600` seconds.\nFor some call flows, we will add a 5-second buffer to the timeout value you provide.\nFor this reason, a timeout value of 10 seconds could result in an actual timeout closer to 15 seconds.\nYou can set this to a short time, such as `15` seconds, to hang up before reaching an answering machine or voicemail.\n\n@default 60",
      "minimum": 1,
      "maximum": 600,
      "example": 60
    },
    "record": {
      "type": "boolean",
      "description": "Whether to record the call.\nCan be `true` to record the phone call, or `false` to not.\nThe default is `false`.\n\n@default false",
      "example": false
    },
    "recordingChannels": {
      "type": "string",
      "description": "The number of channels in the final recording.\nCan be: `mono` or `dual`.\nThe default is `mono`.\n`mono` records both legs of the call in a single channel of the recording file.\n`dual` records each leg to a separate channel of the recording file.\nThe first channel of a dual-channel recording contains the parent call and the second channel contains the child call.\n\n@default 'mono'",
      "enum": [
        "mono",
        "dual"
      ],
      "example": "mono"
    }
  },
  "required": [
    "provider"
  ]
}