Webex · Schema

LocationDigitPatternObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	A unique identifier for the digit pattern.
name	string	A unique name for the digit pattern.
pattern	string	The digit pattern to be matched with the input number.
action	string	Action to be performed on the input number that matches the digit pattern. * `ALLOW` - Allow the designated call type. * `BLOCK` - Block the designated call type. * `AUTH_CODE` - Allow only via Author
transferEnabled	boolean	If `true`, allows transfer and forwarding for the call type.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LocationDigitPatternObject",
  "title": "LocationDigitPatternObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "pattern",
    "action",
    "transferEnabled"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3",
      "description": "A unique identifier for the digit pattern."
    },
    "name": {
      "type": "string",
      "example": "DigitPattern1",
      "description": "A unique name for the digit pattern."
    },
    "pattern": {
      "type": "string",
      "example": "1XXX",
      "description": "The digit pattern to be matched with the input number."
    },
    "action": {
      "type": "string",
      "enum": [
        "ALLOW",
        "BLOCK",
        "AUTH_CODE",
        "TRANSFER_NUMBER_1",
        "TRANSFER_NUMBER_2",
        "TRANSFER_NUMBER_3"
      ],
      "description": "Action to be performed on the input number that matches the digit pattern.\n * `ALLOW` - Allow the designated call type.\n * `BLOCK` - Block the designated call type.\n * `AUTH_CODE` - Allow only via Authorization Code.\n * `TRANSFER_NUMBER_1` - Transfer to Auto Transfer Number 1. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_2` - Transfer to Auto Transfer Number 2. The answering person can then approve the call and send it through or reject the call.\n * `TRANSFER_NUMBER_3` - Transfer to Auto Transfer Number 3. The answering person can then approve the call and send it through or reject the call.\n"
    },
    "transferEnabled": {
      "type": "boolean",
      "example": true,
      "description": "If `true`, allows transfer and forwarding for the call type."
    }
  }
}