Webex · Schema

DialPlanDTO

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
organizationId	string	ID of the contact center organization. It is required to define for the following operations - All bulk save operations
id	string	ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
version	integer	The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
name	string	Enter the name for the dial plan.
description	string	A short description of the dial plan.
regularExpression	string	A regular expression specifies the format of the phone number and the characters that you can use while dialing a number.
prefix	string	(Optional) Enter a prefix that the system automatically adds to the phone number that the agent enters. For example, digit 1 for long-distance calls within the United States.
strippedChars	string	Enter the characters that system removes from the phone number that the agent dials.For example, left and right parentheses, space, and hyphen.
active	boolean	Specify whether the dial plan is active or not
systemDefault	boolean	Indicates whether the created resource is system created or not
createdTime	integer	Creation time(in epoch millis) of this resource.
lastUpdatedTime	integer	Time(in epoch millis) when this resource was last updated.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DialPlanDTO",
  "title": "DialPlanDTO",
  "required": [
    "active",
    "name",
    "regularExpression"
  ],
  "type": "object",
  "properties": {
    "organizationId": {
      "maxLength": 36,
      "minLength": 32,
      "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
      "type": "string",
      "description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
      "format": "uuid",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "id": {
      "type": "string",
      "description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
      "example": "93912f11-6017-404b-bf14-5331890b1797"
    },
    "version": {
      "type": "integer",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "format": "int32",
      "example": 1
    },
    "name": {
      "maxLength": 80,
      "minLength": 0,
      "pattern": "^[a-zA-Z0-9,_\\-\\s]*$",
      "type": "string",
      "description": "Enter the name for the dial plan.",
      "example": "Standard dial plan"
    },
    "description": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "A short description of the dial plan.",
      "example": "Required for transferring calls to Queues"
    },
    "regularExpression": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "A regular expression specifies the format of the phone number and the characters that you can use while dialing a number.",
      "example": "[0-9a-zA-Z]"
    },
    "prefix": {
      "maxLength": 50,
      "minLength": 0,
      "type": "string",
      "description": "(Optional) Enter a prefix that the system automatically adds to the phone number that the agent enters. For example, digit 1 for long-distance calls within the United States.",
      "example": "1"
    },
    "strippedChars": {
      "maxLength": 128,
      "minLength": 0,
      "type": "string",
      "description": "Enter the characters that system removes from the phone number that the agent dials.For example, left and right parentheses, space, and hyphen.",
      "example": "()"
    },
    "active": {
      "type": "boolean",
      "description": "Specify whether the dial plan is active or not",
      "example": true
    },
    "systemDefault": {
      "type": "boolean",
      "description": "Indicates whether the created resource is system created or not",
      "example": false
    },
    "createdTime": {
      "type": "integer",
      "description": "Creation time(in epoch millis) of this resource.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    },
    "lastUpdatedTime": {
      "type": "integer",
      "description": "Time(in epoch millis) when this resource was last updated.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    }
  }
}