Webex · Schema

GetVirtualExtensionRangeListObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string ID of the virtual extension range.
name string Name of the virtual extension range. This is a unique name for the virtual extension range.
prefix string Prefix used for a virtual extension range. Prefix works in Standard and Enhanced modes. In Standard mode, it must be E.164 and it must be unique. In Enhanced mode, it can be E.164 or non-E.164.
level string Level of the virtual extension range. It can be either `ORGANIZATION` or `LOCATION`. * `ORGANIZATION` - Organization level. * `LOCATION` - Location level.
locationId string ID of the location to which the virtual extension range is assigned. This is set only for virtual extension ranges at the location level.
locationName string Name of the location to which the virtual extension range is assigned. This is set only for virtual extension ranges at the location level
View JSON Schema on GitHub

JSON Schema

webex-getvirtualextensionrangelistobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetVirtualExtensionRangeListObject",
  "title": "GetVirtualExtensionRangeListObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "prefix",
    "level"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OX1JBTkdFLzk0OThkMTE0LWMwMGMtNGZkNC1iMTk5LWU4ODQ2N2UwNzVkNw",
      "description": "ID of the virtual extension range."
    },
    "name": {
      "type": "string",
      "example": "SalesVirtualExtensionRange",
      "description": "Name of the virtual extension range. This is a unique name for the virtual extension range."
    },
    "prefix": {
      "type": "string",
      "example": "+1234",
      "description": "Prefix used for a virtual extension range. Prefix works in Standard and Enhanced modes. In Standard mode, it must be E.164 and it must be unique. In Enhanced mode, it can be E.164 or non-E.164."
    },
    "level": {
      "type": "string",
      "enum": [
        "ORGANIZATION",
        "LOCATION"
      ],
      "description": "Level of the virtual extension range. It can be either `ORGANIZATION` or `LOCATION`.\n * `ORGANIZATION` - Organization level.\n * `LOCATION` - Location level.\n"
    },
    "locationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
      "description": "ID of the location to which the virtual extension range is assigned. This is set only for virtual extension ranges at the location level."
    },
    "locationName": {
      "type": "string",
      "example": "Sales",
      "description": "Name of the location to which the virtual extension range is assigned. This is set only for virtual extension ranges at the location level"
    }
  }
}