Child pages
  • Dial Plan

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

View or modify dialing rules

Available in 14 starting with 14.10

...

The resource is represented by the following properties when the GET request is performed:

Property

Description

id


name


enabeled


type

Each dial plan type can be created using proper type field:
International
Emergency
Mapping_Rule
Custom
Local
Internal
Long_Distance
Restricted
Toll_free
Attendant
Intercom
Paging
Site_to_Site
Authorization_Code

description


permissions


hatewayAware


authorizationChecked


internal


pstnPrefixOptional


longDistancePrefixOptional


externalLen


optionalPrefix


emergencyNumber


afterHoursAttendantEnabled


enableLiveAttendant



Specific Response Codes: N/A

...

</Rule>

</Rules>

JSON format

{

rules: [8]


0: {
id: 1
name: "Emergency"
enabled: false
type: "Emergency"
description: "Emergency dialing plan"
scheduleId: null
permissions: {

names: [0]

}-
gatewayAware: true
authorizationChecked: true
internal: false
mediaServerHostname: null
mediaServerType: null
dialPatterns: null
callPattern: null
pstnPrefix: null
pstnPrefixOptional: false
longDistancePrefix: null
longDistancePrefixOptional: false
areaCodes: null
externalLen: 0
optionalPrefix: "9"
emergencyNumber: "911"
afterHoursAttendant: null
afterHoursAttendantEnabled: false
holidayAttendant: null
workingTimeAttendant: null
holidayAttendantPeriods: null
workingTimeAttendantPeriods: null
extension: null
attendantAliases: null
did: null
enableLiveAttendant: false
}-
1: {
id: 2
name: "International"
enabled: false
type: "Long_Distance"
description: "International dialing"
scheduleId: null
permissions: {

names: [0]

}-
gatewayAware: true
authorizationChecked: true
internal: false
mediaServerHostname: null
mediaServerType: null
dialPatterns: null
callPattern: null
pstnPrefix: ""
pstnPrefixOptional: false
longDistancePrefix: "011"
longDistancePrefixOptional: false
areaCodes: ""
externalLen: -1
optionalPrefix: null
emergencyNumber: null
afterHoursAttendant: null
afterHoursAttendantEnabled: false
holidayAttendant: null
workingTimeAttendant: null
holidayAttendantPeriods: null
workingTimeAttendantPeriods: null
extension: null
attendantAliases: null
did: null
enableLiveAttendant: false
}-
2: {
id: 3
name: "Local"
enabled: false
type: "Long_Distance"
description: "Local dialing"
scheduleId: null
permissions: {

names: [0]

}-
gatewayAware: true
authorizationChecked: true
internal: false
mediaServerHostname: null
mediaServerType: null
dialPatterns: null
callPattern: null
pstnPrefix: "9"
pstnPrefixOptional: false
longDistancePrefix: ""
longDistancePrefixOptional: true
areaCodes: ""
externalLen: 7
optionalPrefix: null
emergencyNumber: null
afterHoursAttendant: null
afterHoursAttendantEnabled: false
holidayAttendant: null
workingTimeAttendant: null
holidayAttendantPeriods: null
workingTimeAttendantPeriods: null
extension: null
attendantAliases: null
did: null
enableLiveAttendant: false
}
}


HTTP Method: PUT

Update the description for the specified rule.

HTTP Method: POST

Create a new rule.

{   "type":"Attendant",
   "name":"Attedant-2",
   "enabled":true,
   "description":"didianara",
   "scheduleId":null,
   "permissions":{      "names":[
      ]
   },
   "gatewayAware":false,
   "authorizationChecked":true,
   "internal":true,
   "mediaServerHostname":null,
   "mediaServerType":null,
   "dialPatterns":null,
   "callPattern":null,
   "pstnPrefix":null,
   "pstnPrefixOptional":false,
   "longDistancePrefix":null,
   "longDistancePrefixOptional":false,
   "areaCodes":null,
   "externalLen":0,
   "optionalPrefix":null,
   "emergencyNumber":null,
   "afterHoursAttendant":null,
   "holidayAttendant":"After hours",
   "workingTimeAttendant":"After hours",
   "holidayAttendantPeriods":{      "holidayPeriods":[         {            "startDate":1407877200000,
            "endDate":1407963600000
         }
      ]
   },
   "workingTimeAttendantPeriods":{      "workingHours":[         {            "enabled":true,
            "start":32400000,
            "stop":64800000,
            "scheduledDay":"Monday"
         },
         {            "enabled":false,
            "start":32400000,
            "stop":64800000,
            "scheduledDay":"Tuesday"
         },
         {            "enabled":true,
            "start":32400000,
            "stop":64800000,
            "scheduledDay":"Wednesday"
         },
         {            "enabled":false,
            "start":32400000,
            "stop":64800000,
            "scheduledDay":"Thursday"
         },
         {            "enabled":false,
            "start":32400000,
            "stop":64800000,
            "scheduledDay":"Friday"
         },
         {            "enabled":false,
            "start":32400000,
            "stop":64800000,
            "scheduledDay":"Saturday"
         },
         {            "enabled":false,
            "start":32400000,
            "stop":64800000,
            "scheduledDay":"Sunday"
         }
      ]
   },
   "extension":"1002",
   "attendantAliases":"zzzz2",
   "did":null,
   "enableLiveAttendant":true
}  

HTTP Method: DELETE

Delete the specified rule.

...