HTML Devices
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. This API is available in in Cisco Unity Connection 9.0(1) and later releases.
Listing All HTML Devices
|
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:
|
|
Listing Details of a Particular HTML Notification Device
The following is an example of the GET request that lists a particular html notification device for the end user represented by <deviceid>:
|
|
JSON Example
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
SMTP Devices
Cisco Unity Connection Provisioning Interface (CUPI) API allows users to view list of SMTP Notification Devices, a specific notification device or modify an existing SMTP Notification Device. This API is available in in Cisco Unity Connection 9.0(1) and Later releases.
Listing All SMTP Device of User
|
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:
|
|
Listing Specific 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 *PUT* 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:
|
Explanation of fields: SMTP Devices
Device Name |
Data Type |
Operation |
Comment |
---|---|---|---|
Active |
Boolean |
Read/Write |
Enable SMTP notification device. SMTP address is mandatory to enable it. |
SmtpAddress |
String |
Read/Write |
SMTP address to be notified. |
DisplayName |
String |
Read/Write |
Display name of the end user. |
InitialDelay |
Integer |
Read/Write |
Delay before the First Notification Attempt, Possible values: 0-120 Default value: 0 |
RepeatNotify |
Boolean |
Read/Write |
Repeat Notification if there are Still New Messages Possible value: false- Do Repeat Notification true- Repeat Notification Default: false |
RepeatInteval |
Integer |
Read/Write |
Notification Repeat Interval. Possible values: 0-60 Default value: 0 |
EventList |
String |
Read/Write |
To have multiple values selected we can have combination of below values separated by comma. Values: All messages: AllMessage All message urgent only: AllUrgentMessage All Voice messages: NewVoiceMail All voice message urgent only: NewUrgentVoiceMail 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 |
SubscriberObjectId |
String |
Read Only |
The unique identifier of the Subscriber object to which this notification device belongs. |
ScheduleSetObjectId |
String |
Read Only |
The unique identifier of the Schedule. URI to get ObjectId: https://<Connection-server>/vmrest/schedulesets |
SendCallerId |
Boolean |
Read/Write |
Include Message Information in Message Text. Possible values: false: Do not send callerId true: send callerId |
SendCount |
Boolean |
Read/Write |
Include Message Count in Message Text Possible Values: false: Do not send subscriber message counts. true: Send subscriber message counts. |
SendPcaLink |
Boolean |
Read/Write |
Include a Link to the Cisco Unity Connection Web Inbox in Message Text |
DisplayName |
String |
Read Only |
Name of notification device |
DeviceName |
String |
Read Only |
Device name of notification device which can’t be changed. |
MaxBody |
Integer |
Read Only |
The maximum number of characters allowed in the 'body' of a notification message. |
MaxSubject |
Integer |
Read Only |
The maximum number of characters allowed in the 'subject' of a notification message. Possible value: 0-4096 |