Webex · Schema

ListLocationObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	A unique identifier for the location.
name	string	The name of the location.
outsideDialDigit	string	Must dial to reach an outside line, default is None.
enforceOutsideDialDigit	boolean	True when enforcing outside dial digit at location level to make PSTN calls.
routingPrefix	string	Must dial a prefix when calling between locations having the same extension within the same location.
callingLineId	object	Location calling line information.
e911SetupRequired	boolean	True if E911 setup is required.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListLocationObject",
  "title": "ListLocationObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "callingLineId",
    "e911SetupRequired"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzljYTNhZmQ3LTE5MjYtNGQ0ZS05ZDA3LTk5ZDJjMGU4OGFhMA",
      "description": "A unique identifier for the location."
    },
    "name": {
      "type": "string",
      "example": "'Denver'",
      "description": "The name of the location."
    },
    "outsideDialDigit": {
      "type": "string",
      "example": "'12'",
      "description": "Must dial to reach an outside line, default is None."
    },
    "enforceOutsideDialDigit": {
      "type": "boolean",
      "example": true,
      "description": "True when enforcing outside dial digit at location level to make PSTN calls."
    },
    "routingPrefix": {
      "type": "string",
      "example": "'2'",
      "description": "Must dial a prefix when calling between locations having the same extension within the same location."
    },
    "callingLineId": {
      "type": "object",
      "required": [
        "phoneNumber"
      ],
      "properties": {
        "name": {
          "type": "string",
          "example": "'Denver Incoming'",
          "description": "Group calling line ID name. By default the Org name."
        },
        "phoneNumber": {
          "type": "string",
          "example": "+12145555698",
          "description": "Directory Number / Main number in E.164 Format."
        }
      },
      "description": "Location calling line information."
    },
    "e911SetupRequired": {
      "type": "boolean",
      "example": true,
      "description": "True if E911 setup is required."
    }
  }
}