DocWiki - User contributions [en]

Cisco Unity Connection Provisioning Interface (CUPI) API

2012-11-27T10:45:43Z

Deeptija: /* Benefits */

Cisco Unity Connection Notification Interface (CUNI) API

2012-11-27T10:44:05Z

Deeptija: /* Introduction */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUNI Guide Contents'''
|-
|[[Cisco Unity Connection Notification Interface (CUNI) API|API Overview ]] [[Cisco Unity Connection Notification Interface (CUNI) API -- CUNI Event Schema|CUNI Event Schema]] [[Cisco Unity Connection Notification Interface (CUNI) API -- Subscribing to and Processing Notification Events|Subscribing to and Processing Notification Events]] [[Cisco Unity Connection Notification Interface (CUNI) API -- CUNI FAQs|CUNI FAQs]]
|}

__TOC__

== Introduction ==

The Cisco Unity Connection Notification Interface (CUNI) API is a web service interface for managing subscriptions to events from Cisco Unity Connection systems. It provides a way to get asynchronous notifications when voice mail messages are received, deleted, or changed. CUNI can be used to integrate Connection into an existing enterprise-wide portal.

CUNI is designed to provide a simple, stable method of accessing the notification functionality on Connection systems through a standards based interface using XML and HTTPS.

Through CUNI, you can do the following:

* Subscribe for message events
* Subscribe for one or many users on a single channel

Note: All the above functions associated with CUNI API support both the IPv4 and IPv6 addresses. However, the IPv6 address works only when Connection platform is configured in Dual (IPv4/IPv6) mode.

For more information see the chapter “Adding or Changing the IPv6 Addresses of Cisco Unity Connection 8.5 and Later Servers” at the following link [http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/upgrade/guide/9xcucrug051.html http://www.cisco.com/en/US/docs/voice_ip_comm/connection/9x/upgrade/guide/9xcucrug051.html].

Note that CUNI is intended for use in server-to-server applications where receiving notifications for many users over a single connection is required. As such, it is designed to handle a small number of clients that are each subscribing for notifications on a large set of subscribers. It also requires Administrative credentials, making it inappropriate for browser applications to use directly.

CUNI is composed of two parts: a SOAP interface for subscribing, and an asynchronous piece (the Notifier) that delivers events as XML over HTTP.

== Technical Details ==

* CUNI is standards-based: it implements a standard SOAP-based interface for managing subscriptions. Message events are sent as standard XML over HTTP.
* CUNI is easy to use: as a web-based interface, CUNI is independent of operating systems and programming languages, and does not require any client libraries to use.

== Getting Started with CUNI ==

In order to begin developing with CUNI, you need to obtain the following:

=== Hardware ===

* Cisco Media Convergence Server (MCS) for Cisco Unity Connection version 8.0 or later
* For detailed hardware-specification information, see the [http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/supported_platforms/8xcucspl.html Cisco Unity Connection 8.x Supported Platforms List]

=== Software ===

* Cisco Unity Connection Software Ordering
* Not for Resale Kits (Must for eligible to purchase)
* Select Unified Communications System Release Kit

Discounts for some of the above hardware and software may be available for participants in the Cisco Technology Developer Program.

We recommend that all developers have an up-to-date Cisco Developer Services support agreement. This provides the developer with access to professional support and assistance for application development.

== Other CUNI Resources ==

Additional information about CUNI is also available on the Cisco Developer Network ([http://developer.cisco.com/web/cuni/home link to CDN]). Note, however, that the documentation here on the DocWiki is the most up-to-date documentation available for CUNI.

To participate in the CUNI forum, see the [http://developer.cisco.com/web/cuni/forums CUNI forum on CDN].

== Troubleshooting ==

See the following for information on troubleshooting all Connection APIs:

[[Cisco Unity Connection APIs -- Troubleshooting |Troubleshooting (applies to all Connection APIs)]]

[[Category:Cisco Unity Connection Notification Interface (CUNI) API]]

Cisco Unity Connection Imaging Interface (CUII) API

2012-11-27T10:42:06Z

Deeptija: /* Benefits */

'''Links to Other API pages:''' [[Cisco Unity Connection APIs]]

{| border="1" align="right"
|-
| align="center" | '''CUII Guide Contents'''
|-
| [[Cisco_Unity_Connection_Imaging_Interface_(CUII)_API|API Overview ]] [[Cisco Unity Connection Imaging Interface (CUII) API -- Using CUII for Getting the Message Status|Using CUII for Getting the Message Status]] [[Cisco Unity Connection Imaging Interface (CUII) API -- Using CUII for Getting Message Specific Information|Using CUII for Getting Message Specific Information]] [[Cisco Unity Connection Imaging Interface (CUII) API -- Using CUII to View the Current MWI Status|Using CUII to View the Current MWI Status]] [[Cisco Unity Connection Imaging Interface (CUII) API -- Using CUII to Get the Current Status of a Message|Using CUII to Get the Current Status of a Message]] [[Cisco Unity Connection Imaging Interface (CUII) API -- Error Handling|Error Handling]]

|}

__TOC__

 

== Benefits ==

The Cisco Unity Connection Imaging Interface (CUII) API provides the ability to view message state and mailbox information visually using graphics icons. The CUII API allows users to view voice messages information visually, which can be leveraged in a cross-functional environment and can be integrated with other applications.

By using CUII, you can get the icon based representation for the following information:

*Unread messages count
*Urgent unread messages count
*Read messages count
*Urgent read messages count
*MWI status and the corresponding image

Note: All the above functions associated with CUII API support both the IPv4 and IPv6 addresses. However, the IPv6 address works only when Connection platform is configured in Dual (IPv4/IPv6) mode.

For more information see the chapter “Adding or Changing the IPv6 Addresses of Cisco Unity Connection Servers” at the following link http://www.cisco.com/en/US/docs/voice_ip_comm/connection/9x/upgrade/guide/9xcucrug051.html. 

Note: With Cisco Unity Connection 9.1(1), the single sign-on feature is enabled for all the Connection Rest APIs. For more information, see the "Single Sign-On in Cisco Unity Connection" chapter in Security Guide for Cisco Unity Connection 9.x http://www.cisco.com/en/US/docs/voice_ip_comm/connection/9x/security/guide/9xcucsec061.html.

== Technical Details ==

CUII allows notification templates to dynamically display the information like MWI state, message count, current state of a specific message (like read, unread, deleted) about a specific user’s inbox and/or specific message.

CUII is a REST-based interface that provides standard CRUD operations. The XML and JSON interfaces are annotated with information about what is in them.

As a web-based interface, CUII is independent of operating system and programming language and does not require any client libraries to use.

== Getting Started ==

In order to begin developing with the Cisco Unity Connection CUII API, the following hardware and software requirement must be met:

 

=== Hardware ===

*For detailed hardware requirements, see the Cisco Unity Connection 9.x Supported Platforms List

=== Software ===

*Cisco Unity Connection Software Ordering
*Not for Resale Kits (Must be eligible to purchase)
*Communications System Release Kit

Discounts for some of the required hardware and software may be available for participants in the Cisco Technology Developer Program.

We recommend that all developers have an up-to-date Cisco Developer Services support agreement. This provides the developer with access to professional support and assistance for application development.

 

== Other CUII Resources ==

Additional information about CUII is also available on the Cisco Developer Network ([http://developer.cisco.com/web/cupi/home link to CDN]). Note, however, that the documentation here on the DocWiki is the most up-to-date documentation available for CUII.

To participate in the CUII forum, see the [http://developer.cisco.com/web/cupi/forums CUPI forum on CDN].

On the CUII page on CDN, you will also find links to the CUII WADL and CUII XML schema.

== Troubleshooting ==

See the following for information on troubleshooting all Connection APIs:

[[Cisco Unity Connection APIs -- Troubleshooting|Troubleshooting (applies to all Connection APIs)]]

The error handling for CUII APIs is same as it is done for CUPI API. For more information on how error handling done in CUPI API, refer to [[Cisco Unity Connection Provisioning Interface (CUPI) API -- Error Handling]]

Cisco Unity Connection Telephony Interface (CUTI) API

2012-11-27T10:40:39Z

Deeptija: /* Introduction */

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUTI Guide Contents'''
|-
|[[Cisco Unity Connection Telephony Interface (CUTI) API|API Overview ]] [[Cisco Unity Connection Telephony Interface (CUTI) API -- Using CUTI for Basic Call Operations|Using CUTI for Basic Call Operations]]
|}

__TOC__

== Introduction ==

The Cisco Unity Connection Telephony Interface (CUTI) API is a web service interface for telephone record and playback on Cisco Unity Connection systems.
CUTI is designed to provide a simple, stable method of accessing telephone record and playback functionality on Connection systems through a standards-based interface using XML and HTTPS.

You can use CUTI to do the following:

* Initiate dialout to a phone device
* Play and record greetings, messages, and other audio
* Control playback speed and volume
* Stop and resume playback and record

Note: All the above functions associated with CUMI API support both the IPv4 and IPv6 addresses. However, the IPv6 address works only when Connection platform is configured in Dual (IPv4/IPv6) mode.

For more information see the chapter “Adding or Changing the IPv6 Addresses of Cisco Unity Connection 8.5 and Later Servers” at the following link [http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/upgrade/guide/9xcucrug051.html http://www.cisco.com/en/US/docs/voice_ip_comm/connection/9x/upgrade/guide/9xcucrug051.html]. 

Note: With Cisco Unity Connection 9.1(1), the single sign-on feature is enabled for all the Connection Rest APIs. For more information, see the "Single Sign-On in Cisco Unity Connection" chapter in Security Guide for Cisco Unity Connection 9.x http://www.cisco.com/en/US/docs/voice_ip_comm/connection/9x/security/guide/9xcucsec061.html.

== Benefits ==

With CUTI, you have the ability to record audio as needed by using a phone, providing additional functionality besides uploading .wav files. You can use CUTI to do the following:

* As part of a User or Admin interface, record audio as part of a name, greeting, or message
* Play secure messages
* Record messages using phone as a media device

== Technical Details ==

CUTI was developed using the latest advances in web-based interfaces: it is a REST interface that standardizes operations such as add, delete, and modify. The XML comes with standard XML schema definitions that are annotated with information about what is in them.

As a web-based interface, CUTI is independent of operating system and programming language, and does not require any client libraries to use.

== Getting Started with CUTI ==

In order to begin developing with the Cisco Unity Connection CUTI API, you will need to obtain the following:

=== Hardware ===

* Cisco Media Convergence Server (MCS) for Cisco Unity Connection version 8.0 and later
* For detailed hardware requirements, see the [http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/supported_platforms/8xcucspl.html Cisco Unity Connection 8.x Supported Platforms List]

=== Software ===

* Cisco Unity Connection Software Ordering
* Not for Resale Kits (Must be eligible to purchase)
* Select Unified Communications System Release Kit

Discounts for some of the required hardware and software may be available for participants in the Cisco Technology Developer Program.

We recommend that all developers have an up-to-date Cisco Developer Services support agreement. This provides the developer with access to professional support and assistance for application development.

== Other CUTI Resources ==

Additional information about CUTI is also available on the Cisco Developer Network ([http://developer.cisco.com/web/cuti/home link to CDN]). Note, however, that the documentation here on the DocWiki is the most up-to-date documentation available for CUTI.

To participate in the CUTI forum, see the [http://developer.cisco.com/web/cuti/forums CUTI forum on CDN].

== Troubleshooting ==

See the following for information on troubleshooting all Connection APIs:

[[Cisco Unity Connection APIs -- Troubleshooting |Troubleshooting (applies to all Connection APIs)]]

[[Category:Cisco Unity Connection Telephony Interface (CUTI) API]]

Cisco Unity Connection Messaging Interface (CUMI) API

2012-11-27T10:39:06Z

Deeptija: /* Introduction */

'''Links to Other API pages:''' [[Cisco Unity Connection APIs]]

__TOC__

 

== Introduction ==

The Cisco Unity Connection Messaging Interface (CUMI) is a messaging API for Cisco Unity Connection that has been designed to be stable and simple to use. It is based on leading industry standards for web-based API development, and provides access to a wide set of Connection messaging functionality.

If you are a customer or developer who needs the ability to integrate Connection into an existing enterprise-wide portal, CUMI offers a secure method for doing the following:

*Sending messages
*Receiving messages
*Replying to messages
*Sending broadcast messages (provided the user account is enabled to send broadcast messages)
*Sending dispatch messages
*Receiving notifications of new messages

'''Note''': By default, API access to playback secure messages is turned off. To enable API access to secure messages, check the Allow Access to Secure Message Recordings Through the Cisco Unity Connection Messaging Interface (CUMI) setting on the System Settings > Advanced > API Settings page in Cisco Unity Connection Administration.

Note: All the above functions associated with CUMI API support both the IPv4 and IPv6 addresses. However, the IPv6 address works only when Connection platform is configured in Dual (IPv4/IPv6) mode.

For more information see the chapter “Adding or Changing the IPv6 Addresses of Cisco Unity Connection 8.5 and Later Servers” at the following link [http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/upgrade/guide/9xcucrug051.html http://www.cisco.com/en/US/docs/voice_ip_comm/connection/9x/upgrade/guide/9xcucrug051.html]. 

Note: With Cisco Unity Connection 9.1(1), the single sign-on feature is enabled for all the Connection Rest APIs. For more information, see the "Single Sign-On in Cisco Unity Connection" chapter in Security Guide for Cisco Unity Connection 9.x http://www.cisco.com/en/US/docs/voice_ip_comm/connection/9x/security/guide/9xcucsec061.html.

== How the documentation is organized ==

=== Accessing Mailboxes and Folders ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API|Using the CUMI API for Mailboxes & Folders]]

=== Sending Messages using the API ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Sending Messages|Using the CUMI API for Sending Messages]] [[Cisco Unity Connection Messaging Interface (CUMI) API -- Sending a Voice Message with One or More Attachments|Sending a Voice Message with One or More Attachments]]

=== Working with Notifications ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Sending Notifications|Using the CUMI API for Sending Notifications]]

=== Working with Dispatch Messages ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Dispatch Message Operations|Using the CUMI API for Dispatch Messages ]]

=== Working with Broadcast Messages ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Using the CUMI API for Broadcast Messages|Using the CUMI API for Broadcast Messages]]

=== Special Features ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- Preventing Messages from Being Automatically Deleted (Investigative Hold)|Preventing Messages from Being Deleted (Investigative Hold)]]

=== Samples ===

[[Cisco Unity Connection Messaging Interface (CUMI) API -- HTTP Samples|HTTP Samples]] [http://www.ciscounitytools.com/Applications/CxN/BroadcastMessageManager/BroadcastMessageManager.html Broadcast Message Tool]

== Technical Details ==

CUMI is a REST interface that standardizes operations such as add, delete, and modify. The XML comes with standard XML schema definitions that are annotated with information about what is in them.

As a web-based interface, CUMI is independent of operating system and programming language and does not require any client libraries to use.

 

== Getting started ==

In order to begin developing with the Cisco Unity Connection CUMI API, you will need to obtain the following:

=== Hardware ===

*Cisco Media Convergence Server (MCS) for Cisco Unity Connection version 8.0 and later
*For detailed hardware requirements, see the [http://www.cisco.com/en/US/docs/voice_ip_comm/connection/8x/supported_platforms/8xcucspl.html Cisco Unity Connection 8.x Supported Platforms List]

=== Software ===

*Cisco Unity Connection Software Ordering
*Not for Resale Kits (Must be eligible to purchase)
*Select Unified Communications System Release Kit

Discounts for some of the required hardware and software may be available for participants in the Cisco Technology Developer Program.

We recommend that all developers have an up-to-date Cisco Developer Services support agreement. This provides the developer with access to professional support and assistance for application development.

 

== Other CUMI Resources ==

Additional information about CUMI is also available on the Cisco Developer Network (http://developer.cisco.com/web/cuc/ link to CDN]). Note, however, that the documentation here on the DocWiki is the most up-to-date documentation available for CUMI.

To participate in the CUMI forum, see the [http://developer.cisco.com/web/cumi/forums CUMI forum on CDN].

 

== Troubleshooting ==

See the following for information on troubleshooting all Connection APIs:

[[Cisco Unity Connection APIs -- Troubleshooting|Troubleshooting (applies to all Connection APIs)]]

[[Category:Cisco_Unity_Connection_Messaging_Interface_(CUMI)_API]]

Cisco Unity Connection Provisioning Interface (CUPI) API

2012-11-27T10:36:37Z

Deeptija: /* Introduction */

Cisco Unity Connection Provisioning Interface (CUPI) API -- SRSV APIs

2012-11-27T10:27:28Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation

2012-11-27T10:25:45Z

Deeptija: /* Cisco Survivable Remote Site Voicemail (SRSV) APIs */

Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation

2012-11-27T10:21:32Z

Deeptija:

Cisco Unity Connection Provisioning Interface (CUPI) API -- SIP Profiles

2012-10-03T09:46:41Z

Deeptija:

Cisco Unity Connection Provisioning Interface (CUPI) API -- SIP Profiles

2012-10-03T09:46:23Z

Deeptija:

Cisco Unity Connection Provisioning Interface (CUPI) API -- SIP Certificates

2012-10-03T09:45:32Z

Deeptija:

Cisco Unity Connection Provisioning Interface (CUPI) API -- Ports

2012-10-03T09:44:51Z

Deeptija: /* About Ports */

Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups

2012-10-03T09:44:19Z

Deeptija: /* About Port Group */

Cisco Unity Connection Provisioning Interface (CUPI) API -- Phone Systems

2012-10-03T09:43:49Z

Deeptija: /* About Phone Systems */

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template External Service Accounts

2012-10-03T09:43:15Z

Deeptija: /* About External Service Accounts */

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template External Services

2012-10-03T09:42:46Z

Deeptija: /* About External Services */

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

2012-10-03T09:42:17Z

Deeptija: /* About Notification Devices */

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

2012-10-03T09:41:43Z

Deeptija:

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template Caller Input

2012-10-03T09:40:35Z

Deeptija: /* About Caller Input */

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template Transfer Options

2012-10-03T09:39:12Z

Deeptija: /* About Transfer Options */

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template VoiceMail PIN

2012-10-03T09:38:41Z

Deeptija: /* Changing User Template Voicemail PIN */

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

2012-10-03T09:37:25Z

Deeptija: /* About Default Templates */

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

2012-10-03T09:07:47Z

Deeptija: /* About Default Templates */

Cisco Unity Connection Provisioning Interface (CUPI) API -- Basic User Template Information

2012-10-03T09:05:07Z

Deeptija:

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUPI Guide Contents'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|API Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation|Index of All CUPI Documentation]]
|}

__TOC__

== About User Templates ==

This page contains information on how to use the API to create, list, modify, and delete user templates. When you create user accounts, you base each account on a user template. Creating new user accounts on a template minimizes the number of settings that must be modified on individual user accounts, making the job of creating user accounts easier.

Cisco Unity Connection comes with predefined user templates too, which you can modify but not delete. For more information on default user template, see [[Cisco Unity Connection Provisioning Interface (CUPI) API -- Default User Template|Default User Template ]] section.

== Listing and Viewing User Templates ==

=== Generic Examples to List User Templates ===

'''Example 1'''

The following is an example of the GET request that lists all the User Templates:

<pre>
https://<connection_server>/vmrest/usertemplates
</pre>

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

<pre>
<UserTemplates total="1">
<UserTemplate>
<URI>/vmrest/usertemplates/7553408b-3415-43db-aa82-3b2dc78062d1</URI>
<ObjectId>7553408b-3415-43db-aa82-3b2dc78062d1</ObjectId>
<UseDefaultLanguage>true</UseDefaultLanguage>
<UseDefaultTimeZone>true</UseDefaultTimeZone>
<Alias>voicemailusertemplate</Alias>
<DisplayName>Voice Mail User Template</DisplayName>
<TimeZone>190</TimeZone>
<CreationTime>2012-06-25T06:07:31Z</CreationTime>
<CosObjectId>7be9b3f3-1200-403f-984a-04c07b7c5a7b</CosObjectId>
<CosURI>/vmrest/coses/7be9b3f3-1200-403f-984a-04c07b7c5a7b</CosURI>
<Language>1033</Language>
<LocationObjectId>6d4ff2e5-3f26-4a19-b2fa-beca79b4c5e9</LocationObjectId>
<LocationURI>
/vmrest/locations/connectionlocations/6d4ff2e5-3f26-4a19-b2fa- beca79b4c5e9
</LocationURI>
<AddressMode>0</AddressMode>
<ClockMode>0</ClockMode>
<ConversationTui>SubMenu</ConversationTui>
<GreetByName>true</GreetByName>
<ListInDirectory>true</ListInDirectory>
<IsVmEnrolled>true</IsVmEnrolled>
<SayCopiedNames>true</SayCopiedNames>
<SayDistributionList>true</SayDistributionList>
<SayMsgNumber>true</SayMsgNumber>
<SaySender>true</SaySender>
<SayTimestampAfter>true</SayTimestampAfter>
<SayTimestampBefore>false</SayTimestampBefore>
<SayTotalNew>false</SayTotalNew>
<SayTotalNewEmail>false</SayTotalNewEmail>
<SayTotalNewFax>false</SayTotalNewFax>
<SayTotalNewVoice>true</SayTotalNewVoice>
<SayTotalReceipts>false</SayTotalReceipts>
<SayTotalSaved>true</SayTotalSaved>
<Speed>100</Speed>
<MediaSwitchObjectId>
1fb12b1c-cf14-4634-b73d- 9b9c58ecdf68
</MediaSwitchObjectId>
<PhoneSystemURI>
/vmrest/phonesystems/1fb12b1c-cf14-4634-b73d-9b9c58ecdf68
</PhoneSystemURI>
<Undeletable>true</Undeletable>
<UseBriefPrompts>false</UseBriefPrompts>
<Volume>50</Volume>
<EnAltGreetDontRingPhone>false</EnAltGreetDontRingPhone>
<EnAltGreetPreventSkip>false</EnAltGreetPreventSkip>
<EnAltGreetPreventMsg>false</EnAltGreetPreventMsg>
<EncryptPrivateMessages>false</EncryptPrivateMessages>
<DeletedMessageSortOrder>2</DeletedMessageSortOrder>
<SayAltGreetWarning>false</SayAltGreetWarning>
<SaySenderExtension>false</SaySenderExtension>
<SayAni>false</SayAni>
<ExitCallActionObjectId>
a365e3c0-d8ed-4874-9810-cedb074dfe33
</ExitCallActionObjectId>
<CallAnswerTimeout>4</CallAnswerTimeout>
<CallHandlerObjectId>f700f378-9656-45ea-94ff-c0462592999e</CallHandlerObjectId>
<CallhandlerURI>
/vmrest/callhandlerprimarytemplates/f700f378-9656-45ea-94ff-c0462592999e
</CallhandlerURI>
<DisplayNameRule>1</DisplayNameRule>
<DoesntExpire>false</DoesntExpire>
<CantChange>false</CantChange>
<MailboxStoreObjectId>cfc43112-601b-4764-ba92-b0220e9d7f23</MailboxStoreObjectId>
<SavedMessageStackOrder>1234567</SavedMessageStackOrder>
<NewMessageStackOrder>1234567</NewMessageStackOrder>
<InboxAutoResolveMessageRecipients>true</InboxAutoResolveMessageRecipients>
<PcaAddressBookRowsPerPage>5</PcaAddressBookRowsPerPage>
<ReadOnly>false</ReadOnly>
<EnableTts>true</EnableTts>
<ConfirmationConfidenceThreshold>60</ConfirmationConfidenceThreshold>
<AnnounceUpcomingMeetings>60</AnnounceUpcomingMeetings>
<SpeechConfidenceThreshold>40</SpeechConfidenceThreshold>
<SpeechSpeedVsAccuracy>50</SpeechSpeedVsAccuracy>
<SpeechSensitivity>50</SpeechSensitivity>
<EnableVisualMessageLocator>false</EnableVisualMessageLocator>
<ContinuousAddMode>false</ContinuousAddMode>
<NameConfirmation>false</NameConfirmation>
<CommandDigitTimeout>1500</CommandDigitTimeout>
<SaveMessageOnHangup>false</SaveMessageOnHangup>
<SendMessageOnHangup>1</SendMessageOnHangup>
<SkipForwardTime>5000</SkipForwardTime>
<SkipReverseTime>5000</SkipReverseTime>
<UseShortPollForCache>false</UseShortPollForCache>
<SearchByExtensionSearchSpaceObjectId>
25e2e004-c194-4593-9961-bdcaf5dd7189
</SearchByExtensionSearchSpaceObjectId>
<SearchByExtensionSearchSpaceURI>
/vmrest/searchspaces/25e2e004-c194-4593-9961-bdcaf5dd7189
</SearchByExtensionSearchSpaceURI>
<SearchByNameSearchSpaceObjectId>
25e2e004-c194-4593-9961-bdcaf5dd7189
</SearchByNameSearchSpaceObjectId>
<SearchByNameSearchSpaceURI>
/vmrest/searchspaces/25e2e004-c194-4593-9961-bdcaf5dd7189
</SearchByNameSearchSpaceURI>
<PartitionObjectId>12101df7-ecd2-4a48-b5b9-9a96b5f85a25</PartitionObjectId>
<PartitionURI>
/vmrest/partitions/12101df7-ecd2-4a48-b5b9-9a96b5f85a25
</PartitionURI>
<UseDynamicNameSearchWeight>false</UseDynamicNameSearchWeight>
<LdapType>0</LdapType>
<EnableMessageBookmark>false</EnableMessageBookmark>
<SayTotalDraftMsg>false</SayTotalDraftMsg>
<EnableSaveDraft>false</EnableSaveDraft>
<RetainUrgentMessageFlag>false</RetainUrgentMessageFlag>
<SayMessageLength>false</SayMessageLength>
<CreateSmtpProxyFromCorp>false</CreateSmtpProxyFromCorp>
<AutoAdvanceMsgs>false</AutoAdvanceMsgs>
<SaySenderAfter>false</SaySenderAfter>
<SaySenderExtensionAfter>false</SaySenderExtensionAfter>
<SayMsgNumberAfter>false</SayMsgNumberAfter>
<SayAniAfter>false</SayAniAfter>
<SayMessageLengthAfter>false</SayMessageLengthAfter>
<UserTemplateRolesURI>
/vmrest/usertemplates/7553408b-3415-43db-aa82-3b2dc78062d1/usertemplateroles
</UserTemplateRolesURI>
<UserTemplateNotificationDevicesURI>
/vmrest/usertemplates/7553408b-3415-43db-aa823b2dc78062d1/usertemplatenotificationdevices
</UserTemplateNotificationDevicesURI>
<UserTemplateWebPasswordURI>
/vmrest/usertemplates/7553408b-3415-43db-aa82-3b2dc78062d1/credential/password
</UserTemplateWebPasswordURI>
<UserTemplateVoicePinURI>
/vmrest/usertemplates/7553408b-3415-43db-aa82-3b2dc78062d1/credential/pin
</UserTemplateVoicePinURI>
<UserTemplateMessageActionURI>
/vmrest/usertemplates/7553408b-3415-43db-aa82-3b2dc78062d1/usertemplatemessageactions
</UserTemplateMessageActionURI>
</UserTemplate>
</pre>

<pre> Response Code: 200 </pre>

'''Example 2'''

The following is an example of the GET request that lists the User Template as represented by <objectId>:

<pre>
https://<connection_server>/vmrest/usertemplates/<objectId>
</pre>

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

<pre>
<UserTemplate>
<URI>
/vmrest/usertemplates/c8af2544-2bc9-44fa-b713-e80f306cf781
</URI>
<ObjectId>
c8af2544-2bc9-44fa-b713-e80f306cf781
</ObjectId>
<UseDefaultLanguage>true</UseDefaultLanguage>
<UseDefaultTimeZone>true</UseDefaultTimeZone>
<Alias>NewCiscoTemplate2</Alias>
<City/>
<State/>
<Country>US</Country>
<PostalCode/>
<Department/>
<Manager/>
<Building/>
<Address/>
<DisplayName>testmonica</DisplayName>
<BillingId/>
<TimeZone>190</TimeZone>
<CreationTime>2012-06-26 05:02:22.05</CreationTime>
<CosObjectId>7be9b3f3-1200-403f-984a-04c07b7c5a7b</CosObjectId>
<CosURI>/vmrest/coses/7be9b3f3-1200-403f-984a-04c07b7c5a7b</CosURI>
<Language>1033</Language>
<LocationObjectId>
6d4ff2e5-3f26-4a19-b2fa-beca79b4c5e9
</LocationObjectId>
<LocationURI>
/vmrest/locations/connectionlocations/6d4ff2e5-3f26-4a19-b2fa-beca79b4c5e9
</LocationURI>
<AddressMode>0</AddressMode>
<ClockMode>0</ClockMode>
<ConversationTui>SubMenu</ConversationTui>
<GreetByName>true</GreetByName>
<ListInDirectory>true</ListInDirectory>
<IsVmEnrolled>true</IsVmEnrolled>
<SayCopiedNames>true</SayCopiedNames>
<SayDistributionList>true</SayDistributionList>
<SayMsgNumber>true</SayMsgNumber>
<SaySender>true</SaySender>
<SayTimestampAfter>true</SayTimestampAfter>
<SayTimestampBefore>false</SayTimestampBefore>
<SayTotalNew>false</SayTotalNew>
<SayTotalNewEmail>false</SayTotalNewEmail>
<SayTotalNewFax>false</SayTotalNewFax>
<SayTotalNewVoice>true</SayTotalNewVoice>
<SayTotalReceipts>false</SayTotalReceipts>
<SayTotalSaved>true</SayTotalSaved>
<Speed>100</Speed>
<MediaSwitchObjectId>
1fb12b1c-cf14-4634-b73d-9b9c58ecdf68
</MediaSwitchObjectId>
<PhoneSystemURI>
/vmrest/phonesystems/1fb12b1c-cf14-4634-b73d-9b9c58ecdf68
</PhoneSystemURI>
<Undeletable>false</Undeletable>
<UseBriefPrompts>false</UseBriefPrompts>
<Volume>50</Volume>
<EnAltGreetDontRingPhone>false</EnAltGreetDontRingPhone>
<EnAltGreetPreventSkip>false</EnAltGreetPreventSkip>
<EnAltGreetPreventMsg>false</EnAltGreetPreventMsg>
<EncryptPrivateMessages>false</EncryptPrivateMessages>
<DeletedMessageSortOrder>2</DeletedMessageSortOrder>
<SayAltGreetWarning>false</SayAltGreetWarning>
<SaySenderExtension>false</SaySenderExtension>
<SayAni>false</SayAni>
<ExitCallActionObjectId>
27cbb3a8-f040-4ee9-9686-620c43e3d725
</ExitCallActionObjectId>
<CallAnswerTimeout>4</CallAnswerTimeout>
<CallHandlerObjectId>
9a5ac35a-0df8-4ebb-8e19-77f936dfd263
</CallHandlerObjectId>
<CallhandlerURI>
/vmrest/callhandlerprimarytemplates/9a5ac35a-0df8-4ebb-8e19-77f936dfd263
</CallhandlerURI>
<DisplayNameRule>1</DisplayNameRule>
<DoesntExpire>false</DoesntExpire>
<CantChange>false</CantChange>
<MailboxStoreObjectId>
cfc43112-601b-4764-ba92-b0220e9d7f23
</MailboxStoreObjectId>
<SavedMessageStackOrder>1234567</SavedMessageStackOrder>
<NewMessageStackOrder>1234567</NewMessageStackOrder>
<MessageLocatorSortOrder>1</MessageLocatorSortOrder>
<SavedMessageSortOrder>2</SavedMessageSortOrder>
<NewMessageSortOrder>1</NewMessageSortOrder>
<MessageTypeMenu>false</MessageTypeMenu>
<EnablePersonalRules>true</EnablePersonalRules>
<RecordUnknownCallerName>true</RecordUnknownCallerName>
<RingPrimaryPhoneFirst>false</RingPrimaryPhoneFirst>
<PromptSpeed>100</PromptSpeed>
<ExitAction>2</ExitAction>
<ExitTargetConversation>PHTransfer</ExitTargetConversation>
<ExitTargetHandlerObjectId>
7ae69f21-1c99-4cc1-96c3-a1bbe11fd4ca
</ExitTargetHandlerObjectId>
<RepeatMenu>1</RepeatMenu>
<FirstDigitTimeout>5000</FirstDigitTimeout>
<InterdigitDelay>3000</InterdigitDelay>
<PromptVolume>50</PromptVolume>
<AddressAfterRecord>false</AddressAfterRecord>
<ConfirmDeleteMessage>false</ConfirmDeleteMessage>
<ConfirmDeleteDeletedMessage>false</ConfirmDeleteDeletedMessage>
<ConfirmDeleteMultipleMessages>true</ConfirmDeleteMultipleMessages>
<IsClockMode24Hour>false</IsClockMode24Hour>
<RouteNDRToSender>true</RouteNDRToSender>
<NotificationType>0</NotificationType>
<SendReadReceipts>0</SendReadReceipts>
<ReceiveQuota>-1</ReceiveQuota>
<SendQuota>-1</SendQuota>
<WarningQuota>-1</WarningQuota>
<IsSetForVmEnrollment>true</IsSetForVmEnrollment>
<VoiceNameRequired>false</VoiceNameRequired>
<SendBroadcastMsg>true</SendBroadcastMsg>
<UpdateBroadcastMsg>false</UpdateBroadcastMsg>
<ConversationVui>VuiStart</ConversationVui>
<SpeechCompleteTimeout>0</SpeechCompleteTimeout>
<SpeechIncompleteTimeout>750</SpeechIncompleteTimeout>
<UseVui>false</UseVui>
<SkipPasswordForKnownDevice>false</SkipPasswordForKnownDevice>
<JumpToMessagesOnLogin>true</JumpToMessagesOnLogin>
<EnableMessageLocator>false</EnableMessageLocator>
<MessageAgingPolicyObjectId>
2e02eca6-270b-4b7f-a153-f03ea74d403d
</MessageAgingPolicyObjectId>
<MessageAgingPolicyURI>
/vmrest/messageagingpolicies/2e02eca6-270b-4b7f-a153-f03ea74d403d
</MessageAgingPolicyURI>
<AssistantRowsPerPage>5</AssistantRowsPerPage>
<InboxMessagesPerPage>20</InboxMessagesPerPage>
<InboxAutoRefresh>15</InboxAutoRefresh>
<InboxAutoResolveMessageRecipients>true</InboxAutoResolveMessageRecipients>
<PcaAddressBookRowsPerPage>5</PcaAddressBookRowsPerPage>
<ReadOnly>false</ReadOnly>
<EnableTts>true</EnableTts>
<ConfirmationConfidenceThreshold>60</ConfirmationConfidenceThreshold>
<AnnounceUpcomingMeetings>60</AnnounceUpcomingMeetings>
<SpeechConfidenceThreshold>40</SpeechConfidenceThreshold>
<SpeechSpeedVsAccuracy>50</SpeechSpeedVsAccuracy>
<SpeechSensitivity>50</SpeechSensitivity>
<EnableVisualMessageLocator>false</EnableVisualMessageLocator>
<ContinuousAddMode>false</ContinuousAddMode>
<NameConfirmation>false</NameConfirmation>
<CommandDigitTimeout>1500</CommandDigitTimeout>
<SaveMessageOnHangup>false</SaveMessageOnHangup>
<SendMessageOnHangup>1</SendMessageOnHangup>
<SkipForwardTime>5000</SkipForwardTime>
<SkipReverseTime>5000</SkipReverseTime>
<UseShortPollForCache>false</UseShortPollForCache>
<SearchByExtensionSearchSpaceObjectId>
25e2e004-c194-4593-9961-bdcaf5dd7189
</SearchByExtensionSearchSpaceObjectId>
<SearchByExtensionSearchSpaceURI>
/vmrest/searchspaces/25e2e004-c194-4593-9961-bdcaf5dd7189
</SearchByExtensionSearchSpaceURI>
<SearchByNameSearchSpaceObjectId>
25e2e004-c194-4593-9961-bdcaf5dd7189
</SearchByNameSearchSpaceObjectId>
<SearchByNameSearchSpaceURI>
/vmrest/searchspaces/25e2e004-c194-4593-9961-bdcaf5dd7189
</SearchByNameSearchSpaceURI>
<PartitionObjectId>
12101df7-ecd2-4a48-b5b9-9a96b5f85a25
</PartitionObjectId>
<PartitionURI>
/vmrest/partitions/12101df7-ecd2-4a48-b5b9-9a96b5f85a25
</PartitionURI>
<UseDynamicNameSearchWeight>false</UseDynamicNameSearchWeight>
<LdapType>0</LdapType>
<EnableMessageBookmark>false</EnableMessageBookmark>
<SayTotalDraftMsg>false</SayTotalDraftMsg>
<EnableSaveDraft>false</EnableSaveDraft>
<RetainUrgentMessageFlag>false</RetainUrgentMessageFlag>
<SayMessageLength>false</SayMessageLength>
<CreateSmtpProxyFromCorp>false</CreateSmtpProxyFromCorp>
<AutoAdvanceMsgs>false</AutoAdvanceMsgs>
<SaySenderAfter>false</SaySenderAfter>
<SaySenderExtensionAfter>false</SaySenderExtensionAfter>
<SayMsgNumberAfter>false</SayMsgNumberAfter>
<SayAniAfter>false</SayAniAfter>
<SayMessageLengthAfter>false</SayMessageLengthAfter>
<UserTemplateRolesURI>
/vmrest/usertemplates/c8af2544-2bc9-44fa-b713-e80f306cf781/usertemplateroles
</UserTemplateRolesURI>
<UserTemplateNotificationDevicesURI>
/vmrest/usertemplates/c8af2544-2bc9-44fa-b713-e80f306cf781/usertemplatenotificationdevices
</UserTemplateNotificationDevicesURI>
<UserTemplateWebPasswordURI>
/vmrest/usertemplates/c8af2544-2bc9-44fa-b713-e80f306cf781/credential/password
</UserTemplateWebPasswordURI>
<UserTemplateVoicePinURI>
/vmrest/usertemplates/c8af2544-2bc9-44fa-b713-e80f306cf781/credential/pin
</UserTemplateVoicePinURI>
<UserTemplateMessageActionURI>
/vmrest/usertemplates/c8af2544-2bc9-44fa-b713-e80f306cf781/usertemplatemessageactions
</UserTemplateMessageActionURI>
</UserTemplate>
</pre>

<pre> Response Code: 200 </pre>

=== JSON Examples to List User Templates ===

'''Example 1'''

The following is an example of the GET request that lists all the User Templates:

<pre>
https://<connection_server>/vmrest/usertemplates/
</pre>

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

<pre>
{
"@total": "2",
"UserTemplate":
{
"URI": "/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d",
"ObjectId": "885dd0af-bdb1-401f-b4e9-6bd9fc8d594d",
"UseDefaultLanguage": "true",
"UseDefaultTimeZone": "true",
"Alias": "voicemailusertemplate",
"DisplayName": "Voice Mail User Template",
"TimeZone": "4",
"CreationTime": "2012-07-29T14:10:26Z",
"CosObjectId": "362bf7f9-7cec-4f59-86dd-6c058a9100ef",
"CosURI": "/vmrest/coses/362bf7f9-7cec-4f59-86dd-6c058a9100ef",
"Language": "1033",
"LocationObjectId": "3a403c9c-04c8-496a-ba76-23faaaae5a95",
"LocationURI":
"/vmrest/locations/connectionlocations/3a403c9c-04c8-496a-ba76-23faaaae5a95",
"AddressMode": "0",
"ClockMode": "0",
"ConversationTui": "SubMenu",
"GreetByName": "true",
"ListInDirectory": "true",
"IsVmEnrolled": "true",
"SayCopiedNames": "true",
"SayDistributionList": "true",
"SayMsgNumber": "true",
"SaySender": "true",
"SayTimestampAfter": "true",
"SayTimestampBefore": "false",
"SayTotalNew": "false",
"SayTotalNewEmail": "false",
"SayTotalNewFax": "false",
"SayTotalNewVoice": "true",
"SayTotalReceipts": "false",
"SayTotalSaved": "true",
"Speed": "100",
"MediaSwitchObjectId": "0d15753c-e1b4-4865-b00b-999a1ccf56ce",
"PhoneSystemURI":
"/vmrest/phonesystems/0d15753c-e1b4-4865-b00b-999a1ccf56ce",
"Undeletable": "true",
"UseBriefPrompts": "false",
"Volume": "50",
"EnAltGreetDontRingPhone": "false",
"EnAltGreetPreventSkip": "false",
"EnAltGreetPreventMsg": "false",
"EncryptPrivateMessages": "false",
"DeletedMessageSortOrder": "2",
"SayAltGreetWarning": "false",
"SaySenderExtension": "false",
"SayAni": "false",
"ExitCallActionObjectId": "6352cf7d-89f8-4748-bac5-8878889c3d56",
"CallAnswerTimeout": "4",
"CallHandlerObjectId": "c9069370-3631-4d36-a53a-1ac4e8d8f444",
"CallhandlerURI":
"/vmrest/callhandlerprimarytemplates/c9069370-3631-4d36-a53a-1ac4e8d8f444",
"DisplayNameRule": "1",
"DoesntExpire": "false",
"CantChange": "false",
"MailboxStoreObjectId": "6d2eb9ad-3caf-41d2-b3db-4451d95057fe",
"SavedMessageStackOrder": "1234567",
"NewMessageStackOrder": "1234567",
"MessageLocatorSortOrder": "1",
"SavedMessageSortOrder": "2",
"NewMessageSortOrder": "1",
"MessageTypeMenu": "false",
"EnablePersonalRules": "true",
"RecordUnknownCallerName": "true",
"RingPrimaryPhoneFirst": "false",
"PromptSpeed": "100",
"ExitAction": "2",
"ExitTargetConversation": "PHGreeting",
"ExitTargetHandlerObjectId": "708d5a59-95bb-4804-979b-c56b2f7d719a",
"RepeatMenu": "1",
"FirstDigitTimeout": "5000",
"InterdigitDelay": "3000",
"PromptVolume": "50",
"DelayAfterGreeting": "0",
"AddressAfterRecord": "false",
"ConfirmDeleteMessage": "false",
"ConfirmDeleteDeletedMessage": "false",
"ConfirmDeleteMultipleMessages": "true",
"IsClockMode24Hour": "false",
"RouteNDRToSender": "true",
"NotificationType": "0",
"SendReadReceipts": "1",
"ReceiveQuota": "2147483647",
"SendQuota": "2147483647",
"WarningQuota": "2147483647",
"IsSetForVmEnrollment": "true",
"VoiceNameRequired": "false",
"SendBroadcastMsg": "false",
"UpdateBroadcastMsg": "false",
"ConversationVui": "VuiStart",
"SpeechCompleteTimeout": "0",
"SpeechIncompleteTimeout": "750",
"UseVui": "false",
"SkipPasswordForKnownDevice": "false",
"JumpToMessagesOnLogin": "true",
"EnableMessageLocator": "false",
"MessageAgingPolicyObjectId": "a4b9216a-9360-4f9b-8937-cc66fba0ebbe",
"MessageAgingPolicyURI":
"/vmrest/messageagingpolicies/a4b9216a-9360-4f9b-8937-cc66fba0ebbe",
"AssistantRowsPerPage": "5",
"InboxMessagesPerPage": "20",
"InboxAutoRefresh": "15",
"InboxAutoResolveMessageRecipients": "true",
"PcaAddressBookRowsPerPage": "5",
"ReadOnly": "false",
"EnableTts": "true",
"ConfirmationConfidenceThreshold": "60",
"AnnounceUpcomingMeetings": "60",
"SpeechConfidenceThreshold": "40",
"SpeechSpeedVsAccuracy": "50",
"SpeechSensitivity": "50",
"EnableVisualMessageLocator": "false",
"ContinuousAddMode": "false",
"NameConfirmation": "false",
"CommandDigitTimeout": "1500",
"SaveMessageOnHangup": "false",
"SendMessageOnHangup": "1",
"SkipForwardTime": "12345",
"SkipReverseTime": "54321",
"UseShortPollForCache": "false",
"SearchByExtensionSearchSpaceObjectId":
"a3933806-a995-443e-8704-498c03377bf7",
"SearchByExtensionSearchSpaceURI":
"/vmrest/searchspaces/a3933806-a995-443e-8704-498c03377bf7",
"SearchByNameSearchSpaceObjectId":
"a3933806-a995-443e-8704-498c03377bf7",
"SearchByNameSearchSpaceURI":
"/vmrest/searchspaces/a3933806-a995-443e-8704-498c03377bf7",
"PartitionObjectId": "6ac064a3-79d6-4a52-a3d3-f4311be5c28c",
"PartitionURI":
"/vmrest/partitions/6ac064a3-79d6-4a52-a3d3-f4311be5c28c",
"UseDynamicNameSearchWeight": "false",
"LdapType": "0",
"EnableMessageBookmark": "false",
"SayTotalDraftMsg": "false",
"EnableSaveDraft": "false",
"RetainUrgentMessageFlag": "false",
"SayMessageLength": "false",
"CreateSmtpProxyFromCorp": "false",
"AutoAdvanceMsgs": "false",
"SaySenderAfter": "false",
"SaySenderExtensionAfter": "false",
"SayMsgNumberAfter": "true",
"SayAniAfter": "false",
"SayMessageLengthAfter": "false",
"UserTemplateRolesURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/usertemplateroles",
"UserTemplateNotificationDevicesURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/usertemplatenotificationdevices",
"TemplateExternalServiceAccountsURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/templateexternalserviceaccounts",
"UserTemplateWebPasswordURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/credential/password",
"UserTemplateVoicePinURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/credential/pin",
"UserTemplateMessageActionURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/usertemplatemessageactions",
"DefaultUserTemplateURI": "/vmrest/userdefaulttemplates"
},
{
"URI": "/vmrest/usertemplates/7426a16f-e735-4854-9ab6-7463728ea4f7",
"ObjectId": "7426a16f-e735-4854-9ab6-7463728ea4f7",
"UseDefaultLanguage": "true",
"UseDefaultTimeZone": "true",
"Alias": "AdminTest",
"DisplayName": "Admin test",
"TimeZone": "4",
"CreationTime": "2012-08-28T10:57:12Z",
"CosObjectId": "362bf7f9-7cec-4f59-86dd-6c058a9100ef",
"CosURI": "/vmrest/coses/362bf7f9-7cec-4f59-86dd-6c058a9100ef",
"Language": "1033",
"LocationObjectId": "3a403c9c-04c8-496a-ba76-23faaaae5a95",
"LocationURI":
"/vmrest/locations/connectionlocations/3a403c9c-04c8-496a-ba76-23faaaae5a95",
"AddressMode": "0",
"ClockMode": "0",
"ConversationTui": "SubMenu",
"GreetByName": "true",
"ListInDirectory": "true",
"IsVmEnrolled": "true",
"SayCopiedNames": "true",
"SayDistributionList": "true",
"SayMsgNumber": "true",
"SaySender": "true",
"SayTimestampAfter": "true",
"SayTimestampBefore": "false",
"SayTotalNew": "false",
"SayTotalNewEmail": "false",
"SayTotalNewFax": "false",
"SayTotalNewVoice": "true",
"SayTotalReceipts": "false",
"SayTotalSaved": "true",
"Speed": "100",
"MediaSwitchObjectId": "0d15753c-e1b4-4865-b00b-999a1ccf56ce",
"PhoneSystemURI":
"/vmrest/phonesystems/0d15753c-e1b4-4865-b00b-999a1ccf56ce",
"Undeletable": "false",
"UseBriefPrompts": "false",
"Volume": "50",
"EnAltGreetDontRingPhone": "false",
"EnAltGreetPreventSkip": "false",
"EnAltGreetPreventMsg": "false",
"EncryptPrivateMessages": "false",
"DeletedMessageSortOrder": "2",
"SayAltGreetWarning": "false",
"SaySenderExtension": "false",
"SayAni": "false",
"ExitCallActionObjectId": "38d9d3d2-2f70-4e4c-a3bd-54c8e96df9f6",
"CallAnswerTimeout": "4",
"CallHandlerObjectId": "ee01a097-2c78-4f36-9400-c0a6e0159419",
"CallhandlerURI":
"/vmrest/callhandlerprimarytemplates/ee01a097-2c78-4f36-9400-c0a6e0159419",
"DisplayNameRule": "1",
"DoesntExpire": "false",
"CantChange": "false",
"MailboxStoreObjectId": "6d2eb9ad-3caf-41d2-b3db-4451d95057fe",
"SavedMessageStackOrder": "1234567",
"NewMessageStackOrder": "1234567",
"MessageLocatorSortOrder": "1",
"SavedMessageSortOrder": "2",
"NewMessageSortOrder": "1",
"MessageTypeMenu": "false",
"EnablePersonalRules": "true",
"RecordUnknownCallerName": "true",
"RingPrimaryPhoneFirst": "false",
"PromptSpeed": "100",
"ExitAction": "2",
"ExitTargetConversation": "PHGreeting",
"ExitTargetHandlerObjectId": "708d5a59-95bb-4804-979b-c56b2f7d719a",
"RepeatMenu": "1",
"FirstDigitTimeout": "5000",
"InterdigitDelay": "3000",
"PromptVolume": "50",
"DelayAfterGreeting": "0",
"AddressAfterRecord": "false",
"ConfirmDeleteMessage": "false",
"ConfirmDeleteDeletedMessage": "false",
"ConfirmDeleteMultipleMessages": "true",
"IsClockMode24Hour": "false",
"RouteNDRToSender": "true",
"NotificationType": "0",
"SendReadReceipts": "1",
"ReceiveQuota": "2147483647",
"SendQuota": "2147483647",
"WarningQuota": "2147483647",
"IsSetForVmEnrollment": "true",
"VoiceNameRequired": "false",
"SendBroadcastMsg": "false",
"UpdateBroadcastMsg": "false",
"ConversationVui": "VuiStart",
"SpeechCompleteTimeout": "0",
"SpeechIncompleteTimeout": "750",
"UseVui": "false",
"SkipPasswordForKnownDevice": "false",
"JumpToMessagesOnLogin": "true",
"EnableMessageLocator": "false",
"MessageAgingPolicyObjectId": "a4b9216a-9360-4f9b-8937-cc66fba0ebbe",
"MessageAgingPolicyURI":
"/vmrest/messageagingpolicies/a4b9216a-9360-4f9b-8937-cc66fba0ebbe",
"AssistantRowsPerPage": "5",
"InboxMessagesPerPage": "20",
"InboxAutoRefresh": "15",
"InboxAutoResolveMessageRecipients": "true",
"PcaAddressBookRowsPerPage": "5",
"ReadOnly": "false",
"EnableTts": "true",
"ConfirmationConfidenceThreshold": "60",
"AnnounceUpcomingMeetings": "60",
"SpeechConfidenceThreshold": "40",
"SpeechSpeedVsAccuracy": "50",
"SpeechSensitivity": "50",
"EnableVisualMessageLocator": "false",
"ContinuousAddMode": "false",
"NameConfirmation": "false",
"CommandDigitTimeout": "1500",
"SaveMessageOnHangup": "false",
"SendMessageOnHangup": "1",
"SkipForwardTime": "12345",
"SkipReverseTime": "54321",
"UseShortPollForCache": "false",
"SearchByExtensionSearchSpaceObjectId":
"a3933806-a995-443e-8704-498c03377bf7",
"SearchByExtensionSearchSpaceURI":
"/vmrest/searchspaces/a3933806-a995-443e-8704-498c03377bf7",
"SearchByNameSearchSpaceObjectId":
"a3933806-a995-443e-8704-498c03377bf7",
"SearchByNameSearchSpaceURI":
"/vmrest/searchspaces/a3933806-a995-443e-8704-498c03377bf7",
"PartitionObjectId":
"6ac064a3-79d6-4a52-a3d3-f4311be5c28c",
"PartitionURI":
"/vmrest/partitions/6ac064a3-79d6-4a52-a3d3-f4311be5c28c",
"UseDynamicNameSearchWeight": "false",
"LdapType": "0",
"EnableMessageBookmark": "false",
"SayTotalDraftMsg": "false",
"EnableSaveDraft": "false",
"RetainUrgentMessageFlag": "false",
"SayMessageLength": "false",
"CreateSmtpProxyFromCorp": "false",
"AutoAdvanceMsgs": "false",
"SaySenderAfter": "false",
"SaySenderExtensionAfter": "false",
"SayMsgNumberAfter": "true",
"SayAniAfter": "false",
"SayMessageLengthAfter": "false",
"UserTemplateRolesURI":
"/vmrest/usertemplates/7426a16f-e735-4854-9ab6-7463728ea4f7/usertemplateroles",
"UserTemplateNotificationDevicesURI":
"/vmrest/usertemplates/7426a16f-e735-4854-9ab6-7463728ea4f7/usertemplatenotificationdevices",
"TemplateExternalServiceAccountsURI":
"/vmrest/usertemplates/7426a16f-e735-4854-9ab6-7463728ea4f7/templateexternalserviceaccounts",
"UserTemplateWebPasswordURI":
"/vmrest/usertemplates/7426a16f-e735-4854-9ab6-7463728ea4f7/credential/password",
"UserTemplateVoicePinURI":
"/vmrest/usertemplates/7426a16f-e735-4854-9ab6-7463728ea4f7/credential/pin",
"UserTemplateMessageActionURI":
"/vmrest/usertemplates/7426a16f-e735-4854-9ab6-7463728ea4f7/usertemplatemessageactions",
"DefaultUserTemplateURI": "/vmrest/userdefaulttemplates"
}

}

</pre>

<pre> Response Code: 200 </pre>

'''Example 2'''

The following is an example of the GET request that lists the User Template as represented by <objectId>:

<pre>
https://<connection_server>/vmrest/usertemplates/<objectId>
</pre>

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

<pre>
{
"URI": "/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d",
"ObjectId": "885dd0af-bdb1-401f-b4e9-6bd9fc8d594d",
"UseDefaultLanguage": "true",
"UseDefaultTimeZone": "true",
"Alias": "voicemailusertemplate",
"DisplayName": "Voice Mail User Template",
"TimeZone": "4",
"CreationTime": "2012-07-29T14:10:26Z",
"CosObjectId": "362bf7f9-7cec-4f59-86dd-6c058a9100ef",
"CosURI": "/vmrest/coses/362bf7f9-7cec-4f59-86dd-6c058a9100ef",
"Language": "1033",
"LocationObjectId": "3a403c9c-04c8-496a-ba76-23faaaae5a95",
"LocationURI":
"/vmrest/locations/connectionlocations/3a403c9c-04c8-496a-ba76-23faaaae5a95",
"AddressMode": "0",
"ClockMode": "0",
"ConversationTui": "SubMenu",
"GreetByName": "true",
"ListInDirectory": "true",
"IsVmEnrolled": "true",
"SayCopiedNames": "true",
"SayDistributionList": "true",
"SayMsgNumber": "true",
"SaySender": "true",
"SayTimestampAfter": "true",
"SayTimestampBefore": "false",
"SayTotalNew": "false",
"SayTotalNewEmail": "false",
"SayTotalNewFax": "false",
"SayTotalNewVoice": "true",
"SayTotalReceipts": "false",
"SayTotalSaved": "true",
"Speed": "100",
"MediaSwitchObjectId": "0d15753c-e1b4-4865-b00b-999a1ccf56ce",
"PhoneSystemURI":
"/vmrest/phonesystems/0d15753c-e1b4-4865-b00b-999a1ccf56ce",
"Undeletable": "true",
"UseBriefPrompts": "false",
"Volume": "50",
"EnAltGreetDontRingPhone": "false",
"EnAltGreetPreventSkip": "false",
"EnAltGreetPreventMsg": "false",
"EncryptPrivateMessages": "false",
"DeletedMessageSortOrder": "2",
"SayAltGreetWarning": "false",
"SaySenderExtension": "false",
"SayAni": "false",
"ExitCallActionObjectId": "6352cf7d-89f8-4748-bac5-8878889c3d56",
"CallAnswerTimeout": "4",
"CallHandlerObjectId": "c9069370-3631-4d36-a53a-1ac4e8d8f444",
"CallhandlerURI":
"/vmrest/callhandlerprimarytemplates/c9069370-3631-4d36-a53a-1ac4e8d8f444",
"DisplayNameRule": "1",
"DoesntExpire": "false",
"CantChange": "false",
"MailboxStoreObjectId": "6d2eb9ad-3caf-41d2-b3db-4451d95057fe",
"SavedMessageStackOrder": "1234567",
"NewMessageStackOrder": "1234567",
"MessageLocatorSortOrder": "1",
"SavedMessageSortOrder": "2",
"NewMessageSortOrder": "1",
"MessageTypeMenu": "false",
"EnablePersonalRules": "true",
"RecordUnknownCallerName": "true",
"RingPrimaryPhoneFirst": "false",
"PromptSpeed": "100",
"ExitAction": "2",
"ExitTargetConversation": "PHGreeting",
"ExitTargetHandlerObjectId": "708d5a59-95bb-4804-979b-c56b2f7d719a",
"RepeatMenu": "1",
"FirstDigitTimeout": "5000",
"InterdigitDelay": "3000",
"PromptVolume": "50",
"AddressAfterRecord": "false",
"ConfirmDeleteMessage": "false",
"ConfirmDeleteDeletedMessage": "false",
"ConfirmDeleteMultipleMessages": "true",
"IsClockMode24Hour": "false",
"RouteNDRToSender": "true",
"NotificationType": "0",
"SendReadReceipts": "1",
"ReceiveQuota": "2147483647",
"SendQuota": "2147483647",
"WarningQuota": "2147483647",
"IsSetForVmEnrollment": "true",
"VoiceNameRequired": "false",
"SendBroadcastMsg": "false",
"UpdateBroadcastMsg": "false",
"ConversationVui": "VuiStart",
"SpeechCompleteTimeout": "0",
"SpeechIncompleteTimeout": "750",
"UseVui": "false",
"SkipPasswordForKnownDevice": "false",
"JumpToMessagesOnLogin": "true",
"EnableMessageLocator": "false",
"MessageAgingPolicyObjectId": "a4b9216a-9360-4f9b-8937-cc66fba0ebbe",
"MessageAgingPolicyURI":
"/vmrest/messageagingpolicies/a4b9216a-9360-4f9b-8937-cc66fba0ebbe",
"AssistantRowsPerPage": "5",
"InboxMessagesPerPage": "20",
"InboxAutoRefresh": "15",
"InboxAutoResolveMessageRecipients": "true",
"PcaAddressBookRowsPerPage": "5",
"ReadOnly": "false",
"EnableTts": "true",
"ConfirmationConfidenceThreshold": "60",
"AnnounceUpcomingMeetings": "60",
"SpeechConfidenceThreshold": "40",
"SpeechSpeedVsAccuracy": "50",
"SpeechSensitivity": "50",
"EnableVisualMessageLocator": "false",
"ContinuousAddMode": "false",
"NameConfirmation": "false",
"CommandDigitTimeout": "1500",
"SaveMessageOnHangup": "false",
"SendMessageOnHangup": "1",
"SkipForwardTime": "12345",
"SkipReverseTime": "54321",
"UseShortPollForCache": "false",
"SearchByExtensionSearchSpaceObjectId":
"a3933806-a995-443e-8704-498c03377bf7",
"SearchByExtensionSearchSpaceURI":
"/vmrest/searchspaces/a3933806-a995-443e-8704-498c03377bf7",
"SearchByNameSearchSpaceObjectId":
"a3933806-a995-443e-8704-498c03377bf7",
"SearchByNameSearchSpaceURI":
"/vmrest/searchspaces/a3933806-a995-443e-8704-498c03377bf7",
"PartitionObjectId":
"6ac064a3-79d6-4a52-a3d3-f4311be5c28c",
"PartitionURI":
"/vmrest/partitions/6ac064a3-79d6-4a52-a3d3-f4311be5c28c",
"UseDynamicNameSearchWeight": "false",
"LdapType": "0",
"EnableMessageBookmark": "false",
"SayTotalDraftMsg": "false",
"EnableSaveDraft": "false",
"RetainUrgentMessageFlag": "false",
"SayMessageLength": "false",
"CreateSmtpProxyFromCorp": "false",
"AutoAdvanceMsgs": "false",
"SaySenderAfter": "false",
"SaySenderExtensionAfter": "false",
"SayMsgNumberAfter": "true",
"SayAniAfter": "false",
"SayMessageLengthAfter": "false",
"UserTemplateRolesURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/usertemplateroles",
"UserTemplateNotificationDevicesURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/usertemplatenotificationdevices",
"TemplateExternalServiceAccountsURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/templateexternalserviceaccounts",
"UserTemplateWebPasswordURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/credential/password",
"UserTemplateVoicePinURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/credential/pin",
"UserTemplateMessageActionURI":
"/vmrest/usertemplates/885dd0af-bdb1-401f-b4e9-6bd9fc8d594d/usertemplatemessageactions",
"DefaultUserTemplateURI": "/vmrest/userdefaulttemplates"
}

</pre>

<pre> Response Code: 200 </pre>

== Adding User Template ==

'''Example 1'''

The following is an example of the POST request that adds the User Templates:

<pre> https://<connection_server>/vmrest/usertemplates?templateAlias=voicemailusertemplate </pre>

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

<pre>
<UserTemplate>
<DisplayName>DemoUserTemplate</DisplayName>
<Alias>DemoUserTemplate</Alias>
</UserTemplate>
</pre>

<pre> Response Code: 201 </pre>

'''Example 2'''

The following is a JSON example of the POST request that adds the User Templates:

<pre> https://<connection_server>/vmrest/usertemplates?templateAlias=voicemailusertemplate </pre>

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

<pre>
{
"Alias": "adminTemplate1",
"DisplayName": "Admin Voice Mail Template"

}

</pre>

<pre> Response Code: 201 </pre>

== Modifying a User Template ==

'''Example 1'''

The following is an example of the PUT request that modifies the user template as represented by <objectId>:

<pre> https://<connection_server>/vmrest/usertemplate/<objectId> </pre>

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

<pre>
<UserTemplate>
<SendBroadcastMsg>true</SendBroadcastMsg>
<GreetByName>true</GreetByName>
<ListInDirectory>true</ListInDirectory>
<IsVmEnrolled>true</IsVmEnrolled>
<SayCopiedNames>true</SayCopiedNames>
<SayDistributionList>true</SayDistributionList>
<SayMsgNumber>true</SayMsgNumber>
</UserTemplate>
</pre>

<pre> RESPONSE Code: 204 </pre>

'''Example 2'''

The following is a JSON example of the PUT request that modifies the user template as represented by <objectId>:

<pre> https://<connection_server>/vmrest/usertemplate/<objectId> </pre>

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

<pre>
{
"SendBroadcastMsg" : "true",
"GreetByName" : "true",
"ListInDirectory" : "true",
"IsVmEnrolled" : "true"
"SayCopiedNames" : "true",
"SayDistributionList" : "true",
"SayMsgNumber" :"true"
}
</pre>

<pre> Response Code: 204 </pre>

You can also modify the following for a user template:

* [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_User_Template_VoiceMail_PIN|User Template Voicemail PIN]]
* [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_User_Template_Transfer_Options|User Template Transfer Options]]
* [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_User_Template_Caller_Input|User Template Caller Input]]
* [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_User_Template_Greetings|User Template Greetings]]
* [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_User_Template_Notification_Devices|User Template Notification Devices]]
* [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_User_Template_External_Services|User Template External Services]]
* [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_User_Template_External_Service_Accounts|User Template External Service Accounts]]

== Deleting User Templates ==

The following is an example of the DELETE request that deletes a User Template as represented by <objectId>:

<pre> https://<connection_server>/vmrest/usertemplates/<objectId> </pre>

The output for this request returns the successful response code.

<pre> Response Code: 204 </pre>

== Minimum Software Version ==

These APIs are supported with Cisco Unity Connection 9.0.1.11004-1 Engineering Special 13.

Cisco Unity Connection Provisioning Interface (CUPI) API -- SIP Profiles

2012-10-02T17:59:49Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- SIP Certificates

2012-10-02T17:59:49Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- Ports

2012-10-02T17:59:49Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups

2012-10-02T17:59:49Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- Phone Systems

2012-10-02T17:59:49Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation

2012-10-02T17:58:43Z

Deeptija:

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template VoiceMail PIN

2012-10-02T17:54:38Z

Deeptija: 1 revision

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

2012-10-02T17:54:38Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template External Service Accounts

2012-10-02T17:48:38Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template External Services

2012-10-02T17:48:38Z

Deeptija: 1 revision

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

2012-10-02T17:48:38Z

Deeptija: 1 revision

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

2012-10-02T17:48:38Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template Caller Input

2012-10-02T17:48:38Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template Transfer Options

2012-10-02T17:48:38Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- Basic User Template Information

2012-10-02T17:48:37Z

Deeptija: 1 revision

Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation

2012-10-02T17:46:29Z

Deeptija:

Cisco Unity Connection Provisioning Interface (CUPI) API -- Basic User Template Information

2012-10-02T16:48:10Z

Deeptija:

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template External Service Accounts

2012-09-05T07:53:35Z

Deeptija: /* Explanation of Data Fields */

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template Caller Input

2012-09-05T07:45:46Z

Deeptija: /* Explanation of Data Fields */

Cisco Unity Connection Provisioning Interface (CUPI) API -- Ports

2012-09-05T07:14:19Z

Deeptija:

Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Groups

2012-09-05T06:43:16Z

Deeptija: /* Adding PIMGTIMG Port Groups */

Cisco Unity Connection Provisioning Interface (CUPI) API -- SIP Profiles

2012-09-05T06:34:04Z

Deeptija:

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

2012-08-27T10:23:51Z

Deeptija: /* Modifying Notification Device */

Cisco Unity Connection Provisioning Interface (CUPI) API -- User Template VoiceMail PIN

2012-08-14T07:32:07Z

Deeptija: /* Changing User Template Voicemail PIN */

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

2012-08-14T07:31:07Z

Deeptija:

Cisco Unity Connection Provisioning Interface (CUPI) API -- SIP Certificates

2012-08-08T13:52:03Z

Deeptija: