Cisco Unity Express -- Subscriber Notification Profile REST PI Service Operation
From DocWiki
Main page: Cisco Unity Express -- REST PI Service Operations
Previous page: Cisco Unity Express -- Greetings REST PI Service Operation
Next page: Cisco Unity Express -- Notification Settings REST PI Service Operation
Search the Cisco Unity Express documentation on the DocWiki:
Contents |
Subscriber Notification Profile
Classes
Figure 26: Subscriber Notification Profile
DeviceName
| Class Name |
DeviceName (Enumeration Class) |
|---|---|
| Extends From | |
| Description |
Enumeration of device names supported for notification profile configuration |
| XML Namespace |
http://notification.model.rest.aesop.cisco.com |
| Enum Values |
CELLPHONE, EMAIL, HOMEPHONE, NUMPAGER, TXTPAGER, WORKPHONE |
NotificationPreference
| Class Name |
NotificationPreference (Enumeration Class) |
|---|---|
| Extends From | |
| Description |
Enumeration of notification preference choices |
| XML Namespace |
http://notification.model.rest.aesop.cisco.com |
| Enum Values |
AllMessages, UrgentMessages |
NotificationDevice
| Class Name |
NotificationDevice (Abstract class) | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Class representing a notification device | ||
| XML Namespace |
http://notification.model.rest.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
enabled |
Boolean |
Enable notification to this device | |
|
name |
DeviceName |
Device name | |
|
preference |
NotificationPreference |
Type of messages for which notification is sent to the device | |
|
schedule |
Schedule |
Schedule when notfication is sent to this device |
| Class Name |
| ||
|---|---|---|---|
| Extends From |
NotificationDevice | ||
| Description |
Notification sent to email address | ||
| XML Namespace |
http://notification.model.rest.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
address |
String |
Email address | |
|
attachVM |
Boolean |
If voicemail is sent as attached to the email | |
|
text |
String |
Email Text |
Phone
| Class Name |
Phone | ||
|---|---|---|---|
| Extends From |
NotificationDevice | ||
| Description |
Notification sent to a phone number | ||
| XML Namespace |
http://notification.model.rest.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
extraDigits |
String |
Extra digits to dial | |
|
phoneNumber |
String |
Phone number to which notification is sent |
TextPager
| Class Name |
TextPager | ||
|---|---|---|---|
| Extends From |
NotificationDevice | ||
| Description |
Notification sent to a text pager device | ||
| XML Namespace |
http://notification.model.rest.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
address |
String |
Text pager address | |
|
text |
String |
Notification message |
VmCascadeNotifyTarget
| Class Name |
VmCascadeNotifyTarget | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Class representing a target mailbox to which voicemail notfications are cascaded to | ||
| XML Namespace |
http://notification.model.rest.voicemail.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
targetMailboxId |
String |
Mailbox to which notification is cascaded to | |
|
notifyAfter |
Integer |
Range 5-1440 minutes |
Duration (in minutes) after which notification is cascaded |
VmCascadeNotify
| Class Name |
VmCascadeNotify | ||
|---|---|---|---|
| Extends From |
ManagedBaseElement | ||
| Description |
Class representing list of target mailboxes to which notfication is cascaded to | ||
| XML Namespace |
http://notification.model.rest.voicemail.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
vmCascadeNotifyTargets |
VmCascadeNotifyTarget (Collection) |
Maximum of two targets |
VmNotificationProfile
| Class Name |
VmNotificationProfile | ||
|---|---|---|---|
| Extends From |
NotificationProfile | ||
| Description |
Voicemail notification profile | ||
| XML Namespace |
http://notification.model.rest.voicemail.aesop.cisco.com | ||
| Field Name | Type | Constraints | Comments |
|
devices |
NotificationDevice (collection) |
List of notification device | |
|
enabled |
Boolean |
Enable voicemail notifcation for this mailbox | |
|
cascade |
VmCascadeNotify |
List of target mailboxes to which notfication is cascaded to |
Resources
| Resource URI | Operation | Input | Return Value |
|---|---|---|---|
|
/voicemail/mailboxes/{ownerid}/notification |
GET (Read complete notification profile for subscriber ) |
VmNotificationProfile (includes all devices, schedule and cascade settings) | |
|
PUT (Update the complete profile) |
VmNotificationProfile (including devices, schedule and cascade settings) | ||
|
/voicemail/mailboxes/{ownerid}/notification/cascade Use PUT operation for adding a new cascading rule or changing notifyAfter time for an existing rule. (for changing the notify targetMailbox and use sub-context /cascade/{targetmailboxid}) |
GET (Read cascade settings) |
VmCascadeNotify | |
|
PUT (Updates cascade notify settings) |
VmCascadeNotify | ||
|
/voicemail/mailboxes/{ownerid}/notification/cascade/{targetmailboxid} During PUT operation, updates the targetmailboxid if it is different from the value in VmCascadeNotifyTarget payload. Also sets the notifyAfter time if specified in the payload. |
PUT (Update cascade notify target mailbox id) |
VmCascadeNotifyTarget | |
|
DELETE (Delete a cascade notify target) | |||
|
/voicemail/mailboxes/{ownerid}/notification/devices |
GET (Read all the devices in the profile) |
BaseElementList containing list of NotificationDevice objects | |
|
/voicemail/mailboxes/{ownerid}/notification/devices/{deviceName} |
GET (Read a device from the profile) |
NotificationDevice (includes device schedule) | |
|
PUT (Update device information) |
NotificationDevice (including device schedule) | ||
|
/voicemail/mailboxes/{ownerid}/notification/devices/{devicename}/schedule |
GET (Read schedule for a device in profile) |
Schedule | |
|
PUT (Update device schedule) |
Schedule |
