Webex · Schema
DialledNumberEntryPointDTO
CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing
Properties
| Name | Type | Description |
|---|---|---|
| organizationId | string | ID of the contact center organization. This field is required for 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. |
| dialledNumber | string | The dialed number(DN) used to map to entry points. |
| extension | string | The extension used to map to entry points. |
| routingPrefix | string | The routing prefix is mapped to a location and can be prefixed with an extension |
| esn | string | The esn is routing prefix with extension |
| routePointId | string | The identifier of a route point of WxC which is similar to entry point of WxCC |
| entryPointId | string | The identifier of an entry point to which you want to map the DN. |
| entryPointName | string | The entryPoint name of the entryPointId. |
| defaultAni | boolean | The default dial number for the tenant to make outdial calls. The default dial number is displayed in the customer's caller ID, if an agent does not select a specific outdial ANI (Automatic Number Ide |
| location | string | The name of the location as configured on Webex Calling(applicable only for Webex Calling). |
| regionId | string | Specify the telephony region id. You can pass id for one of these regions: US (USA), CA (Canada), MX (Mexico), AU (Australia), SG (Singapore), GB (United Kingdom), DE (Germany) You can retrieve it by |
| createdTime | integer | This is the created time of the entity. |
| lastUpdatedTime | integer | This is the updated time of the entity. |
| dialledNumberDigits | string |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/DialledNumberEntryPointDTO",
"title": "DialledNumberEntryPointDTO",
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"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}$"
},
"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",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"dialledNumber": {
"type": "string",
"description": "The dialed number(DN) used to map to entry points.",
"example": "+1-1234567890",
"maxLength": 20,
"minLength": 0,
"pattern": "^\\+{0,1}\\d+[\\d.\\-]*$"
},
"extension": {
"type": "string",
"description": "The extension used to map to entry points.",
"example": 1234,
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{2,10}$"
},
"routingPrefix": {
"type": "string",
"description": "The routing prefix is mapped to a location and can be prefixed with an extension",
"example": 91,
"maxLength": 7,
"minLength": 0,
"pattern": "^\\d{2,7}$"
},
"esn": {
"type": "string",
"description": "The esn is routing prefix with extension",
"example": 919876,
"maxLength": 17,
"minLength": 0,
"pattern": "^\\d{2,17}$"
},
"routePointId": {
"type": "string",
"description": "The identifier of a route point of WxC which is similar to entry point of WxCC",
"example": "7cbd4aad-0c3b-4de4-a15a-33cf05b9bf8j"
},
"entryPointId": {
"type": "string",
"description": "The identifier of an entry point to which you want to map the DN.",
"example": "7cbd4aad-0c3b-4de4-a15a-33cf05b9bf8j"
},
"entryPointName": {
"type": "string",
"description": "The entryPoint name of the entryPointId.",
"example": "Entry-Point"
},
"defaultAni": {
"type": "boolean",
"description": "The default dial number for the tenant to make outdial calls. The default dial number is displayed in the customer's caller ID, if an agent does not select a specific outdial ANI (Automatic Number Identification) for an outdial call.\n\nA default value is automatically set once and entry point mapping is created",
"example": true
},
"location": {
"type": "string",
"description": "The name of the location as configured on Webex Calling(applicable only for Webex Calling).",
"example": "7cbd4aad-0c3b-4de4-a15a-33cf05b9bf8j"
},
"regionId": {
"type": "string",
"description": "Specify the telephony region id.\n\nYou can pass id for one of these regions:\n\nUS (USA), CA (Canada), MX (Mexico), AU (Australia), SG (Singapore), GB (United Kingdom), DE (Germany)\n\nYou can retrieve it by calling /api/global/telephony-region API.",
"example": "7cbd4aad-0c3b-4de4-a15a-33cf05b9bf8j"
},
"createdTime": {
"type": "integer",
"format": "int64",
"description": "This is the created time of the entity."
},
"lastUpdatedTime": {
"type": "integer",
"format": "int64",
"description": "This is the updated time of the entity."
},
"dialledNumberDigits": {
"type": "string"
}
},
"required": [
"entryPointId",
"entryPointName"
]
}