Webex · Schema

LocationAssignedNumber

Details of a assigned phone number/extension in the user's location.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
phoneNumber	string	The phone number in E.164 format.
extension	string	The extension.
state	string	* `ACTIVE` - Phone number is in the active state. * `INACTIVE` - Phone number is in the inactive state.
phoneNumberType	string	* `PRIMARY` - A direct phone number. * `ALTERNATE` - An alternate phone number. * `FAX` - A FAX number.
tollFreeNumber	boolean	Indicate if the number is toll free.
owner	object	The owner details.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LocationAssignedNumber",
  "title": "LocationAssignedNumber",
  "type": "object",
  "description": "Details of a assigned phone number/extension in the user's location.",
  "properties": {
    "phoneNumber": {
      "type": "string",
      "description": "The phone number in E.164 format."
    },
    "extension": {
      "type": "string",
      "description": "The extension."
    },
    "state": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ],
      "description": " * `ACTIVE` - Phone number is in the active state.\n * `INACTIVE` - Phone number is in the inactive state.\n"
    },
    "phoneNumberType": {
      "type": "string",
      "enum": [
        "PRIMARY",
        "ALTERNATE",
        "FAX"
      ],
      "description": "* `PRIMARY` - A direct phone number.\n* `ALTERNATE` - An alternate phone number.\n* `FAX` - A FAX number.\n"
    },
    "tollFreeNumber": {
      "type": "boolean",
      "description": "Indicate if the number is toll free."
    },
    "owner": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "$ref": "#/components/schemas/NumberOwnerType"
        },
        "firstName": {
          "type": "string",
          "example": "Test",
          "description": "First name of the phone number/extension owner. This field is present only for type `PEOPLE` and `VIRTUAL_LINE`."
        },
        "lastName": {
          "type": "string",
          "example": "Person",
          "description": "Last name of the phone number/extension owner. This field is present only for type `PEOPLE` and `VIRTUAL_LINE`."
        },
        "displayName": {
          "type": "string",
          "example": "Test",
          "description": "Display Name of the phone number/extension owner."
        }
      },
      "description": "The owner details."
    }
  }
}