User Notification Devices API
The following URI can be used to view the user template object ID:
|
From the above URI, get the notification devices object ID:
|
Pager
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
JSON Example
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Note |
To activate notification device <PhoneNumber> parameter is mandatory and <RepeatInterval > parameter is mandatory to enable repeat notify. The provided values can be changed and possible values are given in the Explanation of Fields: Pager and Phone table. |
Listing Pager Device
JSON Example
To view pager devices, do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Create Pager Device
The mandatory parameters are: PhoneNumber, DisplayName, and MediaSwitchObjectId.
|
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
JSON Example
|
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
The phone system ID is mandatory to create pager device. URI to get ID for phone system:
|
Phone Devices
|
From above URI get notification devices URI:
|
Listing Phone Device
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
JSON Example
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
Create Phone Device
The mandatory fields are DisplayName, PhoneNumber, and MediaSwitchObjectId.
|
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
JSON Example
|
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
URI to get ID for phone system:
|
Update Phone Device
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
To activate notification device, the <PhoneNumber> parameter is mandatory. The <RepeatInterval> parameter is mandatory to enable repeat notify. The phone devices are of 3 types: Work phone, Home phone, and Mobile phone. You have to provide phone device object id to edit any of the 3 devices.
JSON Example
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Delete Phone Device
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
JSON Example
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
SMTP Device
Listing SMTP Device
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
JSON Example
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Update SMTP Device
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
About HTML Notification Devices (in Cisco Unity Connection 9.0(1) and Later)
Cisco Unity Connection Provisioning Interface (CUPI) API allows users to view list of Html Notification Devices, a specific notification device or modify an existing HTML Notification Device.
Listing HTML Notification Devices
The following is an example of the GET request that lists the HTML notification devices for the users:
|
The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:
|
Listing an HTML Notification Device for Users
The following is an example of the GET request that lists a particular html notification device for the end users represented by <deviceid>:
|
The following is the response from the above *GET* request and the actual result will depend upon the information has been provided by you:
|
Modifying an HTML Notification Device for Users
The following is an example of the PUT request that modifies the HTML notification device for the users as represented by <deviceid>:
|
The input for the PUT request will be XML or JSON as per HtmlDevice schema. The output for this request returns the successful response code.
Modifying an HTML Notification Device to Apply HTML Notification Template
The following is an example of the PUT request that modifies the HTML notification device as represented by <deviceid>:
|
Configuring an HTML-Based Notification Template with an HTML Notification Device
This PUT request allow users to apply an HTML-based notification template with an HTML notification device. The user can perform this action if the template selection rights are given by administrator. The following is an example of PUT request:
|
This API will modify a particular HTML notification device for the end users as represented by <deviceobjectid>.
Configuring Schedule Notification
Cisco Unity Connection allows you to receive schedule notification tag in 24 hours format (hh:mm) using <SendScheduledNotificationAt>. You can configure multiple notifications using comma in the separated values. The schedules mentioned in this tag would overwrite all the existing schedules. In order to delete all existing schedules, provide an empty <SendScheduledNotificationAt> tag.
Listing Schedule Notification
The following is an example of the GET request that lists the HTML notification devices for the users:
|
The following is an example of the response from the above *GET* request and the actual response will depend upon the information given by you:
|
JSON Example
|
|
|
Modifying Schedule Notification
The following is an example of the PUT request that modifies the Schedule notification for the user as represented by <SendScheduledNotificationAt>:
|
|
JSON Example
|
|
|
The following is an example of the PUT request that deletes all the existing schedules by representing the <SendScheduledNotificationAt> tag empty:
|
|
JSON Example
|
|
Explanation of Data Fields
Device Name | Data Type | Operations | Comments | ||
---|---|---|---|---|---|
Device Name | String(12) | Read Only | Device name of HTML notification device. | ||
Display Name | String(64) | Read Only | The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, "Home Phone," Pager 2," "Work Phone, " etc. | ||
Active | Boolean | Read Only | Enable notification device.
Values:
|
||
EventList | String | Read/Write | By default it is NewVoiceMail.
Possible values:
Default value: NewVoiceMail.
|
||
SmtpAddress | String(320) | Read Only | SMTP address to be notified. | ||
ObjectId | String(36) | Read Only | Unique identifier of Notification Device | ||
DisableMobileNumberFromPCA | Boolean | Read Only | Disable Outdial Number From Cisco PCA
Values:
|
||
CallbackNumber | Integer | Read Only | Outdial Number | ||
SubscriberObjectID | String(36) | Read Only | The unique identifier of the Subscriber object to which this notification device belongs. | ||
ScheduleSetObjectId | String(36) | Read Only | The unique identifier of the Schedule | ||
DisableTemplateSelectionFromPCA | Boolean | Read Only | Disable HTML Template selection From Cisco
PCA
Default value is false. |
||
AllowVoiceMailAsAttachement | Boolean | Read Only | A flag indicating whether Cisco Unity
Connection will allow notifier to send voice mail recording with the
notification.
false: Don't Allow notifier to send voice mail recording with the notification true: Allow notifier to send voice mail recording with the notification Default value is false. |
||
NotificationTemplateID | String(36) | Read Only | The unique identifier of the Notification
Template object which this notification device is using for HTML based
notification This URI can be used to fetch NotificationTemplateID
|
||
PhoneNumber | String | Read/Write | The phone number to dial, including the trunk access code (if any), of the device. | ||
Undeletable | Boolean | Read Only | flag indicating whether HTML cannot be
deleted or not.
Possible values:
|
||
SendScheduledNotificationAt | Integer | Read/Write | A tag that is use to receive schedule notifications in 24 hours format (hh:mm). You can configure multiple notifications using comma in the separated values. |
Enum Type
Name | Value | Description |
---|---|---|
SystemGreeting | 0 | System greeting - Cisco Unity Connection plays a prerecorded greeting along with the recorded name of the subscriber (for example, "Sorry, <subscriber name> is not available"). If the subscriber does not have a recorded name, Cisco Unity Connection plays the subscriber extension instead. When a greeting is enabled but not recorded, Cisco Unity Connection plays a prerecorded system greeting. |
RecordedGreeting | 1 | Recorded greeting - use a personal recording for the call handler (or subscriber). This can be recorded over the phone or from the Cisco Unity Connection Administration and CPCA administrative interfaces on the call handler/subscriber. |
NoGreeting | 2 | No greeting is played. |