ByoSipTrunkCredential

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ByoSipTrunkCredential",
  "title": "ByoSipTrunkCredential",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "description": "This can be used to bring your own SIP trunks or to connect to a Carrier.",
      "enum": [
        "byo-sip-trunk"
      ]
    },
    "id": {
      "type": "string",
      "description": "This is the unique identifier for the credential."
    },
    "orgId": {
      "type": "string",
      "description": "This is the unique identifier for the org that this credential belongs to."
    },
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the credential was created."
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the assistant was last updated."
    },
    "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"
        }
      ]
    }
  },
  "required": [
    "id",
    "orgId",
    "createdAt",
    "updatedAt",
    "gateways"
  ]
}