Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template Notification Devices

From DocWiki

(Difference between revisions)
Jump to: navigation, search
(Modifying Notification Device)
m (1 revision)
 
(3 intermediate revisions not shown)
Line 6: Line 6:
|}
|}
-
__TOC__
 
 +
__TOC__
-
== About Notification Devices ==
 
-
 
-
This page contains information on how to use the API to create, list, update, and delete Notification Devices.
 
-
Cisco Unity Connection supports four different types of Notification Devices:
+
== User Template Notification Devices ==
-
 
+
-
*Phone Devices
+
-
*Pager Devices
+
-
*HTML Devices
+
-
*SMTP Devices
+
-
 
+
-
The generic Notification Device resource contains the data fields that are common to most or all of the specialized Device resources, which in turn may contain additional data fields that are specific to certain Device resources. A listing of all data fields, including a description of what they mean and which specialized Device types support them, can be found later in this document.
+
-
 
+
-
In order to create, update, or delete a Notification Device, an API user must use the appropriate specialized Device resource. In other words, an API user can retrieve all of a user's Notification Devices, but if they then want to update a particular Phone Device, they must do the update operation on the Phone Device resource, not the Notification Device resource. This will be explained in more detail below.
+
-
 
+
-
The Notification Device resource and the four specialized Device resources contain data fields from the Device objects in the database, plus some data fields from the Notification Rule object. From an API user's perspective, this detail may not usually be important, but it is worth mentioning that the Device resources collapse two database objects into a single resource. This can be safely done because there is always a one-to-one mapping in the database of Notification Devices and Notification Rules.
+
-
 
+
-
The factory default User Template for Voicemail Users contains five Notification Devices: three Phone Devices (Home, Work, and Mobile), one Pager Device, one HTML device, and one SMTP Device. Any of these default Notification Devices can be modified, and new Devices of any of four specialized types (phone, pager, HTML, and SMTP) can be created or deleted.
+
-
 
+
-
== Listing and Viewing Notification Devices ==
+
-
+
-
'''Example 1'''
+
-
 
+
-
The following is an example of a GET that lists all Notification Devices of all types for the specified User Template:
+
-
 
+
-
<pre> https://<connection-server>/vmrest/usertemplates/<objectId>/usertemplatenotificationdevices </pre>
+
-
 
+
-
The following is the response from the above *GET* request.  Notice that this list contains a mix of different types of specialized Devices, since the request was for a list of all Notification Devices.  The Type field indicates the specialized Device type for each Notification Device (1 = Phone, 2 = Pager, 4 = SMTP, 8 = HTML).
+
 +
The following URI can be used to view the user template object ID:
<pre>
<pre>
-
<UserTemplateNotificationDevices total="7">
+
    GET https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>
-
<UserTemplateNotificationDevice>
+
-
<URI>/vmrest/usertemplates/85a845d3-063d-4641-aa70-8b536282bffb/usertemplatenotificationdevices/22b1e3cc-f13d-4349-8811-a196132781a3</URI>
+
-
<SubscriberObjectId>85a845d3-063d-4641-aa70-8b536282bffb</SubscriberObjectId>
+
-
<UserURI>/vmrest/users/85a845d3-063d-4641-aa70-8b536282bffb</UserURI>
+
-
<ObjectId>22b1e3cc-f13d-4349-8811-a196132781a3</ObjectId>
+
-
<DisplayName>Pager</DisplayName>
+
-
<Active>false</Active>
+
-
<BusyRetryInterval>5</BusyRetryInterval>
+
-
<Type>2</Type>
+
-
<DialDelay>1</DialDelay>
+
-
<MaxBody>512</MaxBody>
+
-
<MaxSubject>64</MaxSubject>
+
-
<RetriesOnBusy>4</RetriesOnBusy>
+
-
<RetriesOnRna>4</RetriesOnRna>
+
-
<RingsToWait>4</RingsToWait>
+
-
<RnaRetryInterval>15</RnaRetryInterval>
+
-
<SendCount>true</SendCount>
+
-
<WaitConnect>true</WaitConnect>
+
-
<MediaSwitchObjectId>24f1171f-27b3-4ad3-a94c-66d1fb2e448b</MediaSwitchObjectId>
+
-
<PhoneSystemURI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b</PhoneSystemURI>
+
-
<TransmitForcedAuthorizationCode>false</TransmitForcedAuthorizationCode>
+
-
<DeviceName>Pager</DeviceName>
+
-
<PromptForId>false</PromptForId>
+
-
<SendCallerId>true</SendCallerId>
+
-
<SendPcaLink>false</SendPcaLink>
+
-
<Undeletable>true</Undeletable>
+
-
<MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
+
-
<DetectTransferLoop>false</DetectTransferLoop>
+
-
<SuccessRetryInterval>1</SuccessRetryInterval>
+
-
<RetriesOnSuccess>0</RetriesOnSuccess>
+
-
<EventList>NewVoiceMail</EventList>
+
-
<ScheduleSetObjectId>a884af0a-dd5f-4597-8bc7-31a61e8b612a</ScheduleSetObjectId>
+
-
<InitialDelay>0</InitialDelay>
+
-
<RepeatInterval>0</RepeatInterval>
+
-
<RepeatNotify>false</RepeatNotify>
+
-
</UserTemplateNotificationDevice>
+
-
<UserTemplateNotificationDevice>
+
-
<URI>/vmrest/usertemplates/85a845d3-063d-4641-aa70-8b536282bffb/usertemplatenotificationdevices/d2e67ebc-a987-441d-a168-88d1d7dc49c2</URI>
+
-
<SubscriberObjectId>85a845d3-063d-4641-aa70-8b536282bffb</SubscriberObjectId>
+
-
<UserURI>/vmrest/users/85a845d3-063d-4641-aa70-8b536282bffb</UserURI>
+
-
<ObjectId>d2e67ebc-a987-441d-a168-88d1d7dc49c2</ObjectId>
+
-
<DisplayName>PagerDevice</DisplayName>
+
-
<Active>false</Active>
+
-
<BusyRetryInterval>5</BusyRetryInterval>
+
-
<Type>2</Type>
+
-
<DialDelay>1</DialDelay>
+
-
<MaxBody>512</MaxBody>
+
-
<MaxSubject>64</MaxSubject>
+
-
<RetriesOnBusy>4</RetriesOnBusy>
+
-
<RetriesOnRna>4</RetriesOnRna>
+
-
<RingsToWait>4</RingsToWait>
+
-
<RnaRetryInterval>15</RnaRetryInterval>
+
-
<SendCount>true</SendCount>
+
-
<WaitConnect>true</WaitConnect>
+
-
<MediaSwitchObjectId>24f1171f-27b3-4ad3-a94c-66d1fb2e448b</MediaSwitchObjectId>
+
-
<PhoneSystemURI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b</PhoneSystemURI>
+
-
<TransmitForcedAuthorizationCode>false</TransmitForcedAuthorizationCode>
+
-
<DeviceName>Other</DeviceName>
+
-
<PromptForId>false</PromptForId>
+
-
<SendCallerId>true</SendCallerId>
+
-
<SendPcaLink>false</SendPcaLink>
+
-
<Undeletable>false</Undeletable>
+
-
<MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
+
-
<DetectTransferLoop>false</DetectTransferLoop>
+
-
<SuccessRetryInterval>1</SuccessRetryInterval>
+
-
<RetriesOnSuccess>0</RetriesOnSuccess>
+
-
<EventList>NewVoiceMail</EventList>
+
-
<ScheduleSetObjectId>a884af0a-dd5f-4597-8bc7-31a61e8b612a</ScheduleSetObjectId>
+
-
<InitialDelay>0</InitialDelay>
+
-
<RepeatInterval>0</RepeatInterval>
+
-
<RepeatNotify>false</RepeatNotify>
+
-
</UserTemplateNotificationDevice>
+
-
<UserTemplateNotificationDevice>
+
-
<URI>/vmrest/usertemplates/85a845d3-063d-4641-aa70-8b536282bffb/usertemplatenotificationdevices/53bd701a-7301-49d0-8404-9769b38094cd</URI>
+
-
<SubscriberObjectId>85a845d3-063d-4641-aa70-8b536282bffb</SubscriberObjectId>
+
-
<UserURI>/vmrest/users/85a845d3-063d-4641-aa70-8b536282bffb</UserURI>
+
-
<ObjectId>53bd701a-7301-49d0-8404-9769b38094cd</ObjectId>
+
-
<DisplayName>Work Phone</DisplayName>
+
-
<Active>false</Active>
+
-
<BusyRetryInterval>5</BusyRetryInterval>
+
-
<Conversation>SubNotify</Conversation>
+
-
<Type>1</Type>
+
-
<DialDelay>1</DialDelay>
+
-
<MaxBody>512</MaxBody>
+
-
<MaxSubject>64</MaxSubject>
+
-
<RetriesOnBusy>4</RetriesOnBusy>
+
-
<RetriesOnRna>4</RetriesOnRna>
+
-
<RingsToWait>4</RingsToWait>
+
-
<RnaRetryInterval>15</RnaRetryInterval>
+
-
<SendCount>false</SendCount>
+
-
<WaitConnect>true</WaitConnect>
+
-
<MediaSwitchObjectId>24f1171f-27b3-4ad3-a94c-66d1fb2e448b</MediaSwitchObjectId>
+
-
<PhoneSystemURI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b</PhoneSystemURI>
+
-
<TransmitForcedAuthorizationCode>false</TransmitForcedAuthorizationCode>
+
-
<DeviceName>Work Phone</DeviceName>
+
-
<PromptForId>false</PromptForId>
+
-
<SendCallerId>false</SendCallerId>
+
-
<SendPcaLink>false</SendPcaLink>
+
-
<Undeletable>true</Undeletable>
+
-
<MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
+
-
<DetectTransferLoop>false</DetectTransferLoop>
+
-
<SuccessRetryInterval>0</SuccessRetryInterval>
+
-
<RetriesOnSuccess>0</RetriesOnSuccess>
+
-
<EventList>NewVoiceMail</EventList>
+
-
<ScheduleSetObjectId>a884af0a-dd5f-4597-8bc7-31a61e8b612a</ScheduleSetObjectId>
+
-
<InitialDelay>0</InitialDelay>
+
-
<RepeatInterval>0</RepeatInterval>
+
-
<RepeatNotify>false</RepeatNotify>
+
-
</UserTemplateNotificationDevice>
+
-
<UserTemplateNotificationDevice>
+
-
<URI>/vmrest/usertemplates/85a845d3-063d-4641-aa70-8b536282bffb/usertemplatenotificationdevices/fa8d720c-7c03-4506-867f-780636b00c13</URI>
+
-
<SubscriberObjectId>85a845d3-063d-4641-aa70-8b536282bffb</SubscriberObjectId>
+
-
<UserURI>/vmrest/users/85a845d3-063d-4641-aa70-8b536282bffb</UserURI>
+
-
<ObjectId>fa8d720c-7c03-4506-867f-780636b00c13</ObjectId>
+
-
<DisplayName>Home Phone</DisplayName>
+
-
<Active>false</Active>
+
-
<BusyRetryInterval>5</BusyRetryInterval>
+
-
<Conversation>SubNotify</Conversation>
+
-
<Type>1</Type>
+
-
<DialDelay>1</DialDelay>
+
-
<MaxBody>512</MaxBody>
+
-
<MaxSubject>64</MaxSubject>
+
-
<RetriesOnBusy>4</RetriesOnBusy>
+
-
<RetriesOnRna>4</RetriesOnRna>
+
-
<RingsToWait>4</RingsToWait>
+
-
<RnaRetryInterval>15</RnaRetryInterval>
+
-
<SendCount>false</SendCount>
+
-
<WaitConnect>true</WaitConnect>
+
-
<MediaSwitchObjectId>24f1171f-27b3-4ad3-a94c-66d1fb2e448b</MediaSwitchObjectId>
+
-
<PhoneSystemURI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b</PhoneSystemURI>
+
-
<TransmitForcedAuthorizationCode>false</TransmitForcedAuthorizationCode>
+
-
<DeviceName>Home Phone</DeviceName>
+
-
<PromptForId>false</PromptForId>
+
-
<SendCallerId>false</SendCallerId>
+
-
<SendPcaLink>false</SendPcaLink>
+
-
<Undeletable>true</Undeletable>
+
-
<MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
+
-
<DetectTransferLoop>false</DetectTransferLoop>
+
-
<SuccessRetryInterval>0</SuccessRetryInterval>
+
-
<RetriesOnSuccess>0</RetriesOnSuccess>
+
-
<EventList>NewVoiceMail</EventList>
+
-
<ScheduleSetObjectId>a884af0a-dd5f-4597-8bc7-31a61e8b612a</ScheduleSetObjectId>
+
-
<InitialDelay>0</InitialDelay>
+
-
<RepeatInterval>0</RepeatInterval>
+
-
<RepeatNotify>false</RepeatNotify>
+
-
</UserTemplateNotificationDevice>
+
-
<UserTemplateNotificationDevice>
+
-
<URI>/vmrest/usertemplates/85a845d3-063d-4641-aa70-8b536282bffb/usertemplatenotificationdevices/24cd2817-2911-4668-b740-24369c4b0d19</URI>
+
-
<SubscriberObjectId>85a845d3-063d-4641-aa70-8b536282bffb</SubscriberObjectId>
+
-
<UserURI>/vmrest/users/85a845d3-063d-4641-aa70-8b536282bffb</UserURI>
+
-
<ObjectId>24cd2817-2911-4668-b740-24369c4b0d19</ObjectId>
+
-
<DisplayName>Mobile Phone</DisplayName>
+
-
<Active>false</Active>
+
-
<BusyRetryInterval>5</BusyRetryInterval>
+
-
<Conversation>SubNotify</Conversation>
+
-
<Type>1</Type>
+
-
<DialDelay>1</DialDelay>
+
-
<MaxBody>512</MaxBody>
+
-
<MaxSubject>64</MaxSubject>
+
-
<RetriesOnBusy>4</RetriesOnBusy>
+
-
<RetriesOnRna>4</RetriesOnRna>
+
-
<RingsToWait>4</RingsToWait>
+
-
<RnaRetryInterval>15</RnaRetryInterval>
+
-
<SendCount>false</SendCount>
+
-
<WaitConnect>true</WaitConnect>
+
-
<MediaSwitchObjectId>24f1171f-27b3-4ad3-a94c-66d1fb2e448b</MediaSwitchObjectId>
+
-
<PhoneSystemURI>/vmrest/phonesystems/24f1171f-27b3-4ad3-a94c-66d1fb2e448b</PhoneSystemURI>
+
-
<TransmitForcedAuthorizationCode>false</TransmitForcedAuthorizationCode>
+
-
<DeviceName>Mobile Phone</DeviceName>
+
-
<PromptForId>false</PromptForId>
+
-
<SendCallerId>false</SendCallerId>
+
-
<SendPcaLink>false</SendPcaLink>
+
-
<Undeletable>true</Undeletable>
+
-
<MediaSwitchDisplayName>PhoneSystem</MediaSwitchDisplayName>
+
-
<DetectTransferLoop>false</DetectTransferLoop>
+
-
<SuccessRetryInterval>0</SuccessRetryInterval>
+
-
<RetriesOnSuccess>0</RetriesOnSuccess>
+
-
<EventList>NewVoiceMail</EventList>
+
-
<ScheduleSetObjectId>a884af0a-dd5f-4597-8bc7-31a61e8b612a</ScheduleSetObjectId>
+
-
<InitialDelay>0</InitialDelay>
+
-
<RepeatInterval>0</RepeatInterval>
+
-
<RepeatNotify>false</RepeatNotify>
+
-
</UserTemplateNotificationDevice>
+
-
<UserTemplateNotificationDevice>
+
-
<URI>/vmrest/usertemplates/85a845d3-063d-4641-aa70-8b536282bffb/usertemplatenotificationdevices/d6871a13-4680-428a-a839-afb6d3b46b6b</URI>
+
-
<SubscriberObjectId>85a845d3-063d-4641-aa70-8b536282bffb</SubscriberObjectId>
+
-
<UserURI>/vmrest/users/85a845d3-063d-4641-aa70-8b536282bffb</UserURI>
+
-
<ObjectId>d6871a13-4680-428a-a839-afb6d3b46b6b</ObjectId>
+
-
<DisplayName>SMTP</DisplayName>
+
-
<Active>false</Active>
+
-
<BusyRetryInterval>0</BusyRetryInterval>
+
-
<Type>4</Type>
+
-
<DialDelay>0</DialDelay>
+
-
<MaxBody>512</MaxBody>
+
-
<MaxSubject>64</MaxSubject>
+
-
<RetriesOnBusy>0</RetriesOnBusy>
+
-
<RetriesOnRna>0</RetriesOnRna>
+
-
<RingsToWait>0</RingsToWait>
+
-
<RnaRetryInterval>0</RnaRetryInterval>
+
-
<SendCount>true</SendCount>
+
-
<WaitConnect>false</WaitConnect>
+
-
<TransmitForcedAuthorizationCode>false</TransmitForcedAuthorizationCode>
+
-
<DeviceName>SMTP</DeviceName>
+
-
<PromptForId>false</PromptForId>
+
-
<SendCallerId>true</SendCallerId>
+
-
<SendPcaLink>false</SendPcaLink>
+
-
<Undeletable>true</Undeletable>
+
-
<DetectTransferLoop>false</DetectTransferLoop>
+
-
<SuccessRetryInterval>0</SuccessRetryInterval>
+
-
<RetriesOnSuccess>0</RetriesOnSuccess>
+
-
<EventList>NewVoiceMail</EventList>
+
-
<ScheduleSetObjectId>a884af0a-dd5f-4597-8bc7-31a61e8b612a</ScheduleSetObjectId>
+
-
<InitialDelay>0</InitialDelay>
+
-
<RepeatInterval>0</RepeatInterval>
+
-
<RepeatNotify>false</RepeatNotify>
+
-
</UserTemplateNotificationDevice>
+
-
<UserTemplateNotificationDevice>
+
-
<URI>/vmrest/usertemplates/85a845d3-063d-4641-aa70-8b536282bffb/usertemplatenotificationdevices/9f2f0ce2-0567-421a-bd89-973ceecb8518</URI>
+
-
<SubscriberObjectId>85a845d3-063d-4641-aa70-8b536282bffb</SubscriberObjectId>
+
-
<UserURI>/vmrest/users/85a845d3-063d-4641-aa70-8b536282bffb</UserURI>
+
-
<ObjectId>9f2f0ce2-0567-421a-bd89-973ceecb8518</ObjectId>
+
-
<DisplayName>HTML</DisplayName>
+
-
<Active>false</Active>
+
-
<BusyRetryInterval>0</BusyRetryInterval>
+
-
<Type>8</Type>
+
-
<DialDelay>0</DialDelay>
+
-
<MaxBody>512</MaxBody>
+
-
<MaxSubject>64</MaxSubject>
+
-
<RetriesOnBusy>0</RetriesOnBusy>
+
-
<RetriesOnRna>0</RetriesOnRna>
+
-
<RingsToWait>0</RingsToWait>
+
-
<RnaRetryInterval>0</RnaRetryInterval>
+
-
<SendCount>false</SendCount>
+
-
<SmtpAddress>aaaa</SmtpAddress>
+
-
<WaitConnect>false</WaitConnect>
+
-
<TransmitForcedAuthorizationCode>false</TransmitForcedAuthorizationCode>
+
-
<DeviceName>HTML</DeviceName>
+
-
<PromptForId>false</PromptForId>
+
-
<SendCallerId>false</SendCallerId>
+
-
<SendPcaLink>false</SendPcaLink>
+
-
<Undeletable>true</Undeletable>
+
-
<DetectTransferLoop>false</DetectTransferLoop>
+
-
<SuccessRetryInterval>0</SuccessRetryInterval>
+
-
<RetriesOnSuccess>0</RetriesOnSuccess>
+
-
<EventList>NewVoiceMail</EventList>
+
-
<ScheduleSetObjectId>a884af0a-dd5f-4597-8bc7-31a61e8b612a</ScheduleSetObjectId>
+
-
<InitialDelay>0</InitialDelay>
+
-
<RepeatInterval>0</RepeatInterval>
+
-
<RepeatNotify>false</RepeatNotify>
+
-
</UserTemplateNotificationDevice>
+
-
</UserTemplateNotificationDevices>
+
</pre>
</pre>
-
 
