Webex · Schema

ConnectionResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique identifier for the connection.
displayName string The display name of the PSTN connection.
pstnServices array The PSTN services available for this connection.
pstnConnectionType object The PSTN connection type set for the location.
routeType object Premise route type. This is required if connection type is LOCAL_GATEWAY.
routeId string Premise route ID. This refers to either a Trunk ID or a Route Group ID. This field is optional but required if the connection type is LOCAL_GATEWAY.
View JSON Schema on GitHub

JSON Schema

webex-connectionresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConnectionResponse",
  "title": "ConnectionResponse",
  "type": "object",
  "required": [
    "id",
    "pstnConnectionType"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NBTExfUElDS1VQL1kyRnNiRkJwWTJ0MWNERT0",
      "description": "A unique identifier for the connection."
    },
    "displayName": {
      "type": "string",
      "example": "Premises-based PSTN",
      "description": "The display name of the PSTN connection."
    },
    "pstnServices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PSTNServiceType"
      },
      "description": "The PSTN services available for this connection."
    },
    "pstnConnectionType": {
      "$ref": "#/components/schemas/PSTNType",
      "description": "The PSTN connection type set for the location."
    },
    "routeType": {
      "$ref": "#/components/schemas/PremiseRouteType",
      "description": "Premise route type. This is required if connection type is LOCAL_GATEWAY."
    },
    "routeId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1RSVU5LL2Y1YTU4MzAwLTVmZTYtNGNjMS1hODA3LTRlN2E5OTMzN2Q0ZA",
      "description": "Premise route ID. This refers to either a Trunk ID or a Route Group ID. This field is optional but required if the connection type is LOCAL_GATEWAY."
    }
  }
}