Cisco Unity Express -- Restriction Tables REST PI Service Operation
From DocWiki
Main page: Cisco Unity Express -- REST PI Service Operations
Previous page: Cisco Unity Express -- Language and Prompts REST PI Service Operation
Next page: Cisco Unity Express -- Scripts REST PI Service Operation
Search the Cisco Unity Express documentation on the DocWiki:
Contents |
Restriction Tables
Classes
Figure 11: Restriction Table
RestrictionTable
| Class Name |
RestrictionTable | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Class for defining rules for checking if outgoing calls to a given phone number are allowed or not. | ||
| XML Namespace |
http://restriction.model.rest.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
tableName |
String |
Length 2-32 |
Name of the restriction table. |
|
maxDigits |
Integer |
Range 1-30 Default 30 |
Maximum number of digits allowed in the outgoing phone number. |
|
minDigits |
String |
Range 1-30 Default 1 |
Minimum number of digits required in the outgoing phone number. |
|
dialString |
DialString (collection) |
Maximum 10 dial strings supported |
Collection of dial string patterns determining if the otugoing call is allowed or restricted. |
DialString
| Class Name |
Prompt | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Represents the pattern oh phone numbers allowed or disallowed. | ||
| XML Namespace |
http://restriction.model.rest.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
dialPattern |
String |
Valid characters are digits 0 to 9, asterisk (*), or dot (.). |
Call pattern to be matched. The table accepts duplicate call patterns. |
|
preference |
Integer |
Order of this string in the restriction table. The system searches the strings in order of preference. | |
|
allowed |
Boolean |
If True, permits phone numbers with this pattern. |
Resources
| Resource URI | Operation | Input | Return Value |
|---|---|---|---|
|
/restrictions |
GET (Read all restriction tables) |
BaseElementList Containing list of RestrictionTable objects. | |
|
POST (create a restriction table) |
RestrictionTable (including DialString list) | ||
|
/restrictions/{tablename} |
GET (read a restriction table) |
RestrictionTable (includes list of DialString) | |
|
PUT (update a restriction table) |
RestrictionTable (including DialString list) | ||
|
DELETE (delete a restriction table) | |||
|
/restrictionTables/{tablename}/dialStrings |
GET (Get list of DialString patterns defined in the restriction table) |
BaseElementList containing list of DialString objects | |
|
POST (Add a dial string pattern to restriction table) |
DialString | ||
|
/restrictionTables/{tablename}/dialStrings/{preference} |
GET (Read dial string pattern by preference) |
DialString | |
|
PUT (Change the dial string pattern at a particular preference in the restriction table) |
DialString | ||
|
DELETE (Delete dial string by preference) |