+
From the above URI, get the notification devices object ID:
-
<pre> Response Code: 200 </pre>
+
-
 
+
-
'''Example 2'''
+
-
 
+
-
The following is an example of a GET that lists a particular Notification Devices for the specified User Template:  
+
-
 
+
-
<pre> https://<connection_server>/vmrest/usertemplates/<objectId>/usertemplatenotificationdevices/<objectId> </pre>
+
-
 
+
-
The following is the response from the above *GET* request. 
+
-
 
+
<pre>
<pre>
-
<UserTemplateNotificationDevice>
+
    https://<connectionserver>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices
-
<URI>/vmrest/usertemplates/85a845d3-063d-4641-aa70-8b536282bffb/usertemplatenotificationdevices/9f2f0ce2-0567-421a-bd89-973ceecb8518</URI>
+
</pre>
-
<SubscriberObjectId>85a845d3-063d-4641-aa70-8b536282bffb</SubscriberObjectId>
+
-
<UserURI>/vmrest/users/85a845d3-063d-4641-aa70-8b536282bffb</UserURI>
+
-
<ObjectId>9f2f0ce2-0567-421a-bd89-973ceecb8518</ObjectId>
+
-
<DisplayName>HTML</DisplayName>
+
-
<Active>false</Active>
+
-
<Type>8</Type>
+
-
<MaxBody>512</MaxBody>
+
-
<MaxSubject>64</MaxSubject>
+
-
<SmtpAddress>aaaa</SmtpAddress>
+
-
<DeviceName>HTML</DeviceName>
+
-
<Undeletable>true</Undeletable>
+
-
<EventList>NewVoiceMail</EventList>
+
-
<ScheduleSetObjectId>a884af0a-dd5f-4597-8bc7-31a61e8b612a</ScheduleSetObjectId>
+
-
<InitialDelay>0</InitialDelay>
+
-
<RepeatInterval>0</RepeatInterval>
+
-
<RepeatNotify>false</RepeatNotify>
+
-
</UserTemplateNotificationDevice>
+
-
<pre> Response Code: 200 </pre>
 
 +
