Webex · Schema

TrunkGet

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
name string A unique name for the trunk.
customer object Customer associated with the trunk.
location object Location associated with the trunk.
otgDtgId string Unique Outgoing and Destination trunk group associated with the dial plan.
linePort string The Line/Port identifies a device endpoint in standalone mode or a SIP URI public identity in IMS mode.
locationsUsingTrunk array Locations using trunk.
pilotUserId string User ID.
outboundProxy object 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 string User's authentication service information.
status object Device status.
errorCodes array Error codes.
responseStatus object Present partial error/warning status information included when the http response is 206.
dualIdentitySupportEnabled boolean Determines the behavior of the From and PAI headers on outbound calls.
trunkType object Trunk Type associated with the trunk.
deviceType string Device type assosiated with trunk.
address string FQDN or SRV address. Required to create a static certificate-based trunk.
domain string Domain name. Required to create a static certificate based trunk.
port number FQDN port. Required to create a static certificate-based trunk.
maxConcurrentCalls number Max Concurrent call. Required to create a static certificate based trunk.
isRestrictedToDedicatedInstance boolean Flag to indicate if the trunk is restricted to a dedicated instance.
pChargeInfoSupportPolicy object
View JSON Schema on GitHub

JSON Schema

webex-trunkget-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TrunkGet",
  "title": "TrunkGet",
  "type": "object",
  "required": [
    "name",
    "customer",
    "status",
    "trunkType",
    "port",
    "pChargeInfoSupportPolicy"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "trunkName",
      "description": "A unique name for the trunk."
    },
    "customer": {
      "$ref": "#/components/schemas/Customer",
      "description": "Customer associated with the trunk."
    },
    "location": {
      "$ref": "#/components/schemas/Location",
      "description": "Location associated with the trunk."
    },
    "otgDtgId": {
      "type": "string",
      "example": "lg1_sias10_cpapi12446_lgu",
      "description": "Unique Outgoing and Destination trunk group associated with the dial plan."
    },
    "linePort": {
      "type": "string",
      "example": "[email protected]",
      "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": "#/components/schemas/Location"
      },
      "description": "Locations using trunk."
    },
    "pilotUserId": {
      "type": "string",
      "example": "[email protected]",
      "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",
      "example": "lg1_sias10_cpapi12446_LGU",
      "description": "User's authentication service information."
    },
    "status": {
      "$ref": "#/components/schemas/DeviceStatus",
      "description": "Device status."
    },
    "errorCodes": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "errorCodes"
      },
      "description": "Error codes."
    },
    "responseStatus": {
      "$ref": "#/components/schemas/ResponseStatus",
      "description": "Present partial error/warning status information included when the http response is 206."
    },
    "dualIdentitySupportEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Determines the behavior of the From and PAI headers on outbound calls."
    },
    "trunkType": {
      "$ref": "#/components/schemas/TrunkType",
      "description": "Trunk Type associated with the trunk."
    },
    "deviceType": {
      "type": "string",
      "example": "Cisco Unified Border Element",
      "description": "Device type assosiated with trunk."
    },
    "address": {
      "type": "string",
      "example": "lgw1.london",
      "description": "FQDN or SRV address. Required to create a static certificate-based trunk."
    },
    "domain": {
      "type": "string",
      "example": "acme.corp",
      "description": "Domain name. Required to create a static certificate based trunk."
    },
    "port": {
      "type": "number",
      "example": 5000,
      "description": "FQDN port. Required to create a static certificate-based trunk."
    },
    "maxConcurrentCalls": {
      "type": "number",
      "example": 1000,
      "description": "Max Concurrent call. Required to create a static certificate based trunk."
    },
    "isRestrictedToDedicatedInstance": {
      "type": "boolean",
      "example": true,
      "description": "Flag to indicate if the trunk is restricted to a dedicated instance."
    },
    "pChargeInfoSupportPolicy": {
      "$ref": "#/components/schemas/PChargeInfoSupportPolicyType"
    }
  }
}