TrunkGet

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/webex/main/json-schema/webex-trunk-get-schema.json",
  "title": "TrunkGet",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/webex-call-routing-api-openapi.yml#/components/schemas/TrunkGet",
  "type": "object",
  "required": [
    "name",
    "customer",
    "status",
    "trunkType",
    "port",
    "pChargeInfoSupportPolicy"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "A unique name for the trunk."
    },
    "customer": {
      "$ref": "#/$defs/Customer",
      "description": "Customer associated with the trunk."
    },
    "location": {
      "$ref": "#/$defs/Location",
      "description": "Location associated with the trunk."
    },
    "otgDtgId": {
      "type": "string",
      "description": "Unique Outgoing and Destination trunk group associated with the dial plan."
    },
    "linePort": {
      "type": "string",
      "description": "The Line/Port identifies a device endpoint in standalone mode or a SIP URI public identity in IMS mode."
    },
    "locationsUsingTrunk": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Location"
      },
      "description": "Locations using trunk."
    },
    "pilotUserId": {
      "type": "string",
      "description": "User ID."
    },
    "outboundProxy": {
      "type": "object",
      "properties": {},
      "description": "Contains the body of the HTTP response received following the request to Console API and will not be set if the response has no body."
    },
    "sipAuthenticationUserName": {
      "type": "string",
      "description": "User's authentication service information."
    },
    "status": {
      "$ref": "#/$defs/DeviceStatus",
      "description": "Device status."
    },
    "errorCodes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Error codes."
    },
    "responseStatus": {
      "$ref": "#/$defs/ResponseStatus",
      "description": "Present partial error/warning status information included when the http response is 206."
    },
    "dualIdentitySupportEnabled": {
      "type": "boolean",
      "description": "Determines the behavior of the From and PAI headers on outbound calls."
    },
    "trunkType": {
      "$ref": "#/$defs/TrunkType",
      "description": "Trunk Type associated with the trunk."
    },
    "deviceType": {
      "type": "string",
      "description": "Device type assosiated with trunk."
    },
    "address": {
      "type": "string",
      "description": "FQDN or SRV address. Required to create a static certificate-based trunk."
    },
    "domain": {
      "type": "string",
      "description": "Domain name. Required to create a static certificate based trunk."
    },
    "port": {
      "type": "number",
      "description": "FQDN port. Required to create a static certificate-based trunk."
    },
    "maxConcurrentCalls": {
      "type": "number",
      "description": "Max Concurrent call. Required to create a static certificate based trunk."
    },
    "isRestrictedToDedicatedInstance": {
      "type": "boolean",
      "description": "Flag to indicate if the trunk is restricted to a dedicated instance."
    },
    "pChargeInfoSupportPolicy": {
      "$ref": "#/$defs/PChargeInfoSupportPolicyType"
    }
  },
  "$defs": {
    "Customer": {
      "type": "object",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "ID of the customer/organization."
        },
        "name": {
          "type": "string",
          "description": "Name of the customer/organization."
        }
      }
    },
    "DeviceStatus": {
      "type": "string",
      "enum": [
        "ONLINE",
        "OFFLINE",
        "UNKNOWN"
      ],
      "description": " * `ONLINE` - Device is online\n * `OFFLINE` - Device is offline\n * `UNKNOWN` - Unknown. Default\n"
    },
    "Location": {
      "type": "object",
      "description": "Location associated with the hot desking member.",
      "required": [
        "id",
        "name"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier for the location."
        },
        "name": {
          "type": "string",
          "description": "Name of the location."
        }
      }
    },
    "PChargeInfoSupportPolicyType": {
      "type": "string",
      "enum": [
        "DISABLED",
        "ASSERTED_IDENTITY",
        "CONFIGURABLE_CHARGE_NUMBER"
      ],
      "description": " * `DISABLED` - The P-Charge-Info header support policy is disabled.\n * `ASSERTED_IDENTITY` - The P-Charge-Info header is always included in outbound PSTN calls using Webex Calling primary number or location’s main number.\n * `CONFIGURABLE_CHARGE_NUMBER` - The P-Charge-Info header is included in outbound PSTN calls using the originating or redirecting Webex Calling entity's location charge number if set, else the entity's primary number if set and not toll-free, else the main number of the entity's location if set and not toll-free. If none of these are set or not toll-free, it uses the same number as the ASSERTED_IDENTITY option.\n"
    },
    "ResponseStatus": {
      "type": "object",
      "required": [
        "code",
        "type",
        "summaryEnglish",
        "detail",
        "trackingId"
      ],
      "properties": {
        "code": {
          "type": "number",
          "description": "Error Code. 25013 for error retrieving the outbound proxy. 25014 for error retrieving the status"
        },
        "type": {
          "$ref": "#/$defs/ResponseStatusType",
          "description": "Status type."
        },
        "summaryEnglish": {
          "type": "string",
          "description": "Error summary in English."
        },
        "detail": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Error Details."
        },
        "trackingId": {
          "type": "string",
          "description": "Error Tracking ID."
        }
      }
    },
    "ResponseStatusType": {
      "type": "string",
      "enum": [
        "ERROR",
        "WARNING"
      ],
      "description": " * `ERROR` - Error\n * `WARNING` - Warning\n"
    },
    "TrunkType": {
      "type": "string",
      "enum": [
        "REGISTERING",
        "CERTIFICATE_BASED"
      ],
      "description": " * `REGISTERING` - For Cisco CUBE Local Gateway.\n * `CERTIFICATE_BASED` - For Cisco Unified Border Element, Oracle ACME Session Border Controller, AudioCodes Session Border Controller, Ribbon Session Border Controller.\n"
    }
  }
}