=== Pager ===
-
== Adding a New Notification Device ==
+
The following URI can be used to view the pager device by using user template notification device object ID:
-
 
+
-
This section contains information on how to create notification devices:
+
-
 
+
-
*Adding Pager Notification Device
+
-
*Adding Phone Notification Device
+
-
*Adding HTML Notification Device
+
-
*Adding SMTP Notification Device
+
-
*Adding Pager Notification Device
+
-
 
+
-
=== Adding Pager Notification Device ===
+
-
 
+
-
The following is an example of the POST request that adds a Pager Notification Device:  
+
-
<pre> https://<connection_server>/vmrest/usertemplates/<objectId>/notificationdevices/<objectId> </pre>
+
-
 
+
-
The actual response will depend upon the information given by you.
+
-
 
+
<pre>
<pre>
 +
    GET https://<connection-
 +
    server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices/usertemplatepagerdevic
 +
    es/<usertemplatenotificationdeviceobjectId>
 +
Request Body: Updating Pager
<UserTemplatePagerDevice>
<UserTemplatePagerDevice>
-
<DisplayName>pager1</DisplayName>
+
    <Active>true</Active>   
-
<MediaSwitchObjectId>2b6324a2-d66f-4f25-9572-decf88c9a0b7</MediaSwitchObjectId>
+
    <DisplayName>Pager1</DisplayName>
-
<PhoneNumber>5656</PhoneNumber>
+
    <InitialDelay>1</InitialDelay>
 +
    <RepeatNotify>true</RepeatNotify>
 +
    <RepeatInterval>1</RepeatInterval>
 +
    <EventList>AllMessage</EventList>
 +
    <RetriesOnBusy>4</RetriesOnBusy>
 +
    <BusyRetryInterval>5</BusyRetryInterval>
 +
    <RetriesOnRna>4</RetriesOnRna>
 +
    <RnaRetryInterval>15</RnaRetryInterval>
 +
    <RetriesOnSuccess>0</RetriesOnSuccess>
</UserTemplatePagerDevice>
</UserTemplatePagerDevice>
 +
</pre>
 +
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
 +
<pre>
 +
Response Code: 204
</pre>
</pre>
-
<pre> Response Code: 201 </pre>
+
'''NOTE:''' To activate notification device <PhoneNumber> parameter is mandatory and <RepeatInterval > parameter is mandatory to enable repeat notify. The provide values can be changed and values are given in above table.
-
=== Adding Phone Notification Device ===
+
'''JSON Example'''
-
The following is an example of the POST request that adds a Phone Notification Device:  
+
To view pager devices, do the following:
 +
<pre>
 +
GET https://<connectionserver>/vmrestvmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices/
 +
usertemplatepagerdevices/<usertemplatenotificationdeviceobjectId>
 +
Accept: application/json
 +
Content-type: application/json
 +
Connection: keep-alive
 +
</pre>
 +
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
 +
<pre>
 +
{
 +
    "URI":"/vmrest/usertemplates/6164ac2d-e8ec-441a-93a0-95f8e18a655c/usertemplatenotificationdevices/usertemplatepagerdevices/ad6bdb87-7ab6-4a2a-b4fb-5dae6fd6804c"
 +
    "TransmitForcedAuthorizationCode":"false"
 +
    "BusyRetryInterval":"5"
 +
    "DialDelay":"1"
 +
    "RetriesOnBusy":"4"
 +
    "RetriesOnRna":"4"
 +
    "RingsToWait":"4"
 +
    "RnaRetryInterval":"15"
 +
    "SendCount":"true"
 +
    "WaitConnect":"true"
 +
    "MediaSwitchObjectId":"0ad0b88c-4a70-4cf7-913e-d5d7a921caca"
 +
    "PhoneSystemURI":"/vmrest/phonesystems/0ad0b88c-4a70-4cf7-913e-d5d7a921caca"
 +
    "ObjectId":"ad6bdb87-7ab6-4a2a-b4fb-5dae6fd6804c"
 +
    "Active":"false"
 +
    "DeviceName":"Pager"
 +
    "DisplayName":"Pager"
 +
    "MaxBody":"512"
 +
    "MaxSubject":"64"
 +
    "SubscriberObjectId":"6164ac2d-e8ec-441a-93a0-95f8e18a655c"
 +
    "UserURI":"/vmrest/users/6164ac2d-e8ec-441a-93a0-95f8e18a655c"
 +
    "SendCallerId":"true"
 +
    "Undeletable":"true"
 +
    "SuccessRetryInterval":"1"
 +
    "RetriesOnSuccess":"0"
 +
    "EventList":"NewVoiceMail"
 +
    "ScheduleSetObjectId":"5fc5a5d7-eaf6-4f4d-80cf-f76f3893ac0e"
 +
    "InitialDelay":"0"
 +
    "RepeatInterval":"0"
 +
    "RepeatNotify":"false"
 +
}
 +
</pre>
 +
<pre>
 +
Response Code: 200
 +
</pre>
 +
 
 +
==== Explanation of Fields: Pager ====
-
<pre> https://<connection_server>/vmrest/usertemplates/<objectId>/notificationdevices/<objectId> </pre>
+
{| border="1" cellspacing="0" cellpadding="5" align="center"
 +
! Parameter
 +
! Operations
 +
! Data Type
 +
! Comments
 +
|-
 +
| Device Name
 +
| Data Type
 +
| Operation
 +
| Comment
 +
|-
 +
| Active
 +
| Boolean
 +
| Read/Write
 +
| Enable notification device.
 +
Default value: False
 +
|-
 +
| DisplayName
 +
| String
 +
| Read/Write
 +
| Name of notification device
 +
|-
 +
| DeviceName
 +
| String
 +
| Read Only
 +
| Device name of notification device which can’t be changed.
 +
|-
 +
| FailDeviceObjectId
 +
| String
 +
| Read/Write
 +
| Have to provide notification device object id.
 +
To move back to “Do nothing option”, don’t provide any object Id in this parameter.
 +
|-
 +
| EventList
 +
| String
 +
| Read/Write
 +
| Values can be:
 +
*All messages: AllMessage
 +
*All message urgent only: AllUrgentMessage
 +
*All Voice messages: NewVoiceMail
 +
*All voice message urgent only: NewUrgentVoiceMai
 +
*Dispatch messages: DispatchMessage
 +
*Dispatch message urgent only: UrgentDispatchMessage
 +
*Fax messages: NewFax
 +
*Fax messages urgent only: NewUrgentFax
 +
*All voice messages and fax message urgent only: NewUrgentFax,NewVoiceMail
 +
*All voice message urgent only and fax message: NewUrgentFax,NewUrgentVoiceMail
 +
*Fax message and all voice message: NewFax,NewVoiceMail
 +
|-
 +
| PhoneNumber
 +
| Integer
 +
| Read/Write
 +
| To activate notification device phone number is mandatory.
 +
|-
 +
| AfterDialDigits
 +
| String(32)
 +
| Read/Write
 +
| The extra digits (if any) that Cisco Unity Connection will dial after the phone number. For numeric pagers, the extra digits are shown on the pager display.
 +
|-
 +
| DialDelay
 +
| Integer(4)
 +
| Read/Write
 +
| The amount of time (in seconds) Cisco Unity Connection will wait after detecting a successful call before dialing specified additional digits (if any). Additional digits are contained in AfterDialDigits.
 +
|-
 +
| InitialDelay
 +
| Integer(4)
 +
| Read/Write
 +
| The amount of time (in minutes) from the time a message is received until the message notification triggers (if the message matches the criteria).
 +
Default Value: 0
 +
Range: 0-120
 +
|-
 +
| RingsToWait
 +
| Integer
 +
| Read/Write
 +
| The number of rings Cisco Unity Connection will wait before hanging up if the device does not answer.
 +
Default value: 4
 +
Range: 1-100
 +
|-
 +
| RetriesOnBusy
 +
| Integer
 +
| Read/Write
 +
| The number of times Cisco Unity Connection will retry the notification device if it is busy.
 +
Default value: 4
 +
Range: 0-100
 +
|-
 +
| BusyRetryInterval
 +
| Integer
 +
| Read/Write
 +
| The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is busy.
 +
Default value: 5
 +
Range: 1-100
 +
|-
 +
| RetriesOnRna
 +
| Integer
 +
| Read/Write
 +
| The number of times Cisco Unity Connection will retry the notification device if the device does not answer.
 +
Default value: 4
 +
Range: 0-100
 +
|-
 +
| RnaRetryInterval
 +
| Integer
 +
| Read/Write
 +
| The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device does not answer.
 +
Default value: 15
 +
Range: 1-100
 +
|-
 +
| RetriesOnSuccess
 +
| Integer
 +
| Read/Write
 +
| The number of times Cisco Unity Connection will retry the notification device if it is successful.
 +
Default value: 0
 +
Range: 0-100
 +
|-
 +
| SuccessRetryInterval
 +
| Integer
 +
| Read/Write
 +
| The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is successful.
 +
Default value: 1
 +
Range: 1-100
 +
|-
 +
| MediaSwitchObjectId
 +
| String
 +
| Read/Write
 +
| The unique identifier of the MediaSwitch objects to use for notification.
 +
|}
-
The actual response will depend upon the information given by you.
+
=== Phone Devices ===
 +
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.
 +
All the parameters are same as of pager except 1. That is <PromptForId>true</PromptForId>.
 +
The following URI can be used to view the phone device using user template notification object ID:
<pre>
<pre>
-
<UserTemplatePhoneDevice>
+
    GET https://<connection-
-
<DisplayName>pager1</DisplayName>
+
    server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices/usertemplatephonedevic
-
<MediaSwitchObjectId>2b6324a2-d66f-4f25-9572-decf88c9a0b7</MediaSwitchObjectId>
+
    es/<usertemplatenotificationdeviceobjectId>
-
<PhoneNumber>5656</PhoneNumber>
+
-
</UserTemplatePhoneDevice>
+
</pre>
</pre>
-
<pre> Response Code: 201 </pre>
 
-
=== Adding HTML Notification Device ===
+
=== HTML Devices ===
-
 
+
-
The following is an example of the POST request that adds a HTML Notification Device:
+
-
 
+
-
<pre> https://<connection_server>/vmrest/usertemplates/<objectId>/notificationdevices/<objectId> </pre>
+
-
 
+
-
The actual response will depend upon the information given by you.
+
 +
The following URI can be used to view the html devices using user template notification object ID:
<pre>
<pre>
 +
    GET https://<connection-
 +
    server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices/usertemplatehtmldevic
 +
    es/<usertemplatenotificationdeviceobjectId>
 +
Request Body: To update an HTML Device
<UserTemplateHtmlDevice>
<UserTemplateHtmlDevice>
-
<DisplayName>Html</DisplayName>
+
    <Active>truee</Active>  
-
< SmtpAddress> a@cisco.com</SmtpAddress>
+
    <SmtpAddress>tenant@cisco.com</SmtpAddress>
-
<CallbackNumber>1111</CallbackNumber>
+
    <DisableMobileNumberFromPCA>false</DisableMobileNumberFromPCA>
 +
    <HeaderText>erwr</HeaderText>
</UserTemplateHtmlDevice>
</UserTemplateHtmlDevice>
</pre>
</pre>
-
<pre> Response Code: 201 </pre>
+
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
 +
<pre>
 +
Response Code: 204
 +
</pre>
 +
'''NOTE:''' To activate the SmtpAddress parameter is mandatory.
 +
==== Explanation of Fields: HTML Device ====
-
=== Adding SMTP Notification Device ===
+
{| border="1" cellspacing="0" cellpadding="5" align="center"
 +
! Parameter
 +
! Operations
 +
! Data Type
 +
! Comments
 +
|-
 +
| Device Name
 +
| Data Type
 +
| Operation
 +
| Comment
 +
|-
 +
| DeviceName
 +
| String
 +
| Read/Write
 +
| Device name of HTML notification device.
 +
|-
 +
| EventList
 +
| String
 +
| Read/Write
 +
| By default it is NewVoiceMail.
 +
|-
 +
| SmtpAddress
 +
| String
 +
| Read/Write
 +
| SMTP address to be notified.
 +
|-
 +
| NotificationTemplateID
 +
| String
 +
| Read/Write
 +
| HTML notification templates.
 +
|-
 +
| DisableMobileNumberFromPCA
 +
| Boolean
 +
| Read/Write
 +
| Disable Outdial Number From Cisco PCA.
 +
Default value: False
 +
|-
 +
| CallbackNumber
 +
| Integer
 +
| Read/Write
 +
| Outdial number.
 +
|-
 +
| DisableTemplateSelectionFromPCA
 +
| Boolean
 +
| Read/Write
 +
| Disable HTML Template selection From Cisco PCA.
 +
Default value: False
 +
|}
-
The following is an example of the POST request that adds a HTML Notification Device:
 
-
<pre> https://<connection_server>/vmrest/usertemplates/<objectId>/notificationdevices/<objectId> </pre>
+
=== SMTP Devices ===
-
 
+
-
The actual response will depend upon the information given by you.
+
 +
The following URI can be used to view the SMTP devices using user template notification object ID:
<pre>
<pre>
 +
GET https://<connection server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices/usertemplatesmtpdevices/<usertemplatenotificationdeviceobjectId>
 +
Request Body: SMTP Devices
<UserTemplateSmtpDevice>
<UserTemplateSmtpDevice>
-
<DisplayName>SMTP</DisplayName>
+
<StaticText>ritu</StaticText>
-
  <SmtpAddress> a@cisco.com</SmtpAddress>
+
<Active>true</Active>
-
<PhoneNumber>5656</PhoneNumber>
+
<DeviceName>SMTP</DeviceName>
 +
  <SendCallerId>false</SendCallerId>
 +
<SendPcaLink>true</SendPcaLink>
 +
<Undeletable>true</Undeletable>
 +
<HeaderText>erwr</HeaderText>
 +
<FooterText>efs</FooterText>
 +
<EventList>AllMessage, CalendarAppointment,CalendarMeeting</EventList>
</UserTemplateSmtpDevice>
</UserTemplateSmtpDevice>
</pre>
</pre>
-
<pre> Response Code: 201 </pre>
+
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
 +
<pre>
 +
Response Code: 204
 +
</pre>
 +
==== Explanation of fields: SMTP Devices ====
 +
{| border="1" cellspacing="0" cellpadding="5" align="center"
 +
! Parameter
 +
! Operations
 +
! Data Type
 +
! Comments
 +
|-
 +
| Device Name
 +
| Data Type
 +
| Operation
 +
| Comment
 +
|-
 +
| Active
 +
| Boolean
 +
| Read/Write
 +
| Enable SMTP notification device. SMTP address is mandatory to enable it.
 +
Default value: False
 +
|-
 +
| SmtpAddress
 +
| String
 +
| Read/Write
 +
| SMTP address to be notified.
 +
|-
 +
| InitialDelay
 +
| Integer
 +
| Read/Write
 +
| Delay before the First Notification Attempt
 +
|-
 +
| RepeatNotify
 +
| Boolean
 +
| Read/Write
 +
| Repeat Notification if there are Still New Messages.
 +
Default value: False
 +
|-
 +
| RepeatInterval
 +
| Integer
 +
| Read/Write
 +
| Notification Repeat Interval
 +
|-
 +
| EventList
 +
| String
 +
| Read/Write
 +
| Values can be:
 +
*All messages: AllMessage
 +
*All message urgent only: AllUrgentMessage
 +
*All Voice messages: NewVoiceMail
 +
*All voice message urgent only: NewUrgentVoiceMai
 +
*Dispatch messages: DispatchMessage
 +
*Dispatch message urgent only: UrgentDispatchMessage
 +
*Fax messages: NewFax
 +
*Fax messages urgent only: NewUrgentFax
 +
*All voice messages and fax message urgent only: NewUrgentFax,NewVoiceMail
 +
*All voice message urgent only and fax message: NewUrgentFax,NewUrgentVoiceMail
 +
*Fax message and all voice message: NewFax,NewVoiceMail
 +
*Calendar Appointment: CalendarAppointment
 +
*Calendar meeting: CalendarMeeting
 +
|-
 +
| PhoneNumber
 +
| Integer
 +
| Read/Write
 +
| From which number SMTP notification is sent.
 +
|-
 +
| HeaderText
 +
| String
 +
| Read/Write
 +
| Message Header
 +
|-
 +
| StaticText
 +
| String
 +
| Read/Write
 +
| Message text
 +
|-
 +
| FooterText
 +
| String
 +
| Read/Write
 +
| Message footer
 +
|-
 +
| SendCallerId
 +
| Boolean
 +
| Read/Write
 +
| Include Message Information in Message Text.
 +
Default value: True
 +
|-
 +
| SendCount
 +
| Boolean
 +
| Read/Write
 +
| Include Message Count in Message Text.
 +
Default value: True
 +
|-
 +
| SendPcaLink
 +
| Boolean
 +
| Read/Write
 +
| Include a Link to the Cisco Unity Connection Web Inbox in Message Text.
 +
Default value: False
 +
|}
-
== Modifying Notification Device ==
 
-
The following is an example of the PUT request that modifies a Notification Device as represented by <objectId>:
+
=== Creating a new Notification device ===
-
<pre>  
+
The following URI can be used to create a pager device:
-
https://<connection_server>/vmrest/usertemplates/<objectId>/usertemplatenotificationdevices/<objectId>  
+
<pre>
 +
    POST https://<connection-
 +
    server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevic
 +
    es/usertemplatepagerdevices
 +
Request Body:
 +
<UserTemplateNotificationDevice>
 +
    <DisplayName>Newpager</DisplayName>
 +
    <MediaSwitchObjectId>8adf6869-4afc-4455-9fd5-d05b68ca6630</MediaSwitchObjectId>
 +
</UserTemplateNotificationDevice>
</pre>
</pre>
-
The following is an example of the response from the above *PUT* request and the actual response will depend upon the information given by you:  
+
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
-
 
+
<pre>
<pre>
-
<UserTemplatePhoneDevice>
+
Response Code: 201
-
<Active>false</Active>
+
-
<RepeatInterval>0</RepeatInterval>
+
-
<RepeatNotify>true</RepeatNotify>
+
-
<PhoneNumber>123456</PhoneNumber>
+
-
<AfterDialDigits>11111</AfterDialDigits>
+
-
<DialDelay>0</DialDelay>
+
-
<RingsToWait>100</RingsToWait>
+
-
<RetriesOnBusy>4</RetriesOnBusy>
+
-
<RetriesOnRna>4</RetriesOnRna>
+
-
<BusyRetryInterval>1</BusyRetryInterval>
+
-
<RnaRetryInterval>100</RnaRetryInterval>
+
-
<RetriesOnRna>100</RetriesOnRna>
+
-
<MediaSwitchObjectId>1fb12b1c-cf14-4634-b73d-9b9c58ecdf68</MediaSwitchObjectId>
+
-
<PromptForId>false</PromptForId>
+
-
<EventList>NewUrgentFax,UrgentDispatchMessage</EventList>
+
-
</UserTemplatePhoneDevice>
+
</pre>
</pre>
-
 
+
<pre>
-
<pre> Response Code: 204 </pre>
+
/vmrest/usertemplates/<objectid>/usertemplatenotificationdevices/<objectid>
-
 
+
</pre>
-
== Deleting a New Notification Device ==
+
'''NOTE:''' Phone system Id is mandatory to create pager device.
-
 
+
-
The following is an example of the DELETE request that deletes a Notification Device as represented by <notificationdeviceid>:
+
-
 
+
-
<pre> https://<connection_server>/vmrest/usertemplates/<objectId>/usertemplatenotificationdevices/<objectId> </pre>
+
-
 
+
-
The output for this request returns the successful response code.
+
-
 
+
-
<pre> Response Code: 204 </pre>
+
-
 
+
-
 
