Webex · Schema

ListAutoAttendantObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	A unique identifier for the auto attendant.
name	string	Unique name for the auto attendant.
locationName	string	Name of location for auto attendant.
locationId	string	ID of location for auto attendant.
phoneNumber	string	Auto attendant phone number. Either `phoneNumber` or `extension` is mandatory.
extension	string	Auto attendant extension. Either `phoneNumber` or `extension` is mandatory.
routingPrefix	string	Routing prefix of location.
esn	string	Routing prefix + extension of a person or workspace.
tollFreeNumber	boolean	Flag to indicate if auto attendant number is toll-free number.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ListAutoAttendantObject",
  "title": "ListAutoAttendantObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "locationName",
    "locationId",
    "tollFreeNumber"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw",
      "description": "A unique identifier for the auto attendant."
    },
    "name": {
      "type": "string",
      "example": "Main Line AA - Test",
      "description": "Unique name for the auto attendant."
    },
    "locationName": {
      "type": "string",
      "example": "Houston",
      "description": "Name of location for auto attendant."
    },
    "locationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzI2NDE1MA",
      "description": "ID of location for auto attendant."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+19705550028",
      "description": "Auto attendant phone number.  Either `phoneNumber` or `extension` is mandatory."
    },
    "extension": {
      "type": "string",
      "example": "1001",
      "description": "Auto attendant extension.  Either `phoneNumber` or `extension` is mandatory."
    },
    "routingPrefix": {
      "type": "string",
      "example": "1234",
      "description": "Routing prefix of location."
    },
    "esn": {
      "type": "string",
      "example": "12341001",
      "description": "Routing prefix + extension of a person or workspace."
    },
    "tollFreeNumber": {
      "type": "boolean",
      "description": "Flag to indicate if auto attendant number is toll-free number."
    }
  }
}