Vapi · Schema

UpdateByoSipTrunkCredentialDTO

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
name string This is the name of credential. This is just for your reference.
gateways array This is the list of SIP trunk's gateways.
outboundAuthenticationPlan object This can be used to configure the outbound authentication if required by the SIP trunk.
outboundLeadingPlusEnabled boolean This ensures the outbound origination attempts have a leading plus. Defaults to false to match conventional telecom behavior. Usage: - Vonage/Twilio requires leading plus for all outbound calls. Set t
techPrefix string This can be used to configure the tech prefix on outbound calls. This is an advanced property.
sipDiversionHeader string This can be used to enable the SIP diversion header for authenticating the calling number if the SIP trunk supports it. This is an advanced property.
sbcConfiguration object This is an advanced configuration for enterprise deployments. This uses the onprem SBC to trunk into the SIP trunk's `gateways`, rather than the managed SBC provided by Vapi.
View JSON Schema on GitHub

JSON Schema

vapi-updatebyosiptrunkcredentialdto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateByoSipTrunkCredentialDTO",
  "title": "UpdateByoSipTrunkCredentialDTO",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "This is the name of credential. This is just for your reference.",
      "minLength": 1,
      "maxLength": 40
    },
    "gateways": {
      "description": "This is the list of SIP trunk's gateways.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SipTrunkGateway"
      }
    },
    "outboundAuthenticationPlan": {
      "description": "This can be used to configure the outbound authentication if required by the SIP trunk.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SipTrunkOutboundAuthenticationPlan"
        }
      ]
    },
    "outboundLeadingPlusEnabled": {
      "type": "boolean",
      "description": "This ensures the outbound origination attempts have a leading plus. Defaults to false to match conventional telecom behavior.\n\nUsage:\n- Vonage/Twilio requires leading plus for all outbound calls. Set this to true.\n\n@default false"
    },
    "techPrefix": {
      "type": "string",
      "description": "This can be used to configure the tech prefix on outbound calls. This is an advanced property.",
      "maxLength": 10000
    },
    "sipDiversionHeader": {
      "type": "string",
      "description": "This can be used to enable the SIP diversion header for authenticating the calling number if the SIP trunk supports it. This is an advanced property.",
      "maxLength": 10000
    },
    "sbcConfiguration": {
      "description": "This is an advanced configuration for enterprise deployments. This uses the onprem SBC to trunk into the SIP trunk's `gateways`, rather than the managed SBC provided by Vapi.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SbcConfiguration"
        }
      ]
    }
  }
}