+
-
== Explanation of Data Fields  ==
+
-
[[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_Notification_Devices#Explanation_of_Data_Fields]]
+

Latest revision as of 09:22, 1 November 2013

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation


Contents


User Template Notification Devices

The following URI can be used to view the user template object ID:

    GET https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>

From the above URI, get the notification devices object ID:

    https://<connectionserver>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices


Pager

The following URI can be used to view the pager device by using user template notification device object ID:

    GET https://<connection-
    server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices/usertemplatepagerdevic
    es/<usertemplatenotificationdeviceobjectId>
Request Body: Updating Pager
<UserTemplatePagerDevice>
    <Active>true</Active>    
    <DisplayName>Pager1</DisplayName>
    <InitialDelay>1</InitialDelay>
    <RepeatNotify>true</RepeatNotify> 
    <RepeatInterval>1</RepeatInterval>
    <EventList>AllMessage</EventList> 
    <RetriesOnBusy>4</RetriesOnBusy>
    <BusyRetryInterval>5</BusyRetryInterval>
    <RetriesOnRna>4</RetriesOnRna>
    <RnaRetryInterval>15</RnaRetryInterval>
    <RetriesOnSuccess>0</RetriesOnSuccess>
</UserTemplatePagerDevice>

The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:

Response Code: 204

NOTE: To activate notification device <PhoneNumber> parameter is mandatory and <RepeatInterval > parameter is mandatory to enable repeat notify. The provide values can be changed and values are given in above table.

JSON Example

To view pager devices, do the following:

GET https://<connectionserver>/vmrestvmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices/
usertemplatepagerdevices/<usertemplatenotificationdeviceobjectId>
Accept: application/json
Content-type: application/json
Connection: keep-alive 

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

{
    "URI":"/vmrest/usertemplates/6164ac2d-e8ec-441a-93a0-95f8e18a655c/usertemplatenotificationdevices/usertemplatepagerdevices/ad6bdb87-7ab6-4a2a-b4fb-5dae6fd6804c"
    "TransmitForcedAuthorizationCode":"false"
    "BusyRetryInterval":"5"
    "DialDelay":"1"
    "RetriesOnBusy":"4"
    "RetriesOnRna":"4"
    "RingsToWait":"4"
    "RnaRetryInterval":"15"
    "SendCount":"true"
    "WaitConnect":"true"
    "MediaSwitchObjectId":"0ad0b88c-4a70-4cf7-913e-d5d7a921caca"
    "PhoneSystemURI":"/vmrest/phonesystems/0ad0b88c-4a70-4cf7-913e-d5d7a921caca"
    "ObjectId":"ad6bdb87-7ab6-4a2a-b4fb-5dae6fd6804c"
    "Active":"false"
    "DeviceName":"Pager"
    "DisplayName":"Pager"
    "MaxBody":"512"
    "MaxSubject":"64"
    "SubscriberObjectId":"6164ac2d-e8ec-441a-93a0-95f8e18a655c"
    "UserURI":"/vmrest/users/6164ac2d-e8ec-441a-93a0-95f8e18a655c"
    "SendCallerId":"true"
    "Undeletable":"true"
    "SuccessRetryInterval":"1"
    "RetriesOnSuccess":"0"
    "EventList":"NewVoiceMail"
    "ScheduleSetObjectId":"5fc5a5d7-eaf6-4f4d-80cf-f76f3893ac0e"
    "InitialDelay":"0"
    "RepeatInterval":"0"
    "RepeatNotify":"false"
}
Response Code: 200

Explanation of Fields: Pager

Parameter Operations Data Type Comments
Device Name Data Type Operation Comment
Active Boolean Read/Write Enable notification device.

Default value: False

DisplayName String Read/Write Name of notification device
DeviceName String Read Only Device name of notification device which can’t be changed.
FailDeviceObjectId String Read/Write Have to provide notification device object id.

To move back to “Do nothing option”, don’t provide any object Id in this parameter.

EventList String Read/Write Values can be:
  • All messages: AllMessage
  • All message urgent only: AllUrgentMessage
  • All Voice messages: NewVoiceMail
  • All voice message urgent only: NewUrgentVoiceMai
  • Dispatch messages: DispatchMessage
  • Dispatch message urgent only: UrgentDispatchMessage
  • Fax messages: NewFax
  • Fax messages urgent only: NewUrgentFax
  • All voice messages and fax message urgent only: NewUrgentFax,NewVoiceMail
  • All voice message urgent only and fax message: NewUrgentFax,NewUrgentVoiceMail
  • Fax message and all voice message: NewFax,NewVoiceMail
PhoneNumber Integer Read/Write To activate notification device phone number is mandatory.
AfterDialDigits String(32) Read/Write The extra digits (if any) that Cisco Unity Connection will dial after the phone number. For numeric pagers, the extra digits are shown on the pager display.
DialDelay Integer(4) Read/Write The amount of time (in seconds) Cisco Unity Connection will wait after detecting a successful call before dialing specified additional digits (if any). Additional digits are contained in AfterDialDigits.
InitialDelay Integer(4) Read/Write The amount of time (in minutes) from the time a message is received until the message notification triggers (if the message matches the criteria).

Default Value: 0 Range: 0-120

RingsToWait Integer Read/Write The number of rings Cisco Unity Connection will wait before hanging up if the device does not answer.

Default value: 4 Range: 1-100

RetriesOnBusy Integer Read/Write The number of times Cisco Unity Connection will retry the notification device if it is busy.

Default value: 4 Range: 0-100

BusyRetryInterval Integer Read/Write The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is busy.

Default value: 5 Range: 1-100

RetriesOnRna Integer Read/Write The number of times Cisco Unity Connection will retry the notification device if the device does not answer.

Default value: 4 Range: 0-100

RnaRetryInterval Integer Read/Write The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device does not answer.

Default value: 15 Range: 1-100

RetriesOnSuccess Integer Read/Write The number of times Cisco Unity Connection will retry the notification device if it is successful.

Default value: 0 Range: 0-100

SuccessRetryInterval Integer Read/Write The amount of time (in minutes) Cisco Unity Connection will wait between tries if the device is successful.

Default value: 1 Range: 1-100

MediaSwitchObjectId String Read/Write The unique identifier of the MediaSwitch objects to use for notification.

Phone Devices

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. All the parameters are same as of pager except 1. That is <PromptForId>true</PromptForId>. The following URI can be used to view the phone device using user template notification object ID:

    GET https://<connection-
    server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices/usertemplatephonedevic
    es/<usertemplatenotificationdeviceobjectId>


HTML Devices

The following URI can be used to view the html devices using user template notification object ID:

    GET https://<connection-
    server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices/usertemplatehtmldevic
    es/<usertemplatenotificationdeviceobjectId>
Request Body: To update an HTML Device
<UserTemplateHtmlDevice>
    <Active>truee</Active>   
    <SmtpAddress>tenant@cisco.com</SmtpAddress>
    <DisableMobileNumberFromPCA>false</DisableMobileNumberFromPCA>
    <HeaderText>erwr</HeaderText>
</UserTemplateHtmlDevice>

The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:

Response Code: 204

NOTE: To activate the SmtpAddress parameter is mandatory.

Explanation of Fields: HTML Device

Parameter Operations Data Type Comments
Device Name Data Type Operation Comment
DeviceName String Read/Write Device name of HTML notification device.
EventList String Read/Write By default it is NewVoiceMail.
SmtpAddress String Read/Write SMTP address to be notified.
NotificationTemplateID String Read/Write HTML notification templates.
DisableMobileNumberFromPCA Boolean Read/Write Disable Outdial Number From Cisco PCA.

Default value: False

CallbackNumber Integer Read/Write Outdial number.
DisableTemplateSelectionFromPCA Boolean Read/Write Disable HTML Template selection From Cisco PCA.

Default value: False


SMTP Devices

The following URI can be used to view the SMTP devices using user template notification object ID:

GET https://<connection server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevices/usertemplatesmtpdevices/<usertemplatenotificationdeviceobjectId>
Request Body: SMTP Devices
<UserTemplateSmtpDevice>
<StaticText>ritu</StaticText>
<Active>true</Active>
<DeviceName>SMTP</DeviceName>
 <SendCallerId>false</SendCallerId>
<SendPcaLink>true</SendPcaLink>
<Undeletable>true</Undeletable>
<HeaderText>erwr</HeaderText>
<FooterText>efs</FooterText>
<EventList>AllMessage, CalendarAppointment,CalendarMeeting</EventList>
</UserTemplateSmtpDevice>

The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:

Response Code: 204

Explanation of fields: SMTP Devices

Parameter Operations Data Type Comments
Device Name Data Type Operation Comment
Active Boolean Read/Write Enable SMTP notification device. SMTP address is mandatory to enable it.

Default value: False

SmtpAddress String Read/Write SMTP address to be notified.
InitialDelay Integer Read/Write Delay before the First Notification Attempt
RepeatNotify Boolean Read/Write Repeat Notification if there are Still New Messages.

Default value: False

RepeatInterval Integer Read/Write Notification Repeat Interval
EventList String Read/Write Values can be:
  • All messages: AllMessage
  • All message urgent only: AllUrgentMessage
  • All Voice messages: NewVoiceMail
  • All voice message urgent only: NewUrgentVoiceMai
  • Dispatch messages: DispatchMessage
  • Dispatch message urgent only: UrgentDispatchMessage
  • Fax messages: NewFax
  • Fax messages urgent only: NewUrgentFax
  • All voice messages and fax message urgent only: NewUrgentFax,NewVoiceMail
  • All voice message urgent only and fax message: NewUrgentFax,NewUrgentVoiceMail
  • Fax message and all voice message: NewFax,NewVoiceMail
  • Calendar Appointment: CalendarAppointment
  • Calendar meeting: CalendarMeeting
PhoneNumber Integer Read/Write From which number SMTP notification is sent.
HeaderText String Read/Write Message Header
StaticText String Read/Write Message text
FooterText String Read/Write Message footer
SendCallerId Boolean Read/Write Include Message Information in Message Text.

Default value: True

SendCount Boolean Read/Write Include Message Count in Message Text.

Default value: True

SendPcaLink Boolean Read/Write Include a Link to the Cisco Unity Connection Web Inbox in Message Text.

Default value: False


Creating a new Notification device

The following URI can be used to create a pager device:

    POST https://<connection-
    server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatenotificationdevic
    es/usertemplatepagerdevices
Request Body:
<UserTemplateNotificationDevice>
    <DisplayName>Newpager</DisplayName>
    <MediaSwitchObjectId>8adf6869-4afc-4455-9fd5-d05b68ca6630</MediaSwitchObjectId>
</UserTemplateNotificationDevice>

The following is the response from the above *POST* request and the actual response will depend upon the information given by you:

Response Code: 201
/vmrest/usertemplates/<objectid>/usertemplatenotificationdevices/<objectid>

NOTE: Phone system Id is mandatory to create pager device.

Rating: 0.0/5 (0 votes cast)

Personal tools