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

From DocWiki

Jump to: navigation, search

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