Vapi · Schema

SipTrunkOutboundAuthenticationPlan

AIVoiceAgentsRealtimeCPaaS

Properties

Name Type Description
authPassword string This is not returned in the API.
authUsername string
sipRegisterPlan object This can be used to configure if SIP register is required by the SIP trunk. If not provided, no SIP registration will be attempted.
View JSON Schema on GitHub

JSON Schema

vapi-siptrunkoutboundauthenticationplan-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SipTrunkOutboundAuthenticationPlan",
  "title": "SipTrunkOutboundAuthenticationPlan",
  "type": "object",
  "properties": {
    "authPassword": {
      "type": "string",
      "description": "This is not returned in the API."
    },
    "authUsername": {
      "type": "string"
    },
    "sipRegisterPlan": {
      "description": "This can be used to configure if SIP register is required by the SIP trunk. If not provided, no SIP registration will be attempted.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SipTrunkOutboundSipRegisterPlan"
        }
      ]
    }
  }
}