DocWiki - User contributions [en]

Cisco Unity Express -- Voicemail Settings REST PI Service Operation

2010-05-03T01:41:18Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Public Distribution Lists REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Voicemail Settings===

====Classes====

'''Figure 29: Voicemail Settings'''

[[Image:CUE80_Voicemail Settings.jpg]]

=====LiveReplyCallingNumberRule=====

{| border ="1"
! '''Class Name'''
|
LiveReplyCallingNumberRule (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of live reply calling number rules
|-
! '''XML Namespace'''
|
<nowiki>http://vmsettings.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
'''EXTENSION''' (Use extension in network voicemail header for live reply)

'''PREFIX_EXTENSION''' (Use network location prefix then extension in network voicemail header for live reply)

'''LOCATION_EXTENSION''' (Use network location id then extension in network voicemail header for live reply)

'''LOCATIION_PREFIX_EXTENSION''' (Combine network location id, prefix, and voicemail extension for live reply)

'''PREFIX_LOCATION_EXTENSION''' (Combine network location prefix, id, and voicemail extension for live reply)
|}

=====LiveReplyNetworkPrecedence=====

{| border ="1"
! '''Class Name'''
|
LiveReplyNetworkPrecedence (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of live reply network precedence rules
|-
! '''XML Namespace'''
|
<nowiki>http://vmsettings.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
'''DISABLED''' (Turn off live reply to network delivered voicemail messages)

'''CALLING_NUMBER''' (Use the calling number rule to determine live reply number for a network delivered voicemail)

'''E164_NUMBER''' (Use the E.164 number in the voicemail header when using live reply for a network delivered voicemail)

'''E164_CALLING_NUMBER''' (Use the E.164 number in the voicemail header if available otherwise use the calling number rule for live reply)
|}

=====MailboxSelection=====

{| border ="1"
! '''Class Name'''
|
MailboxSelection (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Mailbox selection rules enumeration
|-
! '''XML Namespace'''
|
<nowiki>http://vmsettings.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
LAST_REDIRECT

ORIGINAL_CALLED
|}

=====VmSettings=====

{| border ="1"
! '''Class Name'''
|
VmSettings
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing various system level voicemail related configurations.
|-
! '''XML Namespace'''
|
<nowiki>http://vmsettings.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
broadCastMsgMWI
|
Boolean
|
|
Use MWI for broadcast messages
|-
|
broadcastMsgExpiry
|
Integer
|
|
Broadcast message expiry time, in days
|-
|
busScheduleForGreetings
|
BusinessSchedule
|
|
Business Hours Schedule for Greetings
|-
|
callerCallflowRestriction
|
RestrictionTable
|
|
Restriction table to use to control caller callflow
|-
|
callerIdExternal
|
Boolean
|
|
Play caller ID for external callers
|-
|
defaultMailboxSize
|
Integer
|
|
Default mailbox size, in seconds
|-
|
defaultMaxCallerMsgSize
|
Integer
|
|
Maximum caller message size, in seconds
|-
|
defaultMaxSubMsgSize
|
Integer
|
|
Maximum subscriber recording size, in seconds
|-
|
defaultMsgExpiry
|
Integer
|
|
Message expiry time, in days
|-
|
defaultPromptLanguage
|
Language
|
|
Default prompt language
|-
|
emailFromAddress
|
String
|
|
Outgoing e-mail "from" address
|-
|
liveRecordBeepDuration
|
Integer
|
Range 50-1000 milliseconds
|
Live record beep duration, in milliseconds
|-
|
liveRecordBeepInterval
|
Integer
|
Range 1-30 seconds
|
Live Record Beep Interval, in seconds
|-
|
liveRecordPilotNumber
|
String
|
|
Live Record pilot number
|-
|
liveReplyCallingNumberRule
|
LiveReplyCallingNumberRule
|
|
Live reply calling number rule
|-
|
liveReplyEnabled
|
Boolean
|
|
Enable live reply
|-
|
liveReplyNetworkPrecedence
|
LiveReplyNetworkPrecedence
|
|
Live reply network precedence
|-
|
liveReplyRestriction
|
RestrictionTable
|
|
Restriction table to use for live reply
|-
|
mailboxSelection
|
MailboxSelection
|
|
Mailbox where message is stored when a call is redirected
|-
|
mandatoryMsgExpiry
|
Boolean
|
|
Forces user to delete message upon expiry
|-
|
maxBroadcastMsgSize
|
Integer
|
|
Maximum broadcast message size, in seconds
|-
|
nonSubDeliveryRestriction
|
RestrictionTable
|
|
Restriction table to use for Non-subscriber delivery
|-
|
remoteUserInfoCache
|
Boolean
|
|
Enables caching of vCard and spoken name information from remote voicemail users
|-
|
systemVMCapacity
|
Integer
|
|
Maximum voice message store, in minutes
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/voicemail/vmsettings
|
GET
(read voicemail settings)
|
|
VMSettings
|-
|
|
PUT
(update voicemail settings)
|
VMSettings
|}

Cisco Unity Express -- Public Distribution Lists REST PI Service Operation

2010-05-03T01:41:01Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Notification Settings REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Voicemail Settings REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Public Distribution Lists===

====Classes====

'''Figure 28: Distribution List'''

[[Image:CUE80_Distribution List.jpg]]

=====ListElementType=====

{| border ="1"
! '''Class Name'''
|
ListElementType (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of type of elements that populate a public distribution list
|-
! '''XML Namespace'''
|
<nowiki>http://distributionlist.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
USER, GROUP, GDM, LIST, REMOTE_USER, REMOTE_BLIND, NON_SUBSCRIBER
|}

=====ListElement=====

{| border ="1"
! '''Class Name'''
|
ListElement
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing a distribution list member
|-
! '''XML Namespace'''
|
<nowiki>http://distributionlist.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
memberId
|
String
|
|
Identifier for the list element
|-
|
phoneNumber
|
String
|
|
Phone number of the list member
|-
|
type
|
ListElementType
|
|
Type of the list member
|}

=====DistributionList=====

{| border ="1"
! '''Class Name'''
|
DistributionList
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing a public distribution list
|-
! '''XML Namespace'''
|
<nowiki>http://distributionlist.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
description
|
String
|
|
List description
|-
|
listName
|
String
|
|
Name of the public list
|-
|
listNumber
|
String
|
|
Number of the distribution list
|-
|
members
|
ListElement (collection)
|
|
Collection of the members of this public list
|-
|
owners
|
ListElement (collection)
|
|
Collection of the owner of this public list
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/voicemail/publiclists
|
GET
(Read all public lists)
|
|
BaseElementList containing a collection of DistributionList objects
|-
|
|
POST
(Create a new public distribution list)
|
DistributionList
(Including list of member and owners )
|-
|
/voicemail/publiclists/{listname}
|
GET
(Read a public list, including its members and owners)
|
|
DistributionList
(Including list of member and owners )
|-
|
|
PUT
(Update list information)
|-
|
|
DELETE
(Delete list)
|-
|
/voicemail/publiclists/{listname}/members
|
GET
(Read members of a public list)
|
|
BaseElementList containing a collection of ListElement objects
|-
|
/voicemail/publiclists/{listname}/members/add
|
PUT
(Add a member to a public list)
|
ListElement
|-
|
/voicemail/publiclists/{listname}/members/delete
|
PUT
(Remove a member of public list)
|
ListElement
|-
|
/voicemail/publiclists/{listname}/owners
|
GET
(Read owners of a public list)
|
|
BaseElementList containing a collection of ListElement objects
|-
|
/voicemail/publiclists/{listname}/owners/add
|
PUT
(Add an owner to list)
|
ListElement
|-
|
/voicemail/publiclists/{listname}/owners/delete
|
PUT
(Remove an owner from list)
|
ListElement
|}

Cisco Unity Express -- Notification Settings REST PI Service Operation

2010-05-03T01:40:46Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Subscriber Notification Profile REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Public Distribution Lists REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Notification Settings===

====Classes====

'''Figure 27: System Notification Settings'''

[[Image:CUE80_System Notification Settings.jpg]]

=====VmNotificationSettings=====

{| border ="1"
! '''Class Name'''
|
VmNotificationSettings
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
System-wide settings for voicemail notification
|-
! '''XML Namespace'''
|
<nowiki>http://notification.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
allowLogin
|
Boolean
|
|
Allow user to login to voicemail box to retrieve voicemail when phone notification device is notified
|-
|
cascadingNotify
|
Boolean
|
|
Enable Cascading Notifications
|-
|
connectTimeout
|
Integer
|
Range 12-96 seconds
|
Connection timeout duration (seconds) if phone is not answered
|-
|
emailAttachVM
|
Boolean
|
|
Attach message to outgoing email notification
|-
|
enabled
|
Boolean
|
|
Enable system-wide notification
|-
|
liveRecordNotify
|
Boolean
|
|
Enable system-wide notification for live recordings
|-
|
msgPrecedingTxt
|
String
|
|
Preceding text for voicemail message notification
|-
|
msgSignatureTxt
|
String
|
|
Signature text for voicemail message notification
|-
|
preference
|
Notification Preference
|
|
Type of messages for which notification is enabled
|-
|
restrictionTable
|
String
|
|
Name of the restriction table to use while sending out notification
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/voicemail/notification
|
GET
(Get system-wide notification settings)
|
|
VmNotificationSettings
|-
|
|
PUT
(Set system-wide notification settings)
|
VmNotificationSettings
|}

Cisco Unity Express -- Subscriber Notification Profile REST PI Service Operation

2010-05-03T01:40:30Z

Mnapalan:

{{Template:Required Metadata}}
'''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:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Subscriber Notification Profile===

====Classes====

'''Figure 26: Subscriber Notification Profile'''

[[Image:CUE80_Subscriber Notification Profile.jpg]]

=====DeviceName=====

{| border ="1"
! '''Class Name'''
|
DeviceName (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of device names supported for notification profile configuration
|-
! '''XML Namespace'''
|
<nowiki>http://notification.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
CELLPHONE, EMAIL, HOMEPHONE, NUMPAGER, TXTPAGER, WORKPHONE
|}

=====NotificationPreference=====

{| border ="1"
! '''Class Name'''
|
NotificationPreference (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of notification preference choices
|-
! '''XML Namespace'''
|
<nowiki>http://notification.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
AllMessages, UrgentMessages
|}

=====NotificationDevice=====

{| border ="1"
! '''Class Name'''
|
NotificationDevice (Abstract class)
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing a notification device
|-
! '''XML Namespace'''
|
<nowiki>http://notification.model.rest.aesop.cisco.com</nowiki>
|-
! '''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
|}

=====Email=====

{| border ="1"
! '''Class Name'''
|
Email
|-
! '''Extends From'''
|
NotificationDevice
|-
! '''Description'''
|
Notification sent to email address
|-
! '''XML Namespace'''
|
<nowiki>http://notification.model.rest.aesop.cisco.com</nowiki>
|-
! '''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=====

{| border ="1"
! '''Class Name'''
|
Phone
|-
! '''Extends From'''
|
NotificationDevice
|-
! '''Description'''
|
Notification sent to a phone number
|-
! '''XML Namespace'''
|
<nowiki>http://notification.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
extraDigits
|
String
|
|
Extra digits to dial
|-
|
phoneNumber
|
String
|
|
Phone number to which notification is sent
|}

=====TextPager=====

{| border ="1"
! '''Class Name'''
|
TextPager
|-
! '''Extends From'''
|
NotificationDevice
|-
! '''Description'''
|
Notification sent to a text pager device
|-
! '''XML Namespace'''
|
<nowiki>http://notification.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
address
|
String
|
|
Text pager address
|-
|
text
|
String
|
|
Notification message
|}

=====VmCascadeNotifyTarget=====

{| border ="1"
! '''Class Name'''
|
VmCascadeNotifyTarget
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing a target mailbox to which voicemail notfications are cascaded to
|-
! '''XML Namespace'''
|
<nowiki>http://notification.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''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=====

{| border ="1"
! '''Class Name'''
|
VmCascadeNotify
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing list of target mailboxes to which notfication is cascaded to
|-
! '''XML Namespace'''
|
<nowiki>http://notification.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
vmCascadeNotifyTargets
|
VmCascadeNotifyTarget (Collection)
|
Maximum of two targets
|}

=====VmNotificationProfile=====

{| border ="1"
! '''Class Name'''
|
VmNotificationProfile
|-
! '''Extends From'''
|
NotificationProfile
|-
! '''Description'''
|
Voicemail notification profile
|-
! '''XML Namespace'''
|
<nowiki>http://notification.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''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====

{| border ="1"
! '''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
|}

Cisco Unity Express -- Greetings REST PI Service Operation

2010-05-03T01:40:13Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Caller Call Flow REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Subscriber Notification Profile REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Greetings===

====Classes====

'''Figure 25: Greeting'''

[[Image:CUE80_Greeting.jpg]]

=====GreetingStatus=====

{| border ="1"
! '''Class Name'''
|
GreetingStatus (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of greeting status types
|-
! '''XML Namespace'''
|
<nowiki>http://greeting.model.voicemail.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
DISABLED, ENABLED, ENABLED_UNTIL
|}

=====GreetingType=====

{| border ="1"
! '''Class Name'''
|
GreetingType (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of greeting types
|-
! '''XML Namespace'''
|
<nowiki>http://greeting.model.voicemail.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
STANDARD, ALTERNATE, MEETING, VACATION, EXTENDEDABSENCE, BUSY, CLOSED, INTERNAL
|}

=====RecordingType=====

{| border ="1"
! '''Class Name'''
|
RecordingType (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of recording types for a greeting
|-
! '''XML Namespace'''
|
<nowiki>http://greeting.model.voicemail.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
SYSTEM, USER, NONE
|}

=====Greeting=====

{| border ="1"
! '''Class Name'''
|
Greeting
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing configurations related to a specified greeting type for a given mailbox
|-
! '''XML Namespace'''
|
<nowiki>http://greeting.model.voicemail.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
enableUntil
|
DateTime
|
Must be specfied if greetingStatus is set to '''ENABLED_UNTIL'''. Value must be less than 365 days in the future.
|
Enable a greeting until the specified date and time.
|-
|
greetingStatus
|
GreetingStatus
|
|
Greeting status
|-
|
greetingType
|
GreetingType
|
|
Greeting type
|-
|
recordingType
|
RecordingType
|
|
Recording type for this greeting
|-
|
userRecording
|
UserRecording
|
|
Indicates if user recorded custom greeting is present
|}

=====UserRecording=====

{| border ="1"
! '''Class Name'''
|
UserRecording
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing user recorded custom greeting for a specified greeting type for a given mailbox
|-
! '''XML Namespace'''
|
<nowiki>http://greeting.model.voicemail.rest.aesop.cisco.com</nowiki>
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/voicemail/mailboxes/{ownerid}/greetings
|
GET
(retrieve greetings information for all greeting types)
|
|
BaseElementList Containing list of Greeting objects
|-
|
/voicemail/mailboxes/{ownerid}/greetings/{greetingtype}
|
GET
(Read Greeting information for a given greeting type)
|
|
Greeting
|-
|
/voicemail/mailboxes/{ownerid}/greetings/{greetingtype}
|
PUT
(Update greeting information)
|
Content-type: application/xml
Greeting
|-
|
/voicemail/mailboxes/{ownerid}/greetings/{greetingtype}/reset
|
PUT
(Reset information for a greeting type to system defaults)
|-
|
/voicemail/mailboxes/{ownerid}/greetings/{greetingtype}/recording
|
PUT
(Upload a custom recorded wav file as a greeting)
|
Content-type: audio/x-wav
Audio WAV file
|-
|
/voicemail/mailboxes/{ownerid}/greetings/{greetingtype}/recording
|
DELETE
(Delete any custom recording for greeting type)
|}

Cisco Unity Express -- Caller Call Flow REST PI Service Operation

2010-05-03T01:39:56Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Triggers REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Greetings REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Caller Call Flow===

====Classes====

'''Figure 24: Caller Call Flow'''

[[Image:CUE80_Caller Call Flow.jpg]]

=====CallflowAction=====

{| border ="1"
! '''Class Name'''
|
CallflowAction (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of callflow actions
|-
! '''XML Namespace'''
|
<nowiki>http://callercallflow.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
IGNORE, SKIP_GREETING, REPEAT_GREETING, TRANSFER_TO, TRANSFER_OPERATOR, SAY_GOODBYE, SUBSCRIBER_SIGNIN, KEY_DEFAULT
|}

=====DialPadKey=====

{| border ="1"
! '''Class Name'''
|
DialPadKey (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of keys on dial pad for which a call flow action could be defined
|-
! '''XML Namespace'''
|
<nowiki>http://callercallflow.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
ZERO, ONE, TWO, THREE, FOUR, FIVE, SIX, SEVEN, EIGHT, NINE, STAR, POUND
|}

=====KeyAction=====

{| border ="1"
! '''Class Name'''
|
KeyAction
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing a callflow action in response to a specified caller input
|-
! '''XML Namespace'''
|
<nowiki>http://callercallflow.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
key
|
DialPadKey
|
|
Key pressed by the caller
|-
|
callflowAction
|
CallflowAction
|
|
Callflow action to be executed
|-
|
transferNumber
|
String
|
|
The number to which the call is transferred if callflow action is specified as '''TRANSFER_TO'''
|}

=====CallerCallflow=====

{| border ="1"
! '''Class Name'''
|
CallerCallflow
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing mailbox configuration for caller call flow for specified caller inputs
|-
! '''XML Namespace'''
|
<nowiki>http://callercallflow.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
keyAction
|
KeyAction (collection)
|
|
List of Keyaction objects
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/voicemail/mailboxes/{ownerId}/callerflow
|
GET
|
|
CallerCallflow
|-
|
|
PUT
|
CallerCallflow
|}

Cisco Unity Express -- Triggers REST PI Service Operation

2010-05-03T01:39:40Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- User Defaults REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Caller Call Flow REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Triggers===

====Classes====

'''Figure 23: Trigger'''

[[Image:CUE80_Trigger.jpg]]

=====Trigger=====

{| border ="1"
! '''Class Name'''
|
Trigger
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing the SIP and JTPAI triggers
|-
! '''XML Namespace'''
|
<nowiki>http://trigger.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
appName
|
String
|
|
Name of the application to start when a trigger is entered
|-
|
enabled
|
Boolean
|
|
Enable or disable the trigger
|-
|
idleTimeout
|
Integer
|
|
The number of milliseconds to wait for a caller's response before the call is disconnected.
|-
|
locale
|
String
|
|
Language used for the system prompts that are heard by the caller when a trigger is activated.
|-
|
maxSessions
|
Integer
|
Maximum value is determined by the number of ports purchased for the application.
|
Maximum number of subscribers who can access a trigger simultaneously
|-
|
triggerId
|
String
|
|
For SIP and JTAPI trigger types, triggerId is the phone number that acts as the trigger to start the application on the JTAPI or SIP proxy server. The number value should be the last four digits of the full telephone number that callers dial to reach the auto attendant.

For trigger type HTTP, the trigger ID is the URL suffix string.
|-
|
type
|
TriggerType
|
|
Trigger type
|}

=====TriggerType=====

{| border ="1"
! '''Class Name'''
|
TriggerType (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of trigger types
|-
! '''XML Namespace'''
|
<nowiki>http://trigger.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
SIP

JTAPI

HTTP
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
!'''Return Value'''
|-
|
/triggers
|
GET
(read all triggers defined for all types)
|
|
BaseElementList Containing list of Trigger objects
|-
|
/triggers/{triggerType}
where triggerType is one of SIP, JTAPI or HTTP
|
POST
(define a new trigger of type triggerType)
|
Trigger
|-
|
/triggers/{triggerType}/{triggerId}
|
GET
(read a trigger)
|
|
Trigger
|-
|
|
PUT
(update a trigger)
|
Trigger
|-
|
|
DELETE
(delete a trigger)
|}

Cisco Unity Express -- User Defaults REST PI Service Operation

2010-05-03T01:39:24Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- SMTP Server REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Triggers REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===User Defaults===

====Classes====

'''Figure 22: User Defaults'''

[[Image:CUE80_User Defaults.jpg]]

=====UserDefaults=====

{| border ="1"
! '''Class Name'''
|
UserDefaults
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing the default global password and PIN policy settings for all users.
|-
! '''XML Namespace'''
|
<nowiki>http://userdefaults.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
enableExpiry
|
Boolean
|
|
Enable or disable system-wide password or pin expiry
|-
|
expiryDuration
|
Integer
|
Range 3-365
|
Maximum number of days for which subscribers'passwords or PIN are valid
|-
|
historyDepth
|
Integer
|
Range 1-10
|
Specifies how many of a user's previous passwords or PIN are compared to the new value.
|-
|
lockoutPolicy
|
LockoutPolicy
|
|
Specify whether subscribers are locked out permanently, or temporarily, when the maximum number of failed login attempts is reached.
|-
|
minLength
|
Integer
|
Range for password is 3-32

Range for PIN is 3-16
|
Minimum length of password or PIN
|-
|
permLockoutMaxFailures
|
Integer
|
|
Maximum number of failed attempts that will trigger a permanent lockout.
|-
|
tmpLockoutAttempts
|
Integer
|
|
Initial number of failed attempts that will trigger a temporary lockout.
|-
|
tmpLockoutDuration
|
Integer
|
|
Initial lockout duration for a temporary lockout (minutes).
|-
|
tmpLockoutMaxFailures
|
Integer
|
|
Maximum number of failed attempts that will trigger a temporary lockout.
|}

=====LockoutPolicy=====

{| border ="1"
! '''Class Name'''
|
LockoutPolicy (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of lockout policy types
|-
! '''XML Namespace'''
|
<nowiki>http://license.model.rest.aesop.cisco.com</nowiki>
|-
!'''Enum Values'''
|
DISABLED

PERMANENT

TEMPORARY
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/system/userdefaults/password
|
GET
(Read user password related default values)
|
|
UserDefaults
|-
|
|
PUT
(Update password related default values)
|
UserDefaults
|-
|
/system/userdefaults/pin
|
GET
(Read user PIN default values)
|
|
UserDefaults
|-
|
|
PUT
(Update default values for PIN )
|
UserDefaults
|}

Cisco Unity Express -- SMTP Server REST PI Service Operation

2010-05-03T01:38:58Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- NTP Server REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- User Defaults REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===SMTP Server===

====Classes====

'''Figure 21: SMTP Server'''

[[Image:CUE80_SMTP Server.jpg]]

=====SMTPServer=====

{| border ="1"
! '''Class Name'''
|
SMTPServer
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing SMTP server configuration
|-
! '''XML Namespace'''
|
<nowiki>http://smtp.settings.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
address
|
String
|
|
SMTP server address
|-
|
authRequired
|
Boolean
|
|
Boolean indicating if authentication is required by the SMTP server
|-
|
password
|
String
|
|
Password for SMTP server
|-
|
Port
|
Integer
|
|
Port number for SMTP server
|-
|
userName
|
String
|
|
User name to use with SMTP server
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/system/smtp/server
|
GET
(read SMTP server settings)
|
|
SMTPServer
|-
|
|
PUT
(update SMTP server settings)
|
SMTPServer
|}

Cisco Unity Express -- NTP Server REST PI Service Operation

2010-05-03T01:38:30Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- License Information REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- SMTP Server REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===NTP Server===

====Classes====

'''Figure 20: NTP Server'''

[[Image:CUE80_NTP Server.jpg]]

=====NTPServer=====

{| border ="1"
! '''Class Name'''
|
NTPServer
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing an NTP server
|-
! '''XML Namespace'''
|
<nowiki>http://ntp.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
address
|
String
|
|
Host name or IP address of the NTP server
|}

=====NTPServerList=====

{| border ="1"
! '''Class Name'''
|
NTPServerList
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing a list of NTP servers
|-
! '''XML Namespace'''
|
<nowiki>http://ntp.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
ntpServer
|
NTPServer (collection)
|
|
List of NTPServer objects
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/system/ntp/servers
|
GET
(read list of NTP servers configured)
|
|
NTPServerList
|-
|
|
PUT
(Update list of NTP servers)
|
NTPServerList
|-
|
|
POST
(Add an NTP server to the list)
|
NTPServer
|-
|
/system/ntp/servers/{address}
|
GET
(Read a NTP server )
|
|
NTPServer
|-
|
|
DELETE
(Remove NTP server )
|}

Cisco Unity Express -- License Information REST PI Service Operation

2010-05-03T01:38:15Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- System Information REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- NTP Server REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===License Information===

====Classes====

'''Figure 19: License Information'''

[[Image:CUE80_License Information.jpg]]

=====LicenseInfo=====

{| border ="1"
! '''Class Name'''
|
LicenseInfo
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
License information for various features
|-
! '''XML Namespace'''
|
<nowiki>http://license.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
count
|
Long
|
|
Total licenses available for a feature
|-
|
featureName
|
String
|
|
Feature name
|-
|
priority
|
LicensePriority
|
|
License priority enumeration value
|-
|
state
|
LicenseFeatureState
|
|
License state enumeration value
|-
|
type
|
LicenseType
|
|
License type enumeration value
|-
|
usage
|
Long
|
|
Number of licenses used
|-
|
validityPeriod
|
Integer
|
|
Validity period of the license (in hours)
|-
|
validityPeriodRemaining
|
Integer
|
|
Validity perriod remaining (in seconds)
|}

=====LicenseFeatureState=====

{| border ="1"
! '''Class Name'''
|
LicenseFeatureState (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of license states
|-
! '''XML Namespace'''
|
<nowiki>http://license.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
ACTIVE_IN_USE

ACTIVE_NOT_IN_USE

ACTIVE_NOT_IN_USE_EULA_ACCEPTED

ACTIVE_NOT_IN_USE_EULA_NEEDED

LICENSE_STATE_INACTIVE
|}

=====LicenseType=====

{| border ="1"
! '''Class Name'''
|
LicenseType (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of license types
|-
! '''XML Namespace'''
|
<nowiki>http://license.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
PERMANENT

TRIAL

UNKNOWN
|}

=====LicensePriority=====

{| border ="1"
! '''Class Name'''
|
LicensePriority (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration of license priority types
|-
! '''XML Namespace'''
|
<nowiki>http://license.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
HIGH

MEDIUM

LOW
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/system/licenses/info
|
GET
(read licenses)
|
|
BaseElementList containing list of LicenseInfo objects
|}

Cisco Unity Express -- System Information REST PI Service Operation

2010-05-03T01:38:00Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- DNS Configuration REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- License Information REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===System Information===

====Classes====

'''Figure 18: System Information'''

[[Image:CUE80_System Information.jpg]]

=====SystemInfo=====

{| border ="1"
! '''Class Name'''
|
SystemInfo
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
System DNS configuration settings
|-
! '''XML Namespace'''
|
<nowiki>http://sysinfo.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
chasisSerial
|
String
|
|
Chasis serial number
|-
|
chasisType
|
String
|
|
Chasis type
|-
|
memorySize
|
Integer
|
|
Memory size of the module (MB)
|-
|
moduleSerial
|
String
|
|
Module serial number
|-
|
moduleType
|
String
|
|
Module type
|-
|
upTime
|
Long
|
|
System up time (seconds)
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/system/info
|
GET
(read system information)
|
|
SystemInfo
|}

Cisco Unity Express -- DNS Configuration REST PI Service Operation

2010-05-03T01:37:45Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Login Banner REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- System Information REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===DNS Configuration===

====Classes====

'''Figure 17: DNS Settings'''

[[Image:CUE80_DNS Settings.jpg]]

=====DNS=====

{| border ="1"
! '''Class Name'''
|
DNS
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
System DNS configuration settings
|-
! '''XML Namespace'''
|
<nowiki>http://dns.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
hostName
|
String
|
|
Hostname where CUE is located
|-
|
domainName
|
String
|
|
Domain name in which CUE is located
|-
|
dnsServers
|
DNSServerList
|
|
List of DNS servers to be used
|}

=====DNSServerList=====

{| border ="1"
! '''Class Name'''
|
DNSServerList
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
List of DNS Servers
|-
! '''XML Namespace'''
|
<nowiki>http://dns.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
dnsServer
|
DNSServer
(collection)
|
|
List of DNS servers to be used
|}

=====DNSServer=====

{| border ="1"
! '''Class Name'''
|
DNSServer
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
A DNS Server
|-
! '''XML Namespace'''
|
<nowiki>http://dns.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
address
|
String
|
|
Address of the DNS server
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/system/dns
|
GET
(read DNS settings)
|
|
DNS
|-
|
|
PUT
(update DNS settings)
|
DNS
(including DNSServerList)
|-
|
/system/dns/servers
|
GET
(read list of DNS servers configured)
|
|
DNSServerList
|-
|
|
PUT
(update the list of DNS servers)
|
DNSServerList
|-
|
|
POST
(Add a DNS server to the list of configured DNS servers)
|
DNSServer
|-
|
/system/dns/servers/{dnsServerAddress}
|
GET
(Read DNSServer)
|
DNSServer
|-
|
|
DELETE
(Remove a DNS server from the lust of DNS servers configured)
|}

====DNS configuration examples====

=====Update DNS settings=====

* Data for the DNS settings is read from local file ./data/dns_data.xml.
* Changed atributes are dnsServers (DNS Server list) and hostName.
* Notice that DNSServer to be configured can be referenced either by resource URI or address.
$ cat data/dns_data.xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dns>
<dnsServers>
<dnsServer>
<address>5.6.7.8</address>
</dnsServer>
<dnsServer>
<resourceURI>/system/dns/servers/1.2.3.4</resourceURI>
</dnsServer>
<dnsServer>
<resourceURI>/system/dns/servers/1.2.3.5</resourceURI>
</dnsServer>
</dnsServers>
<hostName>newhostname</hostName>
</dns>

$ curl -i -X PUT -H 'Authorization: Basic Y2lzY286Y2lzY28=' -H 'Content-type: application/xml' -d
@./data/dns_data.xml <nowiki>http://172.27.104.144/rest/system/dns</nowiki>
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=B86ADA2D33F944576E8814824B42AAC6; Path=/rest
PI-Version: 8.0.0.150
Content-Type: application/xml
Transfer-Encoding: chunked
Date: Mon, 07 Dec 2009 09:44:34 GMT
Updated - /system/dns

=====Read DNS settings=====

$ curl -i -X GET -H 'Authorization: Basic Y2lzY286Y2lzY28=' <nowiki>http://172.27.104.144/rest/system/dns</nowiki>
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=A0333BDEA9895E0EC8B77D8D60EBFA53; Path=/rest
PI-Version: 8.0.0.150
Content-Type: application/xml
Transfer-Encoding: chunked
Date: Mon, 07 Dec 2009 09:44:42 GMT

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dns>
<resourceURI>/system/dns</resourceURI>
<dnsServers>
<resourceURI>/system/dns/servers</resourceURI>
<dnsServer>
<resourceURI>/system/dns/servers/5.6.7.8</resourceURI>
<address>5.6.7.8</address>
</dnsServer>
<dnsServer>
<resourceURI>/system/dns/servers/1.2.3.4</resourceURI>
<address>1.2.3.4</address>
</dnsServer>
<dnsServer>
<resourceURI>/system/dns/servers/1.2.3.5</resourceURI>
<address>1.2.3.5</address>
</dnsServer>
</dnsServers>
<domainName>localdomain</domainName>
<hostName>newhostname</hostName>
</dns>

=====Remove a DNS Server=====

'''Remove a DNS server (address 1.2.3.4) from DNS server list configured'''

$ curl -i -X DELETE -H 'Authorization: Basic Y2lzY286Y2lzY28=' <nowiki>http://172.27.104.144/rest/system</nowiki>
/dns/servers/1.2.3.4
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=A50578616C1B282056169F1521CAEBCC; Path=/rest
PI-Version: 8.0.0.150
Content-Type: application/xml
Transfer-Encoding: chunked
Date: Mon, 07 Dec 2009 10:04:06 GMT
Removed - /system/dns/servers/1.2.3.4

Cisco Unity Express -- Login Banner REST PI Service Operation

2010-05-03T01:37:29Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Subsystem SIP REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- DNS Configuration REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Login Banner===

====Classes====

'''Figure 16: Login Banner'''

[[Image:CUE80_Login Banner.jpg]]

=====LoginBanner=====

{| border ="1"
! '''Class Name'''
|
LoginBanner
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Represents system-wide login message that is displayed to all users when they log in.
|-
! '''XML Namespace'''
|
<nowiki>http://banner.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
bannerMessage
|
String
|
Max Length 1944
|
Banner message will be displayed. Following tokens in the banner-content represent system settings,
$(hostname) - Displays the hostname for the module.
$(domain) - Displays the domain for the module.
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/system/banner
During the GET operation use query parameter expand to replace the variable in the login message by its value.
/system/banner?expand=true
|
GET
(read login banner settings)
|
|
LoginBanner
|-
|
|
PUT
(update login banner)
|
LoginBanner
|}

Cisco Unity Express -- Subsystem SIP REST PI Service Operation

2010-05-03T01:37:14Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Subsystem JTAPI REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Login Banner REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Subsystem SIP===

====Classes====

'''Figure 15: Subsystem SIP'''

[[Image:CUE80_Subsystem SIP.jpg]]

=====SubsystemSIP=====

{| border ="1"
! '''Class Name'''
|
SubsystemSIP
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Represents Session Initiation Protocol (SIP) related configurations
|-
! '''XML Namespace'''
|
<nowiki>http://sip.subsystem.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
cstaKeepAlive
|
Integer
|-
|
cstaSessionServerId
|
String
|-
|
dtmfRelayList
|
DTMRelayList
|
|
SIP DTMF relay mechanism. List of values of type DTMFRelay.
|-
|
fullRFC3261Compliance
|
Boolean
|
|
Set to TRUE for configuration to work with newer IOS images (12.4(2T) and later)
|-
|
includeMWIEnvelopeInfo
|
Boolean
|
|
Set to TRUE to enable the inclusion of envelope information in SIP MWI notifications.
|-
|
mwiNotifyList
|
MWINotify (collection)
|
|
MWI notification mechanism. List of values of type MWINotify.
|-
|
sipGWIPAddress
|
String
|
|
Hostname or IP address of the SIP Provider
|-
|
sipGWPortNumber
|
Integer
|
|
UDP or TCP Port of the SIP Proxy
|-
|
transferMode
|
TransferMode
|
|
SIP call transfer method
|}

=====DTMFRelay=====

{| border ="1"
! '''Class Name'''
|
DTMFRelay ''(Enumeration Class)''
|-
! '''Extends From'''
|
BaseElement
|-
! '''Description'''
|
Enumeration for SIP DTMF relay mechanism type
|-
! '''XML Namespace'''
|
<nowiki>http://sip.subsystem.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
'''INFO''' (Uses the Info message to relay outgoing DTMF signals from Cisco Unity Express to the Cisco IOS SIP gateway)

'''RTP_NTE''' (Uses the media path to relay incoming and outgoing DTMF signals to Cisco Unity Express)

'''SIP_NOTIFY''' (Uses Unsolicited-Notify messages to relay incoming and outgoing DTMF signals)

'''SUB_NOTIFY''' (Uses Subscribe and Notify messages to relay for incoming DTMF signals to Cisco Unity Express. This option is not available for outgoing DTMF signals from Cisco Unity Express)
|}

=====MWINotify=====

{| border ="1"
! '''Class Name'''
|
MWINotify (Enumeration Class)
|-
! '''Extends From'''
|
BaseElement
|-
! '''Description'''
|
Enumeration for message waiting indicator (MWI) notification mechanism
|-
! '''XML Namespace'''
|
<nowiki>http://sip.subsystem.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
'''NOTIFY_OUTCALL''' (Sends MWI notifications using the SIP outcall mechanism)

'''NOTIFY_UNSOLICITED''' (Sends MWI notifications using the Unsolicited Notify mechanism)

'''NOTIFY_SUBSCRIBE''' (Sends MWI notifications using the Subscribe Notify mechanism)
|}

=====TransferMode=====

{| border ="1"
! '''Class Name'''
|
TransferMode (Enumeration Class)
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration for transfer mode for SIP calls
|-
! '''XML Namespace'''
|
<nowiki>http://sip.subsystem.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
'''REFER_ATTENDED''' (Transfers SIP calls as attended transfers. The transfer is complete when the destination extension answers the call)

'''REFER_SEMI_ATTENDED''' (Transfers SIP calls as semi-attended transfers. The transfer is complete when the destination extension is ringing)

'''REFER_BLIND''' (Transfers SIP calls as blind refer calls)

'''BLIND_BYE_ALSO''' (Transfers SIP calls as blind bye-also calls)
|}

====Resources====

{| border ="1"
!'''Resource URI'''
!'''Operation'''
!'''Input'''
!'''Return Value'''
|-
|
/subsystem/sip
|
GET
|
|
SubsystemSIP
|-
|
|
PUT
|
SubsystemSIP
|}

Cisco Unity Express -- Subsystem JTAPI REST PI Service Operation

2010-05-03T01:36:58Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Fax Settings REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Subsystem SIP REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Subsystem JTAPI===

====Classes====

'''Figure 14: Subsystem JTAPI'''

[[Image:CUE80_Subsystem JTAPI.jpg]]

=====SubsystemJTAPI=====

{| border ="1"
! '''Class Name'''
|
SubsystemJTAPI
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Represents system-level JTAPI related configuration.
|-
! '''XML Namespace'''
|
<nowiki>http://jtapi.subsystem.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
ccmAddressList
|
StringList
|
|
List of IP address or hostname of Cisco Unified Communications Manager servers.
|-
|
ccmCTIPortList
|
IntegerList
|
|
List of Cisco Unified Communications Manager CTI ports.
|-
|
ccmEncodedCredential
|
String
|
During the update operation, '''ccmEncodedCredential''' and plain text credentials ('''ccmUserName''', '''ccmPassword''') cannot be specified together.
|
Cisco Unified Communications Manager JTAPI username and password in encrypted form
|-
|
ccmUserName
|
String
|
During the update operation, '''ccmEncodedCredential''' and plain text credentials ('''ccmUserName''', '''ccmPassword''') cannot be specified together.
|
CUCM JTAPI user name
|-
|
ccmPassword
|
String
|
During update operation, '''ccmEncodedCredential''' and plain text credentials ('''ccmUserName''', '''ccmPassword''') cannot be specified together.
|
CUCM password for JTAPI user
|-
|
mwiPortNumber
|
Integer
|
|
CUCM CTI port to use for MWI
|-
|
ctiPortCSS
|
RedirectCSS
|
|
Calling search space used to redirect calls from CTI ports to elsewhere.
|-
|
routePointCSS
|
RedirectCSS
|
|
Calling search space used to redirect calls from route points to CTI ports
|}

=====RedirectCSS=====

{| border ="1"
! '''Class Name'''
|
RedirectCSS ''(Enumeration Class)''
|-
! '''Extends From'''
|
BaseElement
|-
! '''Description'''
|
Enumeration for calling search space to use while redirecting calls
|-
! '''XML Namespace'''
|
<nowiki>http://jtapi.subsystem.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
'''CALLING_PARTY''' (Use the original calling party's calling search space to redirect)

'''REDIRECTING_PARTY''' (Use the redirecting party's calling search space to redirect)

''' CCM''' (default calling search space)
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/subsystem/jtapi
|
GET
|
|
SubsystemJTAPI
|-
|
|
PUT
|
SubsystemJTAPI
|}

Cisco Unity Express -- Fax Settings REST PI Service Operation

2010-05-03T01:36:43Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Scripts REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Subsystem JTAPI REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Fax Settings===

====Classes====

'''Figure 13: Fax Settings'''

[[Image:CUE80_Fax Settings.jpg]]

=====FaxPrintNumber=====

{| border ="1"
! '''Class Name'''
|
Script
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing a system-level fax number to use for printing faxes.
|-
! '''XML Namespace'''
|
<nowiki>http://fax.settings.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
number
|
String
|
|
E.164 fax number
|-
|
siteName
|
String
|
String "local" is used as the local site name.
|
Name of the remote site for which to configure the system-level fax number.
|}

=====FaxSettings=====

{| border ="1"
! '''Class Name'''
|
FaxSettings
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
System level fax configurations
|-
! '''XML Namespace'''
|
<nowiki>http://fax.settings.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
defaultEmailFrom
|
String
|
|
From "e-mail address to use as the default.
|-
|
outgoingFaxGW
|
String
|
|
Hostname for the outgoing Cisco IOS fax gateway.
|-
|
incomingFaxGWlist
|
IncomingFaxGWList
|
|
Hostname for the incoming Cisco IOS fax gateway.
|-
|
printNumber
|
FaxPrintNumber (collection)
|
|
Collection of fax print numbers
|-
|
restrictionTable
|
RestrictionTable
|
|
Fax number restriction table
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/system/fax
|
GET
(read fax settings)
|
|
FaxSettings
|-
|
|
PUT
(update fax settings)
|
FaxSettings
|-
|
|
DELETE
(delete privilege)
|}

Cisco Unity Express -- Scripts REST PI Service Operation

2010-05-03T01:36:27Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Restriction Tables REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Fax Settings REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Scripts===

====Classes====

'''Figure 12: Script'''

[[Image:CUE80_Script.jpg]]

=====Script=====

{| border ="1"
! '''Class Name'''
|
Script
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing a system script file.
|-
! '''XML Namespace'''
|
<nowiki>http://script.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
scriptName
|
String
|
|
Script file name
|-
|
isSystem
|
Boolean
|
|
Boolean indicating if it is a system script file (cannot be deleted if system script).
|-
|
creationDate
|
String
|
|
Creation date for the file.
|-
|
lastModifyDate
|
String
|
|
Last modify date
|-
|
scriptType
|
ScriptType
|
Enumeration (AA, IVR)
|-
|
size
|
Integer
|
|
Size of the script file in bytes.
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/scripts
|
GET
(Read all scripts details)
|
|
BaseElementList (Script)
|-
|
/scripts/{scriptname}

While uploading binary script file, use query parameter '''overwrite''' if a file with same name exist already.

/scripts/{scriptname}?overwrite=true
|
PUT
(Upload a script file)
|
Content-type: application/octet-stream

Binary Script file to be uploaded
|-
|
|
GET
(Download a script file)
|
Accept: application/octet-stream
|
Script binary file
|-
|
|
GET
(Read Script information)
|
Accept: application/xml
|
Script
|-
|
|
DELETE
(Delete a script from server)
|}

Cisco Unity Express -- Restriction Tables REST PI Service Operation

2010-05-03T01:36:11Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Language and Prompts REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Scripts REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Restriction Tables===

====Classes====

'''Figure 11: Restriction Table'''

[[Image:CUE80_Restriction Table.jpg]]

=====RestrictionTable=====

{| border ="1"
! '''Class Name'''
|
RestrictionTable
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class for defining rules for checking if outgoing calls to a given phone number are allowed or not.
|-
! '''XML Namespace'''
|
<nowiki>http://restriction.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
tableName
|
String
|
Length 2-32
|
Name of the restriction table.
|-
|
maxDigits
|
Integer
|
Range 1-30

Default 30
|
Maximum number of digits allowed in the outgoing phone number.
|-
|
minDigits
|
String
|
Range 1-30

Default 1
|
Minimum number of digits required in the outgoing phone number.
|-
|
dialString
|
DialString (collection)
|
Maximum 10 dial strings supported
|
Collection of dial string patterns determining if the otugoing call is allowed or restricted.
|}

=====DialString=====

{| border ="1"
! '''Class Name'''
|
Prompt
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Represents the pattern oh phone numbers allowed or disallowed.
|-
! '''XML Namespace'''
|
<nowiki>http://restriction.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
dialPattern
|
String
|
Valid characters are digits 0 to 9, asterisk (*), or dot (.).
|
Call pattern to be matched. The table accepts duplicate call patterns.
|-
|
preference
|
Integer
|
|
Order of this string in the restriction table. The system searches the strings in order of preference.
|-
|
allowed
|
Boolean
|
|
If True, permits phone numbers with this pattern.
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/restrictions
|
GET
(Read all restriction tables)
|
|
BaseElementList Containing list of RestrictionTable objects.
|-
|
|
POST
(create a restriction table)
|
RestrictionTable
(including DialString list)
|-
|
/restrictions/{tablename}
|
GET
(read a restriction table)
|
|
RestrictionTable
(includes list of DialString)
|-
|
|
PUT
(update a restriction table)
|
RestrictionTable
(including DialString list)
|-
|
|
DELETE
(delete a restriction table)
|-
|
/restrictionTables/{tablename}/dialStrings
|
GET
(Get list of DialString patterns defined in the restriction table)
|
|
BaseElementList containing list of DialString objects
|-
|
|
POST
(Add a dial string pattern to restriction table)
|
DialString
|-
|
/restrictionTables/{tablename}/dialStrings/{preference}
|
GET
(Read dial string pattern by preference)
|
|
DialString
|-
|
|
PUT
(Change the dial string pattern at a particular preference in the restriction table)
|
DialString
|-
|
|
DELETE
(Delete dial string by preference)
|}

Cisco Unity Express -- Language and Prompts REST PI Service Operation

2010-05-03T01:35:55Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Business Schedule and Holidays REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Restriction Tables REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Language and Prompts===

====Classes====

'''Figure 10: Language and Prompt'''

[[Image:CUE80_Language and Prompt.jpg]]

=====Language=====

{| border ="1"
! '''Class Name'''
|
Language
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Represents a language installed in the system.
|-
! '''XML Namespace'''
|
<nowiki>http://language.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
locale
|
String
|
Specified as xx_YY where xx is the langugage code and YY is the country code. For example, en_US.
|
Locale name represented by this language.
|-
|
language
|
String
|
|
Full language name. For example, "English" for locale "en_US".
|-
|
country
|
String
|
|
Full country name. For example, "United States" for locale value "en_US".
|}

=====Prompt=====

{| border ="1"
! '''Class Name'''
|
Prompt
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Represents a prompt file installed in the system.
|-
! '''XML Namespace'''
|
<nowiki>http://language.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
promptName
|
String
|
|
Name of the prompt file.
|-
|
size
|
Integer
|
Read Only
|
Size of the file (in Bytes)
|-
|
creationDate
|
String
|
Read Only
|
Date when the prompt file was created
|}

====Resources====

=====Language=====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/languages
|
GET
(read all languages installed)
|
BaseElementList
(containing list of Language objects)
|-
|
/languages/{lang}
|
GET
(Read an installed language)
|
|
Language
|-
|
/languages/default
|
GET
(Read system default language)
|
|
Language
|-
|
|
PUT
(Set a language as system default)
|
Language
|}

=====Prompts=====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/languages/{language}/prompts/user
|
GET
(read information about all prompts)
|
|
BaseElementList
(containing list of Prompt objects)
|-
|
/languages/{language}/prompts/user/{promptname}

While uploading audio wav file, use query parameter '''overwrite''' to replace any file with the same name.

/languages/{language}/prompts/user/{prompt name}?overwrite=true
|
GET
(Read information about an installed prompt)
|
Accept: application/xml
|
Prompt
|-
|
|
GET (Download the audio wav file for a prompt)
|
Accept: audio/x-wav
|
The prompt audio wav file
|-
|
|
PUT
Update prompt (change prompt file name)
|
Content-type: application/xml

Prompt
|-
|
|
PUT
(Upload prompt audio wav file)
|
Content-type: audio/x-wav

Prompt wav file
|-
|
|
DELETE
(Delete prompt file from server)
|}

Cisco Unity Express -- Business Schedule and Holidays REST PI Service Operation

2010-05-03T01:35:38Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Applications REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Language and Prompts REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Business Schedule and Holidays===

====Classes====

'''Figure 9: Business Schedule'''

[[Image:CUE80_Business Schedule.jpg]]

=====Day =====

{| border ="1"
! '''Class Name'''
|
Day ''(Enumeration Class)''
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration for days of the week.
|-
! '''XML Namespace'''
|
<nowiki>http://schedule.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
SUN, MON, TUE, WED, THU, FRI, SAT, MON_FRI, SAT_SUN, ALL
|}

=====HalfHourlyTime=====

{| border ="1"
! '''Class Name'''
|
HalfHourlyTime ''(Enumeration Class)''
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration for dividing 24 Hour day into half hourly slots.
|-
! '''XML Namespace'''
|
<nowiki>http://schedule.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
T_0000 (00:00Hrs), T_0030 (00:30Hrs), T_0100 (01:00Hrs)
|-
|
|
...
|-
|
|
...
|-
|
|
T_2300 (23:00Hrs), T_2330 (23:30Hrs), T_2400 (00:00Hrs)
|}

=====State=====

{| border ="1"
! '''Class Name'''
|
State ''(Enumeration Class)''
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration for denoting the state during a given schedule slot. In the context of busness schedule it denotes the open or close state.
|-
! '''XML Namespace'''
|
<nowiki>http://schedule.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
ACTIVE (business is open), INACTIVE (business is closed)
|}

=====ScheduleTuple =====

{| border ="1"
! '''Class Name'''
ScheduleTuple
|-
! '''Extends From'''
|
BaseElement
|-
! '''Description'''
|
Class representing a single record in the business hour schedule.
|-
! '''XML Namespace'''
|
<nowiki>http://schedule.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
ACTIVE (business is open), INACTIVE (business is closed)
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
day
|
Day
|
|
Day of the week to which this tuple applies. The day could be a range value like ALL or MON_FRI or and individual day of the week.
|-
|
timeFrom
|
HalfHourlyTime
|
|
The start time of the time range.
|-
|
timeTo
|
HalfHourlyTime
|
|
The end time of the time range.
|-
|
state
|
State
|
|
Mark the time range represented by this tuple as open (Active) or closed (Inactive).
|}

=====BusinessSchedule=====

{| border ="1"
! '''Class Name'''
|
BusinessSchedule
|-
! '''Extends From'''
|
Schedule
|-
! '''Description'''
|
Class representing business hours schedule (open and close hours).
|-
! '''XML Namespace'''
|
<nowiki>http://bschedule.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
ACTIVE (business is open), INACTIVE (business is closed)
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
scheduleName
|
String
|
Length 2 -64
|
Schedule name
|-
|
scheduleTuples
|
Collection <ScheduleTuple>
|
|
Collection of tuples indicating open and close hours.
|}

=====Holiday=====

{| border ="1"
! '''Class Name'''
|
Holiday
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing a business holiday.
|-
! '''XML Namespace'''
|
<nowiki>http://holiday.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
mmdd
|
String
|
|
Holiday month and day
|-
|
year
|
String
|
Year must be specified as "fixed" or as yyyy. Value could be current -1, current or current + 1 year).
|
Holiday year
|-
|
description
|
String
|
|
Holiday description
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/businessSchedules
|
GET
(read all business schedules defined)
|
|
BaseElementList Containing list of BusinessSchedule objects.
|-
|
|
POST
(define a new business schedule)
|
BusinessSchedule
|-
|
/businessSchedules/{schedulename}
|
GET
(read a business schedule)
|
|
BusinessSchedule
|-
|
|
PUT
(update a business schedule)
|
BusinessSchedule
|-
|
|
DELETE
(delete a business schedule)
|-
|
/holidays
|
GET
(Read all holidays defined)
|
|
BaseElementList Containing list of Holiday objects.
|-
|
/holidays/fixed
|
GET
(Read all fixed holidays defined)
|
|
BaseElementList Containing list of Holiday objects.
|-
|
|
POST
(Create a fixed holiday)
|
Holiday
|-
|
/rest/holidays/fixed/(mmdd)
|
GET
(Define a new fixed holiday for date mmdd}
|
|
Holiday
|-
|
|
PUT
(Update a fixed holiday)
|
Holiday
|-
|
|
DELETE
(Delete a fixed holiday)
|-
|
/holidays/{yyyy}
|
GET
(Read all holidays defined for a given year yyyy)
|
|
BaseElementList Containing list of Holiday objects.
|-
|
|
POST
(Create a holiday in a given year)
|
Holiday
|-
|
/rest/holidays/{yyyy}/{mmdd}
|
GET
(Define a new holiday for a given year yyyy and date mmdd}
|
|
Holiday
|-
|
|
PUT
(Update a holiday)
|
Holiday
|-
|
|
DELETE
(Delete a holiday)
|}

Cisco Unity Express -- Applications REST PI Service Operation

2010-05-03T01:35:23Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Operations and Privileges REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Business Schedule and Holidays REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Applications===

====Classes====

'''Figure 8: Application'''

[[Image:CUE80_Application.jpg]]

=====Application=====

{| border ="1"
! '''Class Name'''
|
Application
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing configuration for a CCN application.
|-
! '''XML Namespace'''
|
<nowiki>http://application.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
appName
|
String
|
Length 2 -64
|
Application name
|-
|
appDescription
|
String
|
|
Description for the application.
|-
|
appType
|
ApplicationType
|
Enumeration
|
Application type (AA or IVR).
|-
|
cfgVars
|
OptionalParamter
|
Parameters passed must be specified in the application script.
|
Configuration parameter name and value pairs for the application script.
|-
|
enabled
|
Boolean
|
|
Specifies if the application is enabled.
|-
|
maxSessions
|
Integer
|
|
Specifies the maximum number of subscribers who can access the application simultaneously.
|-
|
scriptName
|
String
|
Script must exist on the the system.
|
Specifies the script to be used by the application.
|}

=====ApplicationType=====

{| border ="1"
! '''Class Name'''
|
ApplicationType ''(Enumeration Class)''
|-
! '''Extends From'''
|
BaseElement
|-
! '''Description'''
|
Enumerates supported application types.
|-
! '''XML Namespace'''
|
<nowiki>http://application.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
AA, IVR
|}

=====OptionalParameter=====

{| border ="1"
! '''Class Name'''
|
OptionalParameter
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Class representing script parameter name and value pair for a CCN application.
|-
! '''XML Namespace'''
|
<nowiki>http://application.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
name
|
String
|
Length 2 -64
|
Parameter name
|-
|
type
|
String
|
Read Only
|
Specifies the data type (Java) of the parameter.
|-
|
value
|
String
|
|
Value for the parameter.
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/applications
To filter the query results based on application type use query parameter "appType" -
|
GET
(read all applications defined)
|
|
BaseElementList Containing list of Application objects.
|-
|
/applications?appType=AA
/applications?appType=IVR
|
POST
(define a new application)
|
Application
|-
|
/applications/{applicationName}
|
GET
(read an application)
|
|
Application
|-
|
|
PUT
(update an application)
|
Application
|-
|
|
DELETE
(delete an application)
|}

Cisco Unity Express -- Operations and Privileges REST PI Service Operation

2010-05-03T01:35:06Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Mailbox REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Applications REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Operations and Privileges===

====Classes====

'''Figure 7: Privilege and Operation'''

[[Image:CUE80_Privilege and Operation.jpg]]

=====Privilege=====

{| border ="1"
! '''Class Name'''
|
Privilege
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Represent privileges which could be assigned to groups.
|-
! '''XML Namespace'''
|
<nowiki>http://privilege.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
name
|
String
|
Required for create
Length 0 - 31
|
Label used to identify and configure privilege.
|-
|
description
|
String
|
Length 0-59
|
Description for the privilege.
|-
|
operations
|
Operation
(collection)
|
minOccurs="0" maxOccurs="unbounded"
|
Collection of operations associated with the privilege.
|}

=====Operation=====

{| border ="1"
! '''Class Name'''
|
Operation
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Represent operations which could be assigned to a Privilege.
|-
! '''XML Namespace'''
|
<nowiki>http://privilege.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
name
|
String
|
Length 0 -15
|
Label used to identify the privilege.
|-
|
description
|
String
|
Length 0-59
|
Description for the privilege.
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/privileges
|
GET
(read all privileges)
|
|
BaseElementList containing "Privilege" objects (includes Operations for each Privilege).
|-
|
|
POST
(create a privilege)
|
Privilege
(including operations for the privilege)
|-
|
/privileges/{privilegeName}
|
GET
(read a privilege)
|
|
Privilege (includes Operations for the privilege)
|-
|
|
PUT
(update privilege)
|
Privilege
(including operations for the privilege)
|-
|
|
DELETE
(delete privilege)
|-
|
/operations
|
GET
(read all Operations)
|
|
BaseElementList containing "Operation" objects
|-
|
/operations/{operationName}
|
GET
(read an Operation)
|
|
Operation
|}

====Privilege Examples====

=====Create Privilege=====

Create a privilege named "privilge.xyz".

* Data for the new privilege is read from local file ./data/create_xyz.xml.
* Notice that operations to be assigned to the privilege can be referenced either by resource URI or operation name.

$ cat data/create_xyz.xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<privilege>
<description>Description for test privilege</description>
<name>privilege.xyz</name>
<operations>
<resourceURI>/operations/call.control</resourceURI>
</operations>
<operations>
<name>group.configuration</name>
</operations>
</privilege>

$ curl -i -X POST -H 'Authorization: Basic Y2lzY286Y2lzY28=' -H 'Content-type:
application/xml' -d @./data/create_xyz.xml
<nowiki>http://172.27.104.144/rest/privileges</nowiki>
HTTP/1.1 201 Created
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=BD5415DC8B97F994A09CC80902262670; Path=/rest
PI-Version: 8.0.0.150
Location: <nowiki>http://172.27.104.144/rest/privileges/privileges/privilege.xyz</nowiki>
Content-Type: text/plain
Transfer-Encoding: chunked
Date: Mon, 07 Dec 2009 08:03:16 GMT

Created - /privileges/privilege.xyz

Cisco Unity Express -- Mailbox REST PI Service Operation

2010-05-03T01:34:50Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- User and Group Management REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Operations and Privileges REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Mailbox===

====Classes====

'''Figure 6: Mailbox and MailboxUsage'''

[[Image: CUE80_Mailbox and MailboxUsage.jpg]]

=====Mailbox=====

{| border ="1"
! '''Class Name'''
|
Mailbox
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Represents voicemail mailbox for a subscriber or group.
|-
! '''XML Namespace'''
|
<nowiki>http://mailbox.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
ownerId
|
String
|
Required for create operation
Length 2 -31
|
userId or groupId of the mailbox owner
|-
|
announcementOnly
|
Boolean
|
|
Specifies that the mailbox cannot be used to leave messages. It is can only be used to make announcements.
|-
|
description
|
String
|
Length 0-64
|
Text description for the mailbox.
|-
|
enabled
|
Boolean
|
|
Denotes if the mailbox is activated or deactivated.
|-
|
faxEnabled
|
Boolean
|
|
Specifies whether the mailbox is enabled to receive faxes from the fax gateway.
|-
|
mailboxSize
|
Integer
|
|
Specifies the storage size of the mailbox, in seconds.
|-
|
messageExpiry
|
Integer
|
Range 1-365
|
Specifies the length of time in days that messages can be stored in the mailbox.
|-
|
messageSize
|
Integer
|
Range 10-3600
|
Specifies the maximum length in seconds of a message that can be stored in the mailbox.
|-
|
playTutorial
|
Boolean
|
|
Specifies whether the tutorial should be played. The default is enabled.
|-
|
pinlessLogin
|
PinlessLogin
|
|
Options for allowing voicemail subscribers to login to their mailbox without any PIN. Used for personal mailboxes only.
|-
|
usage
|
MailboxUsage
|
Read Only
|
Various data related to the mailbox usage. It is accessed during GET call only.
|}

=====PinlessLogin=====

{| border ="1"
! '''Class Name'''
|
PinlessLogin ''(Enumeration Class)''
|-
! '''Extends From'''
|
|-
! '''Description'''
|
Enumerates options for allowing voicemail subscribers to login to their mailbox without any PIN using either TUI or VoiceView Express (VVE). A subscriber can login into his mailbox without a PIN either from his primary extension or from any other phone based on the "pinlessLogin" configuration for that subscriber. For personal mailboxes only.
|-
! '''XML Namespace'''
|
<nowiki>http://mailbox.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
AnyPhone, SubscribersPhone, Disabled
|}

=====MailboxUsage=====

{| border ="1"
! '''Class Name'''
|
MailboxUsage
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Used for displaying various usage parameters for a voicemail mailbox. The data provided by this class is read only and not used during POST and PUT operations.
|-
! '''XML Namespace'''
|
<nowiki>http://mailbox.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
broadcastMessagesCount
|
Integer
|
|
Number of broadcast messages in the mailbox.
|-
|
deletedMessagesCount
|
Integer
|
|
Number of messages deleted from the mailbox.
|-
|
faxMessagesCount
|
Integer
|
|
Number of faxes in the mailbox.
|-
|
futureMessagesCount
|
Integer
|
|
Number of messages scheduled for future delivery.
|-
|
inUse
|
Boolean
|
|
Current activity state of the mailbox.
|-
|
lastAccessed
|
String
|
|
Time stamp for when the mailbox was last accessed.
|-
|
newMessagesCount
|
Integer
|
|
Number of new messages in the mailbox.
|-
|
savedMessagesCount
|
Integer
|
|
Number of saved messages in the mailbox.
|-
|
timeUsed
|
Integer
|
|
Number of seconds used for currently stored messages.
|-
|
totalMessagesCount
|
Integer
|
|
Number of all stored messages in the mailbox.
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/voicemail/mailboxes
|
GET
(read all mailboxes)
|
|
BaseElementList containing "Mailbox" objects.
|-
|
|
POST
(create a mailbox)
|
Mailbox
|-
|
/voicemail/mailboxes/{ownerid}
(ownerid can be either userId or groupId)
|
GET
(read a mailbox for a given ownerid)
|
|
Mailbox
|-
|
|
PUT
(update mailbox for ownerid)
|
Mailbox
|-
|
|
DELETE
(delete mailbox owned by ownerid)
|-
|
/voicemail/mailboxes/{ownerid}/usage
|
GET
(Read usage for a given mailbox)
|
|
MailboxUsage
|}

====Mailbox Examples====

=====Create Mailbox for a User=====

Create mailbox for user userX. Data for the new mailbox is read from local file ./data/create_mailbox_userx.xml.

$ cat ./data/create_mailbox_userx.xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mailbox>
<ownerId>userX</ownerId>
<announcementOnly>false</announcementOnly>
<description>A test mailbox</description>
<enabled>true</enabled>
<faxEnabled>true</faxEnabled>
<mailboxSize>4320</mailboxSize>
<messageExpiry>30</messageExpiry>
<messageSize>240</messageSize>
<pinlessLogin>Disabled</pinlessLogin>
<playTutorial>true</playTutorial>
</mailbox>

$ curl -i -X POST -H 'Authorization: Basic Y2lzY286Y2lzY28=' -H 'Content-type:
application/xml' -d @./data/create_mailbox_userx.xml
<nowiki>http://172.27.104.144/rest/voicemail/mailboxes</nowiki>

HTTP/1.1 201 Created
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=683EAEECEC68455363B8553AB5D153CC; Path=/rest
PI-Version: 8.0.0.150
Location: <nowiki>http://172.27.104.144/rest/voicemail/mailboxes/voicemail/mailboxes/userX</nowiki>
Content-Type: text/plain
Transfer-Encoding: chunked
Date: Fri, 04 Dec 2009 09:11:12 GMT

Created - /voicemail/mailboxes/userX

=====Read Selective Fields from all Mailboxes=====

Read fields mailboxSize and description for all mailboxes.

$ curl -i -X GET -H 'Authorization: Basic Y2lzY286Y2lzY28='
<nowiki>http://172.27.104.144/rest/voicemail/mailboxes?fields=description,mailboxSize</nowiki>

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=2D3751D30B72DA71426F6BD88591FE1A; Path=/rest
PI-Version: 8.0.0.150
Content-Type: application/octet-stream
Transfer-Encoding: chunked
Date: Fri, 04 Dec 2009 09:27:50 GMT

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<baseElementList>
<baseElement xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>"
xmlns:ns3="<nowiki>http://mailbox.model.rest.voicemail.aesop.cisco.com</nowiki>"
xsi:type="ns3:mailbox">
<resourceURI>/voicemail/mailboxes/userX</resourceURI>
<description>A test mailbox</description>
<mailboxSize>4320</mailboxSize>
</baseElement>
<baseElement xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance<nowiki>"
xmlns:ns3="<nowiki>http://mailbox.model.rest.voicemail.aesop.cisco.com<nowiki>"
xsi:type="ns3:mailbox">
<resourceURI>/voicemail/mailboxes/groupX</resourceURI>
<description>GDM for group X</description>
<mailboxSize>4320</mailboxSize>
</baseElement>
</baseElementList>

Cisco Unity Express -- User and Group Management REST PI Service Operation

2010-05-03T01:34:30Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- Common Base Classes REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- Mailbox REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===User and Group Management===

====Classes====

'''Figure 5: User and Group Management'''

[[Image:CUE80_User and Group Management.jpg]]

=====User=====

{| border ="1"
! '''Class Name'''
|
User
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
This class represents a subscriber in a CUE system.
|-
! '''XML Namespace'''
|
<nowiki>http://user.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
userId
|
String
|
Required for POST (create) operation
Length 2-31
|
Specifies the name or ID of the subscriber to be created. The username must be at least 3 and no more than 32 characters in length. CUE allows only letters, numbers, underscore (_), dot (.), and dash (-) in user IDs. User IDs must start with a letter. Do not use spaces in the username.
|-
|
firstName
|
String
|
Length 0-59
|
First name of a user. Callers use these names to access the extension using the dial-by-name feature. Cannot contain special characters, spaces, or numbers.
|-
|
lastName
|
String
|
Length 0-59
|
Last name of a user. Callers use these names to access the extension using the dial-by-name or numbers.
|-
|
nickName
|
String
|
Length 0-59
|-
|
displayName
|
String
|
Length 0-59
|
User's name displayed within CUE applications.
|-
|
phoneNumberE164
|
String
|
Length 0-15
|
Full telephone number, including area code, for the subscriber.
|-
|
phoneNumber
|
String
|
Length 0-15
|
Extension or number for this subscriber.
|-
|
faxNumber
|
String
|
Length 0-15
|-
|
password
|
String
|
Length 3-32
|
Password for the subscriber. Valid values contain at least 3 but not more than 32 characters in length. Spaces are not allowed. Acceptable password characters are lowercase letters a to z, uppercase letters A to Z, digits 0 to 9, and the following symbols: - , . + = _ ! @ # $ ^ * ( ) ? / ~ < > & %.
|-
|
pin
|
String
|
Length 3 -16
|
Personal identification number for the subscriber. Valid values are at least 3 but not more than 19
characters in length, consisting of letters and numbers. No other characters are permitted.
|-
|
language
|
String
|
Language locale string of the form xx_YY (where xx is the two letter language code and YY is the two letter country code).
|
Language of the prompts played to the user.
|-
|
email
|
String
|
Length 0 - 320
|
Email address of the subscriber.
|-
|
epage
|
String
|
Length 0 - 320
|
Epage address of the subscriber.
|-
|
generateOptions
|
GenerateCredentialsOptions
|
For write only (To be used only during the POST and PUT operations).
|
Used for specifying options for generating password and pin during create and update operation.
|-
|
spokenName
|
SpokenName
|
For Read only
|
This field indicates if a spoken name is configured for the user.
|}

=====GenerateCredentialsOptions=====

{| border ="1"
! '''Class Name'''
|
GenerateCredentialsOptions ''(Enumeration Class)''
|-
! '''Extends From'''
|-
! '''Description'''
|
Enumeration class used specifying options for auto credential generation during user create and delete operations.
|-
! '''XML Namespace'''
|
<nowiki>http://user.model.rest.aesop.cisco.com</nowiki>
|-
! '''Enum Values'''
|
GenerateBlank, GenerateRandom, UserSpecified
|}

=====Spoken Name=====

{| border ="1"
! '''Class Name'''
|
SpokenName
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
This class represents the configured spoken name for a user. It does not define and fields locally and contains only the "resourceURI" field inherited from the parent class.
|-
! '''XML Namespace'''
|
<nowiki>http://user.model.rest.aesop.cisco.com</nowiki>
|}

=====VmUser=====

{| border ="1"
! '''Class Name'''
|
VmUser
|-
! '''Extends From'''
|
User
|-
! '''Description'''
|
This class represents voicemail subscribers in CUE system. It does not define and fields locally and inherits all its field from the base class "User".
|-
! '''XML Namespace'''
|
<nowiki>http://user.model.rest.voicemail.aesop.cisco.com</nowiki>
|}

=====Group=====

{| border ="1"
! '''Class Name'''
|
Group
|-
! '''Extends From'''
|
ManagedBaseElement
|-
! '''Description'''
|
Represents "groups" in CUE system. Usually created to manage privileges for a group of users.
|-
! '''XML Namespace'''
|
<nowiki>http://user.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
groupId
|
String
|
Required for POST (create) operation
Length 2-31
|
Name of the group.
|-
|
description
|
String
|
Length 0-40
|
For providing a brief description about the group.
|-
|
displayName
|
String
|
Length 0-59
If no value is specified during create, system will assign a value using groupId field value.
|
Full group name. Callers use the full name to access the extension using the dial-by-name feature.
|-
|
email
|
String
|
Length 0 - 320
|
Email address of the group.
|-
|
epage
|
String
|
Length 0 - 320
|
Epage address of the group.
|-
|
privilege
|
Privilege
|
minOccurs="0"
maxOccurs="unbounded"
|
Collection of privilege objects assigned to this group.
|-
|
spokenName
|
SpokenName
|
For Read only
|
This field indicates if a spoken name is configured for the user.
|}

=====VmGroup=====

{| border ="1"
! '''Class Name'''
|
VmGroup
|-
! '''Extends From'''
|
Group
|-
! '''Description'''
|
Represents "groups" in CUE system. Usually created to manage privileges for a group of users and to assign members to a general-delivery mailbox. Inherits all the fields from base class "Group", as well as define local fields specific to voicemail-related features.
|-
! '''XML Namespace'''
|
<nowiki>http://user.model.rest.voicemail.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
faxNumber
|
String
|
Length 0 -15
|
Group fax number
|-
|
phoneNumberE164
|
String
|
Length 0-15
|
Full telephone number, including area code for the group.
|-
|
phoneNumber
|
String
|
Length 0-15
|
Primary extension for the group's general-delivery mailbox.
|}

====Resources====

{| border ="1"
! '''Resource URI'''
! '''Operation'''
! '''Input'''
! '''Return Value'''
|-
|
/voicemail/users
|
GET
(read all users)
|
|
BaseElementList containing "VmUser" objects.
|-
|
|
|
POST
create user)
|
VmUser
|-
|
/voicemail/users/{userid}
|
GET
(read a user)
|
|
VmUser
|-
|
|
PUT
(update a user)
|
VmUser
|-
|
|
DELETE
(delete user)
|-
|
/voicemail/users/{userid}/groupmemberships
|
GET
(read groups where this user is a member)
|
|
BaseElementList containing "VmGroup" objects
|-
|
|
POST
(add this user to a group as member)
|
VmGroup
(Only Resource URI)
|-
|
/voicemail/users/{userid}/groupmemberships/{groupid}
|
DELETE
(remove this user from a group as member)
|-
|
/voicemail/users/{userid}/groupownerships
|
GET
(read groups where this user is an owner)
|
|
BaseElementList containing "VmGroup" objects
|-
|
|
POST
(add this user to a group as owner)
|
VmGroup
(Only Resource URI)
|-
|
/voicemail/users/{userid}/groupownerships/{groupid}
|
DELETE
(remove this user as owner from a group)
|-
|
/voicemail/users/{userid}/spokenname
|
GET
(download spoken name for this user)
|
Accept: audio/x-wav
|
Audio wav file of spoken name for user
|-
|
|
PUT
(Upload audio wav file for spoken name for user)
|
Content-type: audio/x-wav
|-
|
/voicemail/groups
|
GET
(read all groups)
|
|
BaseElementList containing "VmGroup" objects
|-
|
|
POST
(create a new group)
|
VmGroup
(including group's Privileges)
|-
|
/voicemail/groups/{groupid}
|
PUT
(update a group)
|
VmGroup
(including group's Privileges)
|-
|
|
GET
(read a group)
|
|
VmGroup
(including group's Privileges
|-
|
|
DELETE
(delete group)
|-
|
/voicemail/groups/{groupid}/groupmemberships
|
GET
(read groups where this group is a member)
|
|
BaseElementList containing "VmGroup" objects
|-
|
|
POST
(add the addressed group as member of another group)
|
VmGroup
(Resource URI only)
|-
|
/voicemail/groups/{groupid}/groupmemberships/{groupid}
|
DELETE
(remove the addressed group as member from another group)
|-
|
/voicemail/groups/{groupid}/groupownerships
|
GET
(read groups where this group is an owner)
|
|
BaseElementList containing "VmGroup" objects
|-
|
|
PUT
(add the addressed group as member of another group)
|
VmGroup
(Resource URI only)
|-
|
/voicemail/groups/{groupid}/groupownerships/{groupid}
|
DELETE
(remove the addressed group as owner of another group)
|-
|
/voicemail/groups/{groupid}/members
|
GET
(read all members of a group)
|
|
BaseElementList containing "VmGroup" and "VmUser" objects
|-
|
|
POST
(add a user or group as member to this group)
|
VmUser or VmGroup
|-
|
/voicemail/groups/{groupid}/members/{memberId}
|
DELETE
(remove a member from this group)
|-
|
/voicemail/groups/{groupid}/owners
|
GET
(read all owners of this group)
|
|
BaseElementList containing "VmGroup" and "VmUser" objects
|-
|
|
POST
(add a user or group as owner to this group)
|
VmUser or VmGroup
|-
|
/voicemail/groups/{groupid}/owners/{ownerId}
|
DELETE
(remove an owner from this group)
|-
|
/voicemail/groups/{groupid}/privileges
|
GET
(get list of privileges for this group)
|
|
BaseElementList containing "Privilege" objects
|-
|
|
POST
(Add a privilege to this group)
|
Privilege (with Resource URI or name)
(to set multiple privileges for a group use update group operation)
|-
|
/voicemail/groups/{groupid}/privileges/{privilegeName}
|
DELETE
(Remove a privilege from this group)
|-
|
/rest/groups/{groupid}/spokenname
|
GET
(download spoken name for group)
|
Accept: audio/x-wav
|
Audio wav file of spoken name for user
|-
|
|
PUT
(Upload spoken name for group)
|
Content-type: audio/x-wav
|}

====User and Group Examples====

=====Create User=====

Create a new user. Data for the new user is read from local file data/create_userx.xml.

$ cat data/create_userx.xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vmUser>
<displayName>Mr. X Yzee</displayName>
<email>email_xyz@email.com</email>
<epage>epage_xyz@address.com</epage>
<firstName>Axe</firstName>
<language>en_US</language>
<lastName>Yzee</lastName>
<nickName>xyz</nickName>
<phoneNumber>1010</phoneNumber>
<phoneNumberE164>213151273</phoneNumberE164>
<pin>1234</pin>
<generateOptions>
<passwordOption>GenerateRandom</passwordOption>
</generateOptions>
<userId>userX</userId>
</vmUser>

$ curl -i -X POST -H 'Authorization: Basic Y2lzY286Y2lzY28=' -H 'Content-type: application/xml'
-d @./data/create_userx.xml <nowiki>http://172.27.104.144/rest/voicemail/users</nowiki>

HTTP/1.1 201 Created
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=CDE84ED1DFCC25FA7F8029EE0C27E755; Path=/rest
PI-Version: 8.0.0.150
Location: <nowiki>http://172.27.104.144/rest/voicemail/users/voicemail/users/userX</nowiki>
Content-Type: text/plain
Transfer-Encoding: chunked
Date: Fri, 04 Dec 2009 02:11:43 GMT
Created - /voicemail/users/userX

=====Read All Users=====

Read all users. Specify only first name and lastName fields to be included in the results.

$ curl -i -X GET -H 'Authorization: Basic Y2lzY286Y2lzY28=' <nowiki>http://172.27.104.144/rest/voicemail</nowiki>
/users?fields=firstName,lastName

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=441971AE997CDD32051F45F1544A8231; Path=/rest
PI-Version: 8.0.0.150
Content-Type: application/xml
Transfer-Encoding: chunked
Date: Fri, 04 Dec 2009 02:03:00 GMT

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<baseElementList>
<baseElement xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>"
xmlns:ns3="<nowiki>http://user.model.rest.voicemail.aesop.cisco.com</nowiki>" xsi:type="ns3:vmUser">
<resourceURI>/voicemail/users/userX</resourceURI>
<firstName>Axe</firstName>
<lastName>Yzee</lastName>
</baseElement>
<baseElement xmlns:xsi="<nowiki>http://www.w3.org/2001/XMLSchema-instance</nowiki>"
xmlns:ns3="<nowiki>http://user.model.rest.voicemail.aesop.cisco.com</nowiki>" xsi:type="ns3:vmUser">
<resourceURI>/voicemail/users/cisco</resourceURI>
<firstName>first</firstName>
<lastName>cisco</lastName>
</baseElement>
</baseElementList>

=====Create Group=====

Create a Group. Data for the new group is read from local file ./data/create_groupy.xml.

$ cat data/create_groupy.xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vmGroup>
<description>GroupY</description>
<displayName>GroupWhy</displayName>
<email>email@noreply.com</email>
<groupId>groupY</groupId>
<language>en_US</language>
<privilege>
<resourceURI>/privileges/tcv-payroll</resourceURI>
</privilege>
<privilege>
<name>ViewHistoricalReports</name>
</privilege>
<privilege>
<name>ManagePublicList</name>
</privilege>
<privilege>
<resourceURI>/privileges/ManagePrompts</resourceURI>
</privilege>
</vmGroup>

$ curl -i -X POST -H 'Authorization: Basic Y2lzY286Y2lzY28=' -H 'Content-type: application/xml'
-d @./data/create_groupy.xml <nowiki>http://172.27.104.144/rest/voicemail/groups</nowiki>
HTTP/1.1 201 Created
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=3B975C8500C143DB10E47B4970DDB2C0; Path=/rest
PI-Version: 8.0.0.150
Location: <nowiki>http://172.27.104.144/rest/voicemail/groups/voicemail/groups/groupY</nowiki>
Content-Type: text/plain
Transfer-Encoding: chunked
Date: Fri, 04 Dec 2009 06:15:16 GMT
Created - /voicemail/groups/groupY

=====Add User to a Group=====

Add userX as member to groupY. Input data is read from local file ./data/userx.xml.

$ cat ./data/userx.xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vmUser>
<userId>userX</userId>
</vmUser>

$ curl -i -X POST -H 'Authorization: Basic Y2lzY286Y2lzY28=' -H 'Content-type: application/xml'
-d @./data/userx.xml
<nowiki>http://172.27.104.144/rest/voicemail/groups/groupY/members</nowiki>

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=58D138AD5DE9ECCBD801D86F0518755C; Path=/rest
PI-Version: 8.0.0.150
Content-Type: text/plain
Transfer-Encoding: chunked
Date: Fri, 04 Dec 2009 06:22:57 GMT

Added userX as member to Group - groupY

=====Remove User from a Group=====

Remove userX as member of groupY.

$ curl -i -X DELETE -H 'Authorization: Basic Y2lzY286Y2lzY28='
<nowiki>http://172.27.104.144/rest/voicemail/groups/groupY/members/userX</nowiki>

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=C182CA0E8CF34573508C6D31E99DA6A4; Path=/rest
PI-Version: 8.0.0.150
Content-Type: text/plain
Transfer-Encoding: chunked
Date: Fri, 04 Dec 2009 06:34:46 GMT

Removed userX as member of Group - groupY

=====Upload Spoken Name for Group=====

Upload spoken name for groupX. The spoken name is uploaded from local wav file data/groupX.upload.wav

$ curl -i -T ./data/groupX.upload.wav -H 'Authorization: Basic Y2lzY286Y2lzY28=' -H
'Content-type: audio/x-wav'
<nowiki>http://172.27.104.144/rest/voicemail/groups/groupX/spokenname</nowiki>
HTTP/1.1 100 Continue

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=6EDB5242A677B1CD6495DD96A2D5D256; Path=/rest
PI-Version: 8.0.0.150
Content-Type: text/plain
Transfer-Encoding: chunked
Date: Fri, 04 Dec 2009 06:38:50 GMT

Uploaded - /voicemail/groups/groupX/spokenname

$ curl -i -X GET -H 'Authorization: Basic Y2lzY286Y2lzY28='
<nowiki>http://172.27.104.144/rest/voicemail/groups/groupX</nowiki>
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=A98FDBA862CD2DFAC7DE079ACE304678; Path=/rest
PI-Version: 8.0.0.150
Content-Type: application/xml
Content-Length: 488
Date: Fri, 04 Dec 2009 06:42:44 GMT

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vmGroup>
<resourceURI>/voicemail/groups/groupX</resourceURI>
<description>Group X's Description</description>
<displayName>Group Hacks</displayName>
<email>email@noreply.com</email>
<groupId>groupX</groupId>
<language>en_US</language>
<spokenName>
<resourceURI>/voicemail/groups/groupX/spokenname</resourceURI>
</spokenName>
<faxNumber>56908762</faxNumber>
<phoneNumber>7654</phoneNumber>
<phoneNumberE164>4083925174</phoneNumberE164>
</vmGroup>

Cisco Unity Express -- Common Base Classes REST PI Service Operation

2010-05-03T01:34:10Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Previous page:''' [[Cisco Unity Express -- XML Schema Download REST PI Service Operation]]

'''Next page:''' [[Cisco Unity Express -- User and Group Management REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Common Base Classes===
This section provides details about various common classes defined by the CUE PI service data model. These classes do not represent any specific resource in the system; therefore, no operations are defined in this section.

'''Figure 4: Common Base Classes'''

[[Image:CUE80_Common Base Classes.jpg]]

====BaseElement ====
{| border ="1"
! '''Class Name'''
|
BaseElement
|-
! '''Description'''
|
This abstract class is the base entity in which all the other classes within the CUE PI service data model extend. It serves as a marker interface to identify a class as part of the CUE PI service data model.
|-
! '''XML Namespace'''
|
<nowiki>http://base.model.rest.aesop.cisco.com</nowiki>
|}

====ManagedBaseElement====

{| border ="1"
! '''Class Name'''
|
ManagedBaseElement
|-
! '''Extends From'''
|
BaseElement
|-
! '''Description'''
|
This abstract class is the base class representing all uniquely addressable resources in the CUE PI service data model. All elements in the data model having a resource URI extend from this class directly or indirectly.
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
resourceURI
|
String
|
Max length - 2000
|
Resource URI for this resource
|}

====BaseElementList====

{| border ="1"
! '''Class Name'''
|
BaseElementList
|-
! '''Extends From'''
|-
! '''Description'''
|
This class serves as container for collection of BaseElement objects. Most GET operations returning a collection of objects package the result as an instance of BaseElementList.
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
baseElement
|
BaseElement (collection)
|
minOccurs="0"
maxOccurs="unbounded"
|
Collection of BaseElement objects
|}

====ErrorResponse ====

{| border ="1"
! '''Class Name'''
|
ErrorResponse
|-
! '''Extends From'''
|
BaseElement
|-
! '''Description'''
|
This class is used for reporting error when server fails to process the client request. The information provided through this class is in addition to the HTTP status code provided for the client request.
|-
! '''XML Namespace'''
|
<nowiki>http://base.model.rest.aesop.cisco.com</nowiki>
|-
! '''Field Name'''
! '''Type'''
! '''Constraints'''
! '''Comments'''
|-
|
errorCode
|
int
|
minOccurs="0"
|
Error code assigned by the CUE PI service. These error codes are defined specific to the CUE PI service and are not to be confused with the HTTP status code provided by the service separately.
|-
|
errorMessage
|
String
|
minOccurs="0"
|
Message description of the error condition and possible cause.
|-
|
additionalInfo
|
String
|
minOccurs="0"
|
Used for providing root cause information if available.
|}

Cisco Unity Express -- XML Schema Download REST PI Service Operation

2010-05-03T01:33:51Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Next page:''' [[Cisco Unity Express -- Common Base Classes REST PI Service Operation]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===XML Schema Download===
{| border ="1"
! '''Resource URI'''
|
/schema
|-
! '''Resource Description'''
|
XML schema documents for the CUE PI service data model
|
|-
! '''Operation'''
! '''MIME'''
! '''Returns'''
|-
|
Get (Download XML schema)
|
Accept: application/octet-stream
|
Compressed (gzip) tar file containing set of XSD files
|}

Example: Download the schema and save it in file named "schema.tar.gz" in the current directory. (For downloads, do not use CURL with -i option as it adds the HTTP headers to the output).
$ curl -o ./schema.tar.gz -X GET -H 'Authorization: Basic Y2lzY286Y2lzY28=' -H 'Accept:
application/octet-stream'
<nowiki>http://172.27.104.144/rest/schema</nowiki>
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 6731 0 6731 0 0 171k 0 --:--:-- --:--:-- --:--:-- 3986k

Schema files can be extracted from the compressed files using tar command on Linux/Unix based platforms. (Use WinZip or 7-Zip on Windows platforms).
tar xvfz ./schema.tar.gz
rest_schema/schema10.xsd
rest_schema/schema11.xsd
rest_schema/schema12.xsd
rest_schema/schema13.xsd
rest_schema/schema14.xsd
...
...

Cisco Unity Express -- References

2010-05-03T01:33:31Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

'''Previous page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

==Cisco Unity Express -- Programmatic Interface Service Programming Guide References==

Ref[1] Wikipedia article on Representational State Transfer (REST)
http://en.wikipedia.org/wiki/RESTful

Ref[2] JSR-000311 JAX-RS: The Java API for RESTful Web Services
http://jcp.org/aboutJava/communityprocess/final/jsr311/index.html

Ref[3] Sun Jersey, JAX-RS Reference Implementation
https://jersey.dev.java.net/

Ref[4] Jersey Client API
https://jersey.dev.java.net/nonav/apidocs/1.1.2-ea/jersey/com/sun/jersey/api/client/package-summary.html

Ref[5] Consuming RESTful Web Services With the Jersey Client API
http://blogs.sun.com/enterprisetechtips/entry/consuming_restful_web_services_with

Ref[6] Apache Jakarta Commons HttpClient
http://jakarta.apache.org/commons/httpclient/

Ref[7] JAXB - Java Architecture for XML Binding
https://jaxb.dev.java.net<font color=/

Ref[8] Cisco Unity Express Voice-Mail and Auto-Attendant CLI Administrator Guide for 3.0 and Later Versions
http://www.cisco.com/en/US/docs/voice_ip_comm/unity_exp/rel7_1/administrator/AA_and_VM/vmCLIadmin_7_1_book.html

Ref[9] Cisco Unity Express - Command Reference
http://www.cisco.com/en/US/products/sw/voicesw/ps5520/prod_command_reference_list.html

<font size = "1">Copyright 2010, Cisco Systems</font>

Cisco Unity Express -- REST PI Service Operations

2010-05-03T01:33:12Z

Mnapalan:

Cisco Unity Express -- REST PI Service Conventions

2010-05-03T01:32:54Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

'''Previous page:''' [[Cisco Unity Express -- Client Software Choices]]

'''Next page:''' [[Cisco Unity Express -- REST PI Service Operations]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

===Resource URI===
The CUE PI service defines a URI for each of its resources (for example, Users, Groups, Mailboxes, and so on). Typically, resource URI represents nouns instead of verbs; in other words, resources are things and not actions.

Clients can determine the resource URI for various resources in the following possible ways:

# By referring to this document to determine how to construct the resource URI for a given resource.
# When a resource created by invoking POST operation on the CUE PI service, the resource URI of the resource created is provided as part of the HTTP response header (Refer to section 5.2.2 for details).
# Resource URI is included with each resource returned when a read operation is performed by calling HTTP GET on the CUE PI service.

The resource URI for individual resources published in this document, as well as those returned by GET operations on the CUE PI service, does not include protocol, hostname, and port. Clients can create the fully qualified URL for the resource by prepending the CUE hostname and PI service application name "rest". For example,
the published resource URI for a voicemail subscriber profile is:

/voicemail/users/{userId}

Thus, the fully qualified resource URI for a subscriber with userId "johndoe" on a CUE system host named "cue_host" would be:

<nowiki>http://cue_host/rest/voicemail/users/johndoe</nowiki>

The above resource URI represents a single entity, a user with id "johndoe". A resource URI can also represent a collection of entities in the system. For example, a collection of users in the system is represented by the resource:

<nowiki>http://myhost/rest/voicemail/users</nowiki>

Association relationships between resources is also represented through resource URI structure. For example a collection, of subscribers belonging to a group named "admin" is represented by the resource:

<nowiki>http://myhost/rest/voicemail/groups/admin/users</nowiki>

Some resource URIs support HTTP query parameters that clients could append to the resource URI to fine tune the result set or choose available update options. Query parameters where supported are documented in this guide.

===HTTP Methods===
This sections describes the list of HTTP methods supported by the CUE PI service. The following table provides the list of supported HTTP methods with mapping to the actual operations performed on the resource addressed in the request.

'''Table 1: HTTP to CRUD Operation Mapping'''

{| border ="1"
! '''HTTP Method'''
! '''CRUD Operation'''
|-
|
Post
|
Create Resource
|-
|
Get
|
Read Resource
|-
|
Put
|
Update Resource
|-
|
Delete
|
Delete Resource
|}

====GET Operation====
GET method is used for retrieving a resource. A GET request is safe, that is, it does not cause a change in system state besides generation of logging and audit information. While processing the GET request, the HTTP message entity is not checked by the CUE PI service and all the required information to read the resource is obtained from the resource URI and query parameters (if supported) only.

'''GET using Query parameter "fields" with Resource URI -'''

When a GET operation is performed on a resource, the CUE PI service by default includes all the fields defined for the resource. However, for most of the resources defined in the CUE PI service, clients can customize the set of fields returned by specifying a query parameter named "fields" with value as comma separated list of fields to be included in the result. The client can also specify a blank field set to retrieve the resource URI.

For example, to retrieve only the "firstName" and "lastName" fields for a subscriber having userId "johnDoe", the client needs to perform GET on URI:

<nowiki>http://rest/voicemail/users/johnDoe?fields=firstName,lastName</nowiki>

To retrieve the resource URI of all users, the client can specify an explicit blank field set:

<nowiki>http://rest/voicemail/users?fields=%</nowiki>

A field name in the list would be ignored if it is not applicable for the resource being queried. The result set will contain only those fields which are part of the resource definition. If no valid field name is provided, the result will only include the resource URI for the resource.

Any additional query parameter supported for a resource is documented along with the resource definition.
An unrecognized query parameter will be ignored and query will perform as if no query parameter is specified in the URI.

====POST Operation====
HTTP POST operation is used for creating new instances of a resource. The CUE PI service obtains the representation of the resource to be created from the HTTP message entity. If the POST operation results in a successful creation of a resource, the CUE PI service responds with HTTP status code 201 (CREATED) and provides the resource URI of the newly created resource as value for HTTP response header "location".

====PUT Operation====
PUT operation is used for updating information about an existing resource. While processing the PUT request for a resource, the CUE PI service will update only those fields specified explicitly in the resource payload. To set a field to blank value, it needs to be included in the payload with an empty field value.

====DELETE Operation====
HTTP DELETE operation is used to delete a resource. While processing the delete request, the HTTP message entity is not checked by the CUE PI service and all the required information to delete the resource is obtained from the resource URI and query parameters (if supported) only.

===HTTPS Support===
HTTP is plain text-based protocol so sensitive data sent over HTTP are not secured. For added security, the CUE PI service supports HTTPS as a communication protocol.

The client can configure the system to enable HTTPS for all web applications, including PI, by using existing CUE CLI. Please refer to Cisco Unity Express Administrator Guide for details on steps for enabling HTTPS in a CUE system.

If CUE system is enabled for HTTPS mode and request is made using HTTP protocol, request will be redirected to the client suggesting use of "HTTPS" in the request.

===Authentication===
For authorizing client operations, the CUE PI service expects clients to provide valid credentials with every HTTP request made to the service.

* Username and Password must be set in request header "Authorization", as per the basic access authentication scheme. For basic access authentication, the user name is appended with a colon and concatenated with the password. The resulting string is encoded with the Base64 algorithm and passed in the HTTP request as "Authorization" header.

----

This example shows generation of authorization string for user name Aladdin and password open sesame:

* User-name and password are concatenated with a colon in the middle to get the string
Aladdin:open sesame
* The string '''Aladdin:open sesame''' is Base64 encoded resulting in authorization string '''QWxhZGRpbjpvcGVuIHNlc2FtZQ=='''
If using Linux CLI:
$ echo -n "Aladdin:open sesame" | openssl enc -base64
QWxhZGRpbjpvcGVuIHNlc2FtZQ==
* The Base64 encoded string is passed with HTTP requests using '''Authorization''' header:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

----

* CUE PI service requires that the user credentials passed are of "superuser" privilege. The "superuser" privilege will be verified by the implementation as part of the authentication process. If the user does not have the " superuser " privilege, the request will fail. Please refer to Cisco Unity Express Administrator Guide for information on configuring a user with "superuser" privilege.

===MIME Types===
Most of the resources defined by the CUE PI service use XML representation. Some resource also support binary content like prompts, greetings, and binary script files. While making POST and PUT requests, clients must set the "Content-type" header to the appropriate mime type value. While making GET calls, the client can choose to specify the MIME type in the "Accept" header.

The mime to be used for all resource definitions provided in this document, if not specified otherwise, is "application/xml".

===Error Handling and Response Codes===
The CUE PI service uses standard HTTP status codes (1xx, 2xx, 4xx, 5xx) for indicating the status of the client action requests. In general, 2xx status codes are success status code and 4xx/5xx is used for non-success status.

When CU PI service fails to process the client request, either because of the error in client supplied data or internal failure in the server, the service will choose an appropriate HTTP status code to return to the client.

In most error cases, in addition to the HTTP status code, the service will also provide detailed error response as XML document. The XML error response document (section 6.2.4) will contain a CUE PI service defined error code, error message, and some additional information about the error condition.

===API Versioning and Backward Compatibility===
The CUE PI service provides product version information in the HTTP response header for every response it sends to the client. Clients can examine the response header "PI-Version" to extract the string value specifying the product version information.

This is the first release of the CUE PI service and any future versions of the service are expected to be backward compatible with clients that are still using previous versions of XML schema.

To achieve backward compatibility in the future versions, both client and the CUE PI service needs to follow certain implementation guidelines that are explained as follows:

* API Elements Are Forever (Applies to Server)
That is, once an element of an API (URI, Representation, Method, Fields) is published, it cannot be removed in subsequent versions. This rule is crucial for ensuring compatibility between an older client and a newer service.
* Ignore Unrecognized Elements (Applies to Client)
If a client receives elements within a representation that it does not know how to process, then it must silently ignore it. This rule ensures compatibility between an older client communicating with a newer version of service with new elements defined in the schema.
* Apply Defaults For Missing Elements (Applies to Server)
If the service does not receive an element within a representation that it needs, it must silently assume a default value for that element. This rule provides backward compatibility, where a newer service is able to interface with an older client.

Cisco Unity Express -- Client Software Choices

2010-05-03T01:32:27Z

Mnapalan:

Cisco Unity Express -- Quick Start for RESTful Web Services

2010-05-03T01:32:10Z

Mnapalan:

Cisco Unity Express -- RESTful Web Services

2010-05-03T01:31:50Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

'''Next page:''' [[Cisco Unity Express -- Quick Start for RESTful Web Services]]

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

----

REST is a software architecture style for distributed systems. RESTful web services are services built using the REST architecture. A RESTful web service is based on the following design principles:

* Resources and representations - Resources are entities or pieces of specific information made accessible by a RESTful web service. Each resource is referenced with a unique Uniform Resource Identifier (URI). The client and the RESTful service interact with each other by exchanging the representations of these resources. A RESTful web service also specifies the type of representation supported for each of the resource type. XML, HTML, and JavaScript Object Notation (JSON) are some of the popular representation types used by RESTful web services.
*:Example - A subscriber's voice mailbox is a resource exposed by the CUE PI service. The CUE PI service provides and accepts XML representation for this resource.

* Uniform Interface - A RESTful service provides a uniform set of operations for all the resources. RESTful web services typically map the four main HTTP methods POST, GET, PUT, and DELETE to the operations they perform, that is, create, retrieve, update, and delete, respectively.

* Statelessness - Each request from client to server must contain all the information necessary to understand the request and cannot take advantage of any stored context on the server. In other words, the web service is not responsible for keeping any information about the state of its clients. The client is responsible for tracking its own actions (if it needs to).

Cisco Unity Express -- Client Software Choices

2010-05-03T01:30:59Z

Mnapalan:

Cisco Unity Express -- Quick Start for RESTful Web Services

2010-05-03T01:30:32Z

Mnapalan:

Cisco Unity Express -- RESTful Web Services

2010-05-03T01:30:10Z

Mnapalan:

Cisco Unity Express -- RESTful Web Services

2010-05-03T01:29:54Z

Mnapalan:

Cisco Unity Express

2010-05-01T15:01:10Z

Mnapalan:

{{Template:Required Metadata}}

==Cisco Unity Express Documentation on the Cisco DocWiki==

Currently only the following Cisco Unity Express documentation is hosted on the Cisco DocWiki:
* [[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

==Printing the PI Programming Guide as a PDF==

The following page describes how to produce a PDF of all the pages of the Cisco Unity Express PI Programming Guide:
* [[Cisco Unity Express -- PDF Print Page]]

==Other Cisco Unity Express Documentation==

The majority of the documentation for Cisco Unity Express, for all releases, can be found on Cisco.com here: http://www.cisco.com/en/US/products/sw/voicesw/ps5520/tsd_products_support_series_home.html.

==Disclaimer for Recording a Conversation==

The use of monitoring, recording, or listening devices to eavesdrop, monitor, retrieve, or record phone conversations or other sound activities, whether or not contemporaneous with transmission, may be illegal in certain circumstances under federal, state and/or local laws. Legal advice should be sought prior to implementing any practice that monitors or records any phone conversation. Some laws require some form of notification to all parties to a phone conversation, such as by using a beep tone or other notification method or requiring the consent of all parties to the phone conversation, prior to monitoring or recording the phone conversation. Some of these laws incorporate strict penalties. In cases where local laws require a periodic beep while a conversation is being recorded, the Cisco Unity Express voice-mail system provides a user with the option of activating "the beep." Prior to activating the Cisco Unity Express live record function, check the laws of all applicable jurisdictions. This is not legal advice and should not take the place of obtaining legal advice from a lawyer. IN ADDITION TO THE GENERAL DISCLAIMER THAT ACCOMPANIES THIS CISCO UNITY EXPRESS PRODUCT, CISCO ADDITIONALLY DISCLAIMS ANY AND ALL LIABILITY, BOTH CIVIL AND CRIMINAL, AND ASSUMES NO RESPONSIBILITY FOR THE UNAUTHORIZED AND/OR ILLEGAL USE OF THIS CISCO UNITY EXPRESS PRODUCT. THIS DISCLAIMER OF LIABILITY INCLUDES, BUT IS NOT NECESSARILY LIMITED TO, THE UNAUTHORIZED AND/OR ILLEGAL RECORDING AND MONITORING OF TELEPHONE CONVERSATIONS IN VIOLATION OF APPLICABLE FEDERAL, STATE AND/OR LOCAL LAWS.

==Feedback==

If you have questions or comments about the Cisco Unity Express DocWiki pages, please email Julie McMullen at jmcmulle@cisco.com.

Cisco Unity Express -- Programmatic Interface Service Programming Guide

2010-05-01T15:00:38Z

Mnapalan:

__TOC__

'''Search the Cisco Unity Express documentation on the DocWiki:'''
<html><div id="cse" style="width:25%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('007771824002417948961:zfpvm8yv4fc');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
</html>

==Introduction==

The GUI and command-line interface (CLI) configuration interfaces offered by Cisco Unity Express (CUE) are designed for human interaction. These interfaces, though extensive in nature, prove difficult when integration with other software systems is required. The CUE Programmatic Interface (PI) addresses this issue by providing a set of well-defined application programming interface (API) and data structures that external software systems could invoke to perform configurations on a CUE system. Clients using PI to interact with CUE are expected to benefit from improved performance, scalability, and faster integration.

This document defines in detail the data structures, API, and calling conventions a programmer should employ when using the CUE PI.

The CUE PI is implemented as a web service. Like most web services, it uses HTTP as communication protocol and XML documents for exchanging information between client and server. The service is based on Representational State Transfer (REST) architecture and uses Java API for RESTful Web Services (JAX-RS) specifications for implementation.

Readers are assumed to be familiar with HTTP and XML standards. A brief introduction to REST architectural style is provided in this document, but for better understanding, references are provided for further reading. Also, it is assumed that the reader has some basic knowledge of CUE configuration operations and CUE system concepts.

The CUE PI provides access for configuration purpose only and does not cover the following functionality:

* Subscriber voicemail access
* Change notifications
* System administration related task like Software Upgrade, Backup/Restore, and Reset to factory
* Reporting

==Contents==

This document contains the following sections:

* [[Cisco Unity Express -- RESTful Web Services]]: A description of the REST web services.

* [[Cisco Unity Express -- Quick Start for RESTful Web Services]]: Provides quick start information for using REST web services.

* [[Cisco Unity Express -- Client Software Choices]]: Lists the software choices for clients.

* [[Cisco Unity Express -- REST PI Service Conventions]]: Contains the REST PI service conventions.

* [[Cisco Unity Express -- REST PI Service Operations]]: Describes the REST PI service operations.
** [[Cisco Unity Express -- XML Schema Download REST PI Service Operation]]
** [[Cisco Unity Express -- Common Base Classes REST PI Service Operation]]
** [[Cisco Unity Express -- User and Group Management REST PI Service Operation]]
** [[Cisco Unity Express -- Mailbox REST PI Service Operation]]
** [[Cisco Unity Express -- Operations and Privileges REST PI Service Operation]]
** [[Cisco Unity Express -- Applications REST PI Service Operation]]
** [[Cisco Unity Express -- Business Schedule and Holidays REST PI Service Operation]]
** [[Cisco Unity Express -- Language and Prompts REST PI Service Operation]]
** [[Cisco Unity Express -- Restriction Tables REST PI Service Operation]]
** [[Cisco Unity Express -- Scripts REST PI Service Operation]]
** [[Cisco Unity Express -- Fax Settings REST PI Service Operation]]
** [[Cisco Unity Express -- Subsystem JTAPI REST PI Service Operation]]
** [[Cisco Unity Express -- Subsystem SIP REST PI Service Operation]]
** [[Cisco Unity Express -- Login Banner REST PI Service Operation]]
** [[Cisco Unity Express -- DNS Configuration REST PI Service Operation]]
** [[Cisco Unity Express -- System Information REST PI Service Operation]]
** [[Cisco Unity Express -- License Information REST PI Service Operation]]
** [[Cisco Unity Express -- NTP Server REST PI Service Operation]]
** [[Cisco Unity Express -- SMTP Server REST PI Service Operation]]
** [[Cisco Unity Express -- User Defaults REST PI Service Operation]]
** [[Cisco Unity Express -- Triggers REST PI Service Operation]]
** [[Cisco Unity Express -- Caller Call Flow REST PI Service Operation]]
** [[Cisco Unity Express -- Greetings REST PI Service Operation]]
** [[Cisco Unity Express -- Subscriber Notification Profile REST PI Service Operation]]
** [[Cisco Unity Express -- Notification Settings REST PI Service Operation]]
** [[Cisco Unity Express -- Public Distribution Lists REST PI Service Operation]]
** [[Cisco Unity Express -- Voicemail Settings REST PI Service Operation]]

* [[Cisco Unity Express -- References]]: Lists the references used in this document.

Cisco Unity Express -- PDF Print Groups

2010-05-01T14:52:45Z

Mnapalan:

'''Main Page:''' [[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

'''NOTES:'''

* Read the instructions on the [[Cisco Unity Express -- PDF Print Page]] first and then:

# Highlight and copy the list of page names that you want to print.
#: '''Tip:''' Click the link in the Table of Contents to go the section you want.
# Once you find the list of page names that you want to print, ''do not click the page names, just highlight them''. Do not include the group header name.
# Do Control-C to copy the list of page names.
# Return to the [[Cisco Unity Express -- PDF Print Page]].

== Common Search Groups BY FUNCTION ==

'''NOTE:''' These premade search groups contain common themes. Feel free to make your own groups!

=== Programmatic Interface Service Programming Guide ===

<span style="color:#FA5858">'''Remember:''' Just highlight and copy all the page names below, don't click on them!</span>

[[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

[[Cisco Unity Express -- RESTful Web Services]]

[[Cisco Unity Express -- Quick Start for RESTful Web Services]]

[[Cisco Unity Express -- Client Software Choices]]

[[Cisco Unity Express -- REST PI Service Conventions]]

[[Cisco Unity Express -- REST PI Service Operations]]

[[Cisco Unity Express -- XML Schema Download REST PI Service Operation]]

[[Cisco Unity Express -- Common Base Classes REST PI Service Operation]]

[[Cisco Unity Express -- User and Group Management REST PI Service Operation]]

[[Cisco Unity Express -- Mailbox REST PI Service Operation]]

[[Cisco Unity Express -- Operations and Privileges REST PI Service Operation]]

[[Cisco Unity Express -- Applications REST PI Service Operation]]

[[Cisco Unity Express -- Business Schedule and Holidays REST PI Service Operation]]

[[Cisco Unity Express -- Language and Prompts REST PI Service Operation]]

[[Cisco Unity Express -- Restriction Tables REST PI Service Operation]]

[[Cisco Unity Express -- Scripts REST PI Service Operation]]

[[Cisco Unity Express -- Fax Settings REST PI Service Operation]]

[[Cisco Unity Express -- Subsystem JTAPI REST PI Service Operation]]

[[Cisco Unity Express -- Subsystem SIP REST PI Service Operation]]

[[Cisco Unity Express -- Login Banner REST PI Service Operation]]

[[Cisco Unity Express -- DNS Configuration REST PI Service Operation]]

[[Cisco Unity Express -- System Information REST PI Service Operation]]

[[Cisco Unity Express -- License Information REST PI Service Operation]]

[[Cisco Unity Express -- NTP Server REST PI Service Operation]]

[[Cisco Unity Express -- SMTP Server REST PI Service Operation]]

[[Cisco Unity Express -- User Defaults REST PI Service Operation]]

[[Cisco Unity Express -- Triggers REST PI Service Operation]]

[[Cisco Unity Express -- Caller Call Flow REST PI Service Operation]]

[[Cisco Unity Express -- Greetings REST PI Service Operation]]

[[Cisco Unity Express -- Subscriber Notification Profile REST PI Service Operation]]

[[Cisco Unity Express -- Notification Settings REST PI Service Operation]]

[[Cisco Unity Express -- Public Distribution Lists REST PI Service Operation]]

[[Cisco Unity Express -- Voicemail Settings REST PI Service Operation]]

[[Cisco Unity Express -- References]]

Cisco Unity Express -- PDF Print Groups

2010-05-01T14:52:15Z

Mnapalan:

'''Main Page:''' [[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

'''NOTES:'''

* Read the instructions on the [[Cisco Unity Express -- PDF Print Page]] first and then:

# Highlight and copy the list of page names that you want to print.
#: '''Tip:''' Click the link in the Table of Contents to go the section you want.
# Once you find the list of page names that you want to print, ''do not click the page names, just highlight them''. Do not include the group header name.
# Do Control-C to copy the list of page names.
# Return to the [[Cisco Unity Express -– PDF Print Page]].

== Common Search Groups BY FUNCTION ==

'''NOTE:''' These premade search groups contain common themes. Feel free to make your own groups!

=== Programmatic Interface Service Programming Guide ===

<span style="color:#FA5858">'''Remember:''' Just highlight and copy all the page names below, don't click on them!</span>

[[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

[[Cisco Unity Express -- RESTful Web Services]]

[[Cisco Unity Express -- Quick Start for RESTful Web Services]]

[[Cisco Unity Express -- Client Software Choices]]

[[Cisco Unity Express -- REST PI Service Conventions]]

[[Cisco Unity Express -- REST PI Service Operations]]

[[Cisco Unity Express -- XML Schema Download REST PI Service Operation]]

[[Cisco Unity Express -- Common Base Classes REST PI Service Operation]]

[[Cisco Unity Express -- User and Group Management REST PI Service Operation]]

[[Cisco Unity Express -- Mailbox REST PI Service Operation]]

[[Cisco Unity Express -- Operations and Privileges REST PI Service Operation]]

[[Cisco Unity Express -- Applications REST PI Service Operation]]

[[Cisco Unity Express -- Business Schedule and Holidays REST PI Service Operation]]

[[Cisco Unity Express -- Language and Prompts REST PI Service Operation]]

[[Cisco Unity Express -- Restriction Tables REST PI Service Operation]]

[[Cisco Unity Express -- Scripts REST PI Service Operation]]

[[Cisco Unity Express -- Fax Settings REST PI Service Operation]]

[[Cisco Unity Express -- Subsystem JTAPI REST PI Service Operation]]

[[Cisco Unity Express -- Subsystem SIP REST PI Service Operation]]

[[Cisco Unity Express -- Login Banner REST PI Service Operation]]

[[Cisco Unity Express -- DNS Configuration REST PI Service Operation]]

[[Cisco Unity Express -- System Information REST PI Service Operation]]

[[Cisco Unity Express -- License Information REST PI Service Operation]]

[[Cisco Unity Express -- NTP Server REST PI Service Operation]]

[[Cisco Unity Express -- SMTP Server REST PI Service Operation]]

[[Cisco Unity Express -- User Defaults REST PI Service Operation]]

[[Cisco Unity Express -- Triggers REST PI Service Operation]]

[[Cisco Unity Express -- Caller Call Flow REST PI Service Operation]]

[[Cisco Unity Express -- Greetings REST PI Service Operation]]

[[Cisco Unity Express -- Subscriber Notification Profile REST PI Service Operation]]

[[Cisco Unity Express -- Notification Settings REST PI Service Operation]]

[[Cisco Unity Express -- Public Distribution Lists REST PI Service Operation]]

[[Cisco Unity Express -- Voicemail Settings REST PI Service Operation]]

[[Cisco Unity Express -- References]]

Cisco Unity Express -- PDF Print Groups

2010-05-01T14:50:39Z

Mnapalan: New page: '''Main Page:''' Cisco Unity Express -- Programmatic Interface Service Programming Guide '''NOTES:''' * Read the instructions on the Cisco Unity Express -– PDF Print Page f...

'''Main Page:''' [[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

'''NOTES:'''

* Read the instructions on the [[Cisco Unity Express -– PDF Print Page]] first and then:

# Highlight and copy the list of page names that you want to print.
#: '''Tip:''' Click the link in the Table of Contents to go the section you want.
# Once you find the list of page names that you want to print, ''do not click the page names, just highlight them''. Do not include the group header name.
# Do Control-C to copy the list of page names.
# Return to the [[Cisco Unity Express -– PDF Print Page]].

== Common Search Groups BY FUNCTION ==

'''NOTE:''' These premade search groups contain common themes. Feel free to make your own groups!

=== Programmatic Interface Service Programming Guide ===

<span style="color:#FA5858">'''Remember:''' Just highlight and copy all the page names below, don't click on them!</span>

[[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

[[Cisco Unity Express -- RESTful Web Services]]

[[Cisco Unity Express -- Quick Start for RESTful Web Services]]

[[Cisco Unity Express -- Client Software Choices]]

[[Cisco Unity Express -- REST PI Service Conventions]]

[[Cisco Unity Express -- REST PI Service Operations]]

[[Cisco Unity Express -- XML Schema Download REST PI Service Operation]]

[[Cisco Unity Express -- Common Base Classes REST PI Service Operation]]

[[Cisco Unity Express -- User and Group Management REST PI Service Operation]]

[[Cisco Unity Express -- Mailbox REST PI Service Operation]]

[[Cisco Unity Express -- Operations and Privileges REST PI Service Operation]]

[[Cisco Unity Express -- Applications REST PI Service Operation]]

[[Cisco Unity Express -- Business Schedule and Holidays REST PI Service Operation]]

[[Cisco Unity Express -- Language and Prompts REST PI Service Operation]]

[[Cisco Unity Express -- Restriction Tables REST PI Service Operation]]

[[Cisco Unity Express -- Scripts REST PI Service Operation]]

[[Cisco Unity Express -- Fax Settings REST PI Service Operation]]

[[Cisco Unity Express -- Subsystem JTAPI REST PI Service Operation]]

[[Cisco Unity Express -- Subsystem SIP REST PI Service Operation]]

[[Cisco Unity Express -- Login Banner REST PI Service Operation]]

[[Cisco Unity Express -- DNS Configuration REST PI Service Operation]]

[[Cisco Unity Express -- System Information REST PI Service Operation]]

[[Cisco Unity Express -- License Information REST PI Service Operation]]

[[Cisco Unity Express -- NTP Server REST PI Service Operation]]

[[Cisco Unity Express -- SMTP Server REST PI Service Operation]]

[[Cisco Unity Express -- User Defaults REST PI Service Operation]]

[[Cisco Unity Express -- Triggers REST PI Service Operation]]

[[Cisco Unity Express -- Caller Call Flow REST PI Service Operation]]

[[Cisco Unity Express -- Greetings REST PI Service Operation]]

[[Cisco Unity Express -- Subscriber Notification Profile REST PI Service Operation]]

[[Cisco Unity Express -- Notification Settings REST PI Service Operation]]

[[Cisco Unity Express -- Public Distribution Lists REST PI Service Operation]]

[[Cisco Unity Express -- Voicemail Settings REST PI Service Operation]]

[[Cisco Unity Express -- References]]

Cisco Unity Express -- Programmatic Interface Service Programming Guide

2010-05-01T14:50:05Z

Mnapalan:

Cisco Unity Express -- Programmatic Interface Service Programming Guide

2010-05-01T14:48:39Z

Mnapalan:

Cisco Unity Express -- PDF Print Page

2010-05-01T14:48:02Z

Mnapalan: New page: '''Main Page: Cisco Unity Express -- Programmatic Interface Service Programming Guide''' == Notes about Printing as PDF == You can easily make a PDF of any sets of DocWiki pages. ...

'''Main Page: [[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]'''

== Notes about Printing as PDF ==

You can easily make a PDF of any sets of DocWiki pages. Because you enter DocWiki page names, '''the PDF always contains the latest versions of the pages on the DocWiki'''.

== Directions for Generating a PDF of Multiple DocWiki Pages at One Time ==

Read through all these instructions before you do them.

'''Note:''' Keep this page open so that you can see these instructions.
# RIGHT-CLICK this page [[Cisco Unity Express -- PDF Print Groups]] and select "Open in New Window".
# Read through the list of pages on that page. Highlight and copy the list of page names that you want to print.
#* '''Tip:''' On the new page, click the link in the Table of Contents to go the section you want.
#* Once you find the grouping of pages that you want to print, do not click the page names, just highlight them.
#* Do not include the group header name.
#* Do Control-C to copy the list of page names.
# Return to this page.
# On the left, in the toolbox, right-click '''Special pages'''.
# Click '''Open in New Window'''.
# Scroll down and click '''Pdf Export'''.
# In the form, paste the list of DocWiki page names that you copied in step 2.
# Click '''Make PDF'''.
# Select either '''Open''' or '''Save'''.
The system generates a PDF of the pages you selected.

Cisco Unity Express -- Programmatic Interface Service Programming Guide

2010-05-01T14:44:33Z

Mnapalan:

Cisco Unity Express -- Programmatic Interface Service Programming Guide

2010-04-30T06:03:06Z

Mnapalan:

__TOC__

CUE 8.0 Custom Search:<html><div id="cse" style="width: 100%;">Loading</div>
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
google.load('search', '1', {language : 'en'});
google.setOnLoadCallback(function(){
var customSearchControl = new google.search.CustomSearchControl('010293843260193236265:eezccvnyn7i');
customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
customSearchControl.draw('cse');
}, true);
</script>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" /></html>

==Introduction==

The GUI and command-line interface (CLI) configuration interfaces offered by Cisco Unity Express (CUE) are designed for human interaction. These interfaces, though extensive in nature, prove difficult when integration with other software systems is required. The CUE Programmatic Interface (PI) addresses this issue by providing a set of well-defined application programming interface (API) and data structures that external software systems could invoke to perform configurations on a CUE system. Clients using PI to interact with CUE are expected to benefit from improved performance, scalability, and faster integration.

This document defines in detail the data structures, API, and calling conventions a programmer should employ when using the CUE PI.

The CUE PI is implemented as a web service. Like most web services, it uses HTTP as communication protocol and XML documents for exchanging information between client and server. The service is based on Representational State Transfer (REST) architecture and uses Java API for RESTful Web Services (JAX-RS) specifications for implementation.

Readers are assumed to be familiar with HTTP and XML standards. A brief introduction to REST architectural style is provided in this document, but for better understanding, references are provided for further reading. Also, it is assumed that the reader has some basic knowledge of CUE configuration operations and CUE system concepts.

The CUE PI provides access for configuration purpose only and does not cover the following functionality:

* Subscriber voicemail access
* Change notifications
* System administration related task like Software Upgrade, Backup/Restore, and Reset to factory
* Reporting

==Contents==

This document contains the following sections:

* [[Cisco Unity Express -- RESTful Web Services]]: A description of the REST web services.

* [[Cisco Unity Express -- Quick Start for RESTful Web Services]]: Provides quick start information for using REST web services.

* [[Cisco Unity Express -- Client Software Choices]]: Lists the software choices for clients.

* [[Cisco Unity Express -- REST PI Service Conventions]]: Contains the REST PI service conventions.

* [[Cisco Unity Express -- REST PI Service Operations]]: Describes the REST PI service operations.
** [[Cisco Unity Express -- XML Schema Download REST PI Service Operation]]
** [[Cisco Unity Express -- Common Base Classes REST PI Service Operation]]
** [[Cisco Unity Express -- User and Group Management REST PI Service Operation]]
** [[Cisco Unity Express -- Mailbox REST PI Service Operation]]
** [[Cisco Unity Express -- Operations and Privileges REST PI Service Operation]]
** [[Cisco Unity Express -- Applications REST PI Service Operation]]
** [[Cisco Unity Express -- Business Schedule and Holidays REST PI Service Operation]]
** [[Cisco Unity Express -- Language and Prompts REST PI Service Operation]]
** [[Cisco Unity Express -- Restriction Tables REST PI Service Operation]]
** [[Cisco Unity Express -- Scripts REST PI Service Operation]]
** [[Cisco Unity Express -- Fax Settings REST PI Service Operation]]
** [[Cisco Unity Express -- Subsystem JTAPI REST PI Service Operation]]
** [[Cisco Unity Express -- Subsystem SIP REST PI Service Operation]]
** [[Cisco Unity Express -- Login Banner REST PI Service Operation]]
** [[Cisco Unity Express -- DNS Configuration REST PI Service Operation]]
** [[Cisco Unity Express -- System Information REST PI Service Operation]]
** [[Cisco Unity Express -- License Information REST PI Service Operation]]
** [[Cisco Unity Express -- NTP Server REST PI Service Operation]]
** [[Cisco Unity Express -- SMTP Server REST PI Service Operation]]
** [[Cisco Unity Express -- User Defaults REST PI Service Operation]]
** [[Cisco Unity Express -- Triggers REST PI Service Operation]]
** [[Cisco Unity Express -- Caller Call Flow REST PI Service Operation]]
** [[Cisco Unity Express -- Greetings REST PI Service Operation]]
** [[Cisco Unity Express -- Subscriber Notification Profile REST PI Service Operation]]
** [[Cisco Unity Express -- Notification Settings REST PI Service Operation]]
** [[Cisco Unity Express -- Public Distribution Lists REST PI Service Operation]]
** [[Cisco Unity Express -- Voicemail Settings REST PI Service Operation]]

* [[Cisco Unity Express -- References]]: Lists the references used in this document.

Cisco Unity Express

2010-04-30T05:53:32Z

Mnapalan:

{{Template:Required Metadata}}

==Cisco Unity Express Documentation on the Cisco DocWiki==

Currently only the following Cisco Unity Express documentation is hosted on the Cisco DocWiki:
* [[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

==Printing the PI Programming Guide as a PDF==

The following page describes how to produce a PDF of all the pages of the Cisco Unity Express PI Programming Guide:
* [[Cisco Unity Express -– PDF Print Page]]

==Other Cisco Unity Express Documentation==

The majority of the documentation for Cisco Unity Express, for all releases, can be found on Cisco.com here: http://www.cisco.com/en/US/products/sw/voicesw/ps5520/tsd_products_support_series_home.html.

==Disclaimer for Recording a Conversation==

The use of monitoring, recording, or listening devices to eavesdrop, monitor, retrieve, or record phone conversations or other sound activities, whether or not contemporaneous with transmission, may be illegal in certain circumstances under federal, state and/or local laws. Legal advice should be sought prior to implementing any practice that monitors or records any phone conversation. Some laws require some form of notification to all parties to a phone conversation, such as by using a beep tone or other notification method or requiring the consent of all parties to the phone conversation, prior to monitoring or recording the phone conversation. Some of these laws incorporate strict penalties. In cases where local laws require a periodic beep while a conversation is being recorded, the Cisco Unity Express voice-mail system provides a user with the option of activating "the beep." Prior to activating the Cisco Unity Express live record function, check the laws of all applicable jurisdictions. This is not legal advice and should not take the place of obtaining legal advice from a lawyer. IN ADDITION TO THE GENERAL DISCLAIMER THAT ACCOMPANIES THIS CISCO UNITY EXPRESS PRODUCT, CISCO ADDITIONALLY DISCLAIMS ANY AND ALL LIABILITY, BOTH CIVIL AND CRIMINAL, AND ASSUMES NO RESPONSIBILITY FOR THE UNAUTHORIZED AND/OR ILLEGAL USE OF THIS CISCO UNITY EXPRESS PRODUCT. THIS DISCLAIMER OF LIABILITY INCLUDES, BUT IS NOT NECESSARILY LIMITED TO, THE UNAUTHORIZED AND/OR ILLEGAL RECORDING AND MONITORING OF TELEPHONE CONVERSATIONS IN VIOLATION OF APPLICABLE FEDERAL, STATE AND/OR LOCAL LAWS.

==Feedback==

If you have questions or comments about the Cisco Unity Express DocWiki pages, please email Julie McMullen at jmcmulle@cisco.com.

Cisco Unity Express -- Quick Start for RESTful Web Services

2010-04-30T05:23:32Z

Mnapalan:

{{Template:Required Metadata}}
'''Main page:''' [[Cisco Unity Express -- Programmatic Interface Service Programming Guide]]

'''Previous page:''' [[Cisco Unity Express -- RESTful Web Services]]

'''Next page:''' [[Cisco Unity Express -- Client Software Choices]]

----

Before getting into the service details, this section provides a list of the steps required for executing a request using the CUE PI service.

A client needs the following information to make a request to the CUE PI service:

# HTTP URL for a resource
#:For example, the resource URI for configuring the login banner is:
#:'''/system/banner'''
#:If the CUE host IP address is 172.27.104.144, then, by appending the CUE PI application name "rest" and the published resource URI, we can obtain the complete HTTP URL for the resource as:
#:
#:<nowiki>http://172.27.104.144/rest/system/banner</nowiki>
#:
# HTTP method to execute on the resource (GET for reading, POST for creating, PUT for updating, and DELETE for removing the resource)
#:Thus, for reading the current value for the login banner, we would need to perform HTTP GET on the URL constructed above.
# Representation type of the resource (XML, HTML, JSON, and so on)
#:The CUE PI service uses XML representation for most of its resources; thus, in the HTTP GET request for reading the login banner, we need to set the header '''Accept''' to MIME type '''application/xml'''.
# Authentication information
#:The CUE PI service uses HTTP basic authentication. See the '''Authentication''' section under [[Cisco Unity Express -- REST PI Service Conventions]] for more details.
#:For example, we will use the username "cisco" with password "cisco".
#:Using the command line utility "curl", one can execute this request as follows:
$ curl -u cisco:cisco -X GET -H 'Accept: application/xml'
<nowiki>http://172.27.104.144/rest/system/banner</nowiki>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<loginBanner>
<resourceURI>/system/banner</resourceURI>
<bannerMessage>Hello. Welcome to Cisco Unity Express !!!
</bannerMessage>
</loginBanner>

File:CUE80 Voicemail Settings.jpg

2010-04-30T05:22:00Z

Mnapalan:

File:CUE80 User Defaults.jpg

2010-04-30T05:21:43Z

Mnapalan: