Deeptija at 16:48, 2 October 2012

2012-10-02T16:48:10Z

New page

'''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 ]]<br>[[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>

← Older revision		Revision as of 09:05, 3 October 2012
Line 1,019:		Line 1,019:

	<pre> Response Code: 204 </pre>		<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 -- Basic User Template Information - Revision history

Deeptija at 09:05, 3 October 2012

Deeptija: 1 revision

Deeptija at 16:48, 2 October 2012