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

From DocWiki

Revision as of 06:03, 10 September 2013 by Subabhat (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation


Contents


User Templates API

Administrator can use this API to create/update/delete/fetch the user template. Various attributes of user template can also be updated using this API.


Listing the User Templates

The request can be used to fetch the list of all user templates. It can also be used to fetch the list of user templates based on specific partition object ID, COS objec t ID, mailbox store object ID, phone system, call handler object ID.

  GET https://<connection-server>/vmrest/usertemplates

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

<UserTemplates total="1">
    <UserTemplate>
    <URI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-2b13f76bf631</URI>
    <ObjectId>c2056af2-bed7-4a0d-9039-2b13f76bf631</ObjectId>
    <UseDefaultLanguage>true</UseDefaultLanguage>
    <UseDefaultTimeZone>true</UseDefaultTimeZone>
    <Alias>Texoma_User_Template1</Alias>
    <City/>
    <State/>
    <Country>US</Country>
    <PostalCode/>
    <Manager/>
    <Building/>
    <Address/>
    <DisplayName>Texoma_User_Template1</DisplayName>
    <BillingId/>
    <TimeZone>190</TimeZone>
    <CreationTime>2012-12-26 13:04:28.9</CreationTime>
    <CosObjectId>0ef61610-a729-4b0d-9476-cab095028db3</CosObjectId>
    <CosURI>/vmrest/coses/0ef61610-a729-4b0d-9476-cab095028db3</CosURI>
    <Language>1033</Language>
    <LocationObjectId>27a67e01-bcb4-4012-8b1b-f0a08b736087</LocationObjectId>
    <LocationURI>/vmrest/locations/connectionlocations/27a67e01-b
    cb4-4012-8b1b-f0a08b736087</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>b6df8cb3-b3ce-4797-84f3-5559049df8e8</MediaSwitchObjectId>
    <PhoneSystemURI>/vmrest/phonesystems/b6df8cb3-b3ce-4797-84f3-
    5559049df8e8</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>0463e49b-cde4-4c30-877c-acfe25966a42</ExitCallActionObjectId> 
    <CallAnswerTimeout>4</CallAnswerTimeout>
    <CallHandlerObjectId>83c9b890-6659-4c0f-8be6-8a1a85efee7e</CallHandlerObjectId>
    <CallhandlerURI>/vmrest/callhandlerprimarytemplates/83c9b890-6659-4c0f-8be6-8a1a85efee7e</CallhandlerURI>
    <DisplayNameRule>1</DisplayNameRule>
    <DoesntExpire>false</DoesntExpire>
    <CantChange>false</CantChange>
    <MailboxStoreObjectId>e983490d-78a5-45aa-b9a0-31f51460a5bd</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>PHGreeting</ExitTargetConversation>
    <ExitTargetHandlerObjectId>063956f9-c5ca-4e8b-be67-
    ff945a8a5d99</ExitTargetHandlerObjectId>
    <RepeatMenu>1</RepeatMenu>
    <FirstDigitTimeout>5000</FirstDigitTimeout>
    <InterdigitDelay>3000</InterdigitDelay>
    <PromptVolume>50</PromptVolume>
    <DelayAfterGreeting>0</DelayAfterGreeting>
    <AddressAfterRecord>false</AddressAfterRecord>
    <ConfirmDeleteMessage>false</ConfirmDeleteMessage>
    <ConfirmDeleteDeletedMessage>false</ConfirmDeleteDeletedMessage>
    <ConfirmDeleteMultipleMessages>true</ConfirmDeleteMultipleMessages>
    <IsClockMode24Hour>false</IsClockMode24Hour>
    <RouteNDRToSender>true</RouteNDRToSender>
    <NotificationType>0</NotificationType>
    <SendReadReceipts>1</SendReadReceipts>
    <ReceiveQuota>-2</ReceiveQuota>
    <SendQuota>-2</SendQuota>
    <WarningQuota>-2</WarningQuota>
    <IsSetForVmEnrollment>true</IsSetForVmEnrollment>
    <VoiceNameRequired>false</VoiceNameRequired>
    <SendBroadcastMsg>false</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>6780a194-6efd-4311-819f-
    494a082bb093</MessageAgingPolicyObjectId>
    <MessageAgingPolicyURI>/vmrest/messageagingpolicies/6780a194-6efd-4311-819f-
    494a082bb093</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>2e0da21b-54e4-4b51-9f09-
    960049a5e806</SearchByExtensionSearchSpaceObjectId>
    <SearchByExtensionSearchSpaceURI>/vmrest/searchspaces/2e0da21b-54e4-4b51-9f09-
    960049a5e806</SearchByExtensionSearchSpaceURI>
    <SearchByNameSearchSpaceObjectId>2e0da21b-54e4-4b51-9f09-960049a5e806</SearchByNameSearchSpaceObjectId>
    <SearchByNameSearchSpaceURI>/vmrest/searchspaces/2e0da21b-54e4-4b51-9f09-960049a5e806</SearchByNameSearchSpaceURI>
    <PartitionObjectId>c6ff147e-c32c-4ade-8f12-46427c795c21</PartitionObjectId>
    <PartitionURI>/vmrest/partitions/c6ff147e-c32c-4ade-8f12-46427c795c21</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/c2056af2-bed7-4a0d-9039-
    2b13f76bf631/usertemplateroles</UserTemplateRolesURI>
    <UserTemplateNotificationDevicesURI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-   2b13f76bf631/usertemplatenotificationdevices</UserTemplateNotificationDevicesURI>
    <TemplateExternalServiceAccountsURI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-   2b13f76bf631/templateexternalserviceaccounts</TemplateExternalServiceAccountsURI>
    <UserTemplateWebPasswordURI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-
     2b13f76bf631/credential/password</UserTemplateWebPasswordURI>
    <UserTemplateVoicePinURI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-
    2b13f76bf631/credential/pin</UserTemplateVoicePinURI>
    <UserTemplateMessageActionURI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-
    2b13f76bf631/usertemplatemessageactions</UserTemplateMessageActionURI>
</UserTemplate>
</UserTemplates>
Response Code: 200

JSON Example

To view the list of user templates, do the following:

Request URI:
GET https://<connection-server>/vmrest/usertemplates
Accept: application/json
Content_type: application/json
Connection: keep_alive

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

{
  "@total":"1"
  "UserTemplate":\[
  {
    "URI":"/vmrest/usertemplates/6164ac2d-e8ec-441a-93a0-95f8e18a655c"
    "ObjectId":"6164ac2d-e8ec-441a-93a0-95f8e18a655c"
    "UseDefaultLanguage":"true"
    "UseDefaultTimeZone":"true"
    "Alias":"voicemailusertemplate"
    "DisplayName":"Voice Mail User Template"
    "TimeZone":"190"
    "CreationTime":"2013-02-25T09:39:25Z"
    "CosObjectId":"0b59d616-6434-443a-95aa-00b9d7315d54"
    "CosURI":"/vmrest/coses/0b59d616-6434-443a-95aa-00b9d7315d54"
    "Language":"1033"
    "LocationObjectId":"cff1347e-87af-4409-bead-d1970625f82e"
    "LocationURI":"/vmrest/locations/connectionlocations/cff1347e-87af-4409-bead-d1970625f82e"
    "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":"0ad0b88c-4a70-4cf7-913e-d5d7a921caca"
    "PhoneSystemURI":"/vmrest/phonesystems/0ad0b88c-4a70-4cf7-913e-d5d7a921caca"
    "Undeletable":"true"
    "UseBriefPrompts":"false"
    "Volume":"50"
    "EnAltGreetDontRingPhone":"false"
    "EnAltGreetPreventSkip":"false"
    "EnAltGreetPreventMsg":"false"
    "EncryptPrivateMessages":"false"
    "DeletedMessageSortOrder":"2"
    "SayAltGreetWarning":"false"
    "SaySenderExtension":"false"
    "SayAni":"false"
    "ExitCallActionObjectId":"38f2eab0-a78c-49a2-8aee-ff562844d5db"
    "CallAnswerTimeout":"4"
    "CallHandlerObjectId":"6bcd837d-f1cf-43c2-b199-85b457858a16"
    "CallhandlerURI":"/vmrest/callhandlerprimarytemplates/6bcd837d-f1cf-43c2-b199-
    85b457858a16"
    "DisplayNameRule":"1"
    "DoesntExpire":"false"
    "CantChange":"false"
    "MailboxStoreObjectId":"02089c75-e8a2-4724-a570-9bed7768e716"
    "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":"1e0bc010-d9aa-4e1a-b001-a1b40f028d4f"
    "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":"-2"
    "SendQuota":"-2"
    "WarningQuota":"-2"
    "IsSetForVmEnrollment":"true"
    "VoiceNameRequired":"false"
    "SendBroadcastMsg":"false"
    "UpdateBroadcastMsg":"false"
    "ConversationVui":"VuiStart"
    "SpeechCompleteTimeout":"0"
    "SpeechIncompleteTimeout":"750"
    "UseVui":"false"
    "SkipPasswordForKnownDevice":"false"
    "JumpToMessagesOnLogin":"true"
    "EnableMessageLocator":"false"
    "MessageAgingPolicyObjectId":"adac77f4-8a77-430d-8836-
    0fc9aef3fef5"
    "MessageAgingPolicyURI":"/vmrest/messageagingpolicies/adac77f4-8a77-430d-8836-0fc9aef3fef5"
    "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":"5000"
    "SkipReverseTime":"5000"
    "UseShortPollForCache":"false"
    "SearchByExtensionSearchSpaceObjectId":"2e836e16-f715-4a18-bb7c-
    ee5e33281706"
    "SearchByExtensionSearchSpaceURI":"/vmrest/searchspaces/2e836e16-f715-4a18-bb7c-
    ee5e33281706"
    "SearchByNameSearchSpaceObjectId":"2e836e16-f715-4a18-bb7c-ee5e33281706"
    "SearchByNameSearchSpaceURI":"/vmrest/searchspaces/2e836e16-f715-4a18-bb7c-
    ee5e33281706"
    "PartitionObjectId":"97bf6afe-346e-4275-967e-43c50be79d32"
    "PartitionURI":"/vmrest/partitions/97bf6afe-346e-4275-967e-43c50be79d32"
    "UseDynamicNameSearchWeight":"false"
    "LdapType":"0"
    "EnableMessageBookmark":"false"
    "SayTotalDraftMsg":"false"
    "EnableSaveDraft":"false"
    "RetainUrgentMessageFlag":"false"
    "SayMessageLength":"false"
    "CreateSmtpProxyFromCorp":"false"
    "AutoAdvanceMsgs":"false"
    "SaySenderAfter":"false"
    "SaySenderExtensionAfter":"false"
    "SayMsgNumberAfter":"false"
    "SayAniAfter":"false"
    "SayMessageLengthAfter":"false"
    "UserTemplateRolesURI":"/vmrest/usertemplates/6164ac2d-e8ec-441a-93a0-
    95f8e18a655c/usertemplateroles"
    "UserTemplateNotificationDevicesURI":"/vmrest/usertemplates/6164ac2d-e8ec-441a-93a0-
    95f8e18a655c/usertemplatenotificationdevices"
    "TemplateExternalServiceAccountsURI":"/vmrest/usertemplates/6164ac2d-e8ec-441a-93a0-
    95f8e18a655c/templateexternalserviceaccounts"
    "UserTemplateWebPasswordURI":"/vmrest/usertemplates/6164ac2d-e8ec-441a-93a0-
    95f8e18a655c/credential/password"
    "UserTemplateVoicePinURI":"/vmrest/usertemplates/6164ac2d-e8ec-441a-93a0-
    95f8e18a655c/credential/pin"
    "UserTemplateMessageActionURI":"/vmrest/usertemplates/6164ac2d-e8ec-441a-93a0-
    95f8e18a655c/usertemplatemessageactions"
}
\]
}
Response Code: 200


Viewing the Details of Specific User Template

The following is an example of the GET request that lists the details of specific user template represented by the provided value of object ID:

  GET https://<connection-server>/vmrest/usertemplates/<usertemplateobjectId>

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

<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>
Response Code: 200

JSON Example

To view the particular user template, do the following:

Request URI:
GET https://<connection-server>/vmrest/usertemplates/<usertemplateobjectId>
Accept: application/json
Content_type: application/json
Connection: keep_alive

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

{
    "URI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-099afef0604d"
    "ObjectId":"a46d269a-6614-485b-8649-099afef0604d"
    "UseDefaultLanguage":"true"
    "UseDefaultTimeZone":"true"
    "Alias":"voicemailusertemplate"
    "DisplayName":"Voice Mail User Template"
    "TimeZone":"190"
    "CreationTime":"2013-02-21T11:39:11Z"
    "CosObjectId":"c93854b3-c59f-44e7-a6a9-0a6e17578672"
    "CosURI":"/vmrest/coses/c93854b3-c59f-44e7-a6a9-0a6e17578672"
    "Language":"1033"
    "LocationObjectId":"830e1a2d-8e90-459f-88f7-700497ba975c"
    "LocationURI":"/vmrest/locations/connectionlocations/830e1a2d-8e90-459f-88f7-
     700497ba975c"
    "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":"caf093ef-5e7b-47dd-9db7-9df360d2923e"
    "PhoneSystemURI":"/vmrest/phonesystems/caf093ef-5e7b-47dd-9db7-9df360d2923e"
    "Undeletable":"true"
    "UseBriefPrompts":"false"
    "Volume":"50"
    "EnAltGreetDontRingPhone":"false"
    "EnAltGreetPreventSkip":"false"
    "EnAltGreetPreventMsg":"false"
    "EncryptPrivateMessages":"false"
    "DeletedMessageSortOrder":"2"
    "SayAltGreetWarning":"false"
    "SaySenderExtension":"false"
    "SayAni":"false"
    "ExitCallActionObjectId":"ecc8570c-c0da-493e-a520-b125529cfee1"
    "CallAnswerTimeout":"4"
    "CallHandlerObjectId":"f4f87905-c20a-4df3-b20e-446c1798df19"
    "CallhandlerURI":"/vmrest/callhandlerprimarytemplates/f4f87905-c20a-4df3-b20e-
    446c1798df19"
    "DisplayNameRule":"1"
    "DoesntExpire":"false"
    "CantChange":"false"
    "MailboxStoreObjectId":"90e5847b-3a87-4c92-a753-eda6ea0fdb4c"
    "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":"d085ebc6-99ac-46a5-92f3-d26f52701585"
    "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":"-2"
    "SendQuota":"-2"
    "WarningQuota":"-2"
    "IsSetForVmEnrollment":"true"
    "VoiceNameRequired":"false"
    "SendBroadcastMsg":"false"
    "UpdateBroadcastMsg":"false"
    "ConversationVui":"VuiStart"
    "SpeechCompleteTimeout":"0"
    "SpeechIncompleteTimeout":"750"
    "UseVui":"false"
    "SkipPasswordForKnownDevice":"false"
    "JumpToMessagesOnLogin":"true"
    "EnableMessageLocator":"false"
    "MessageAgingPolicyObjectId":"12b765a8-a67b-47f6-8ede-3e02aea9f4fe"
    "MessageAgingPolicyURI":"/vmrest/messageagingpolicies/12b765a8-a67b-47f6-8ede-
    3e02aea9f4fe"
    "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":"5000"
    "SkipReverseTime":"5000"
    "UseShortPollForCache":"false"
    "SearchByExtensionSearchSpaceObjectId":"7aaf45b8-ab06-4dda-af16-378b04a95912"
    "SearchByExtensionSearchSpaceURI":"/vmrest/searchspaces/7aaf45b8-ab06-4dda-af16-
    378b04a95912"
    "SearchByNameSearchSpaceObjectId":"7aaf45b8-ab06-4dda-af16-378b04a95912"
    "SearchByNameSearchSpaceURI":"/vmrest/searchspaces/7aaf45b8-ab06-4dda-af16-
    378b04a95912"
    "PartitionObjectId":"9c010254-1493-4e1a-9e47-fe2494792744"
    "PartitionURI":"/vmrest/partitions/9c010254-1493-4e1a-9e47-fe2494792744"
    "UseDynamicNameSearchWeight":"false"
    "LdapType":"0"
    "EnableMessageBookmark":"false"
    "SayTotalDraftMsg":"false"
    "EnableSaveDraft":"false"
    "RetainUrgentMessageFlag":"false"
    "SayMessageLength":"false"
    "CreateSmtpProxyFromCorp":"false"
    "AutoAdvanceMsgs":"false"
    "SaySenderAfter":"false"
    "SaySenderExtensionAfter":"false"
    "SayMsgNumberAfter":"false"
    "SayAniAfter":"false"
    "SayMessageLengthAfter":"false"
    "UserTemplateRolesURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/usertemplateroles"
    "UserTemplateNotificationDevicesURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/usertemplatenotificationdevices"
    "TemplateExternalServiceAccountsURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/templateexternalserviceaccounts"
    "UserTemplateWebPasswordURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/credential/password"
    "UserTemplateVoicePinURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/credential/pin"
    "UserTemplateMessageActionURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/usertemplatemessageactions"
}
Response Code: 200


Viewing the Details of the User Templates Based on Partition Object ID

The following is an example of the GET request that lists the details of specific user template represented by the provided value of partition object ID:

GET https://<connection-server>/vmrest/usertemplates?query=(PartitionObjectId%20is%20<PartitionObjectId>)

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

<UserTemplate>
    <URI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-2b13f76bf631</URI>
    <ObjectId>c2056af2-bed7-4a0d-9039-2b13f76bf631</ObjectId>
    <UseDefaultLanguage>true</UseDefaultLanguage>
    <UseDefaultTimeZone>true</UseDefaultTimeZone>
    <Alias>Texoma_User_Template1</Alias>
    <City/>
    <State/>
    <Country>US</Country>
    <PostalCode/>
    <Manager/>
    <Building/>
    <Address/>
    <DisplayName>Texoma_User_Template1</DisplayName>
    <BillingId/>
    <TimeZone>190</TimeZone>
    <CreationTime>2012-12-26 13:04:28.9</CreationTime>
    <CosObjectId>0ef61610-a729-4b0d-9476-cab095028db3</CosObjectId>
    <CosURI>/vmrest/coses/0ef61610-a729-4b0d-9476-cab095028db3</CosURI>
    <Language>1033</Language>
    <LocationObjectId>27a67e01-bcb4-4012-8b1b-f0a08b736087</LocationObjectId>
    <LocationURI>/vmrest/locations/connectionlocations/27a67e01-bcb4-4012-8b1b-
    f0a08b736087</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>b6df8cb3-b3ce-4797-84f3-5559049df8e8</MediaSwitchObjectId>
    <PhoneSystemURI>/vmrest/phonesystems/b6df8cb3-b3ce-4797-84f3-
    5559049df8e8</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>0463e49b-cde4-4c30-877c-acfe25966a42</ExitCallActionObjectId>
    <CallAnswerTimeout>4</CallAnswerTimeout>
    <CallHandlerObjectId>83c9b890-6659-4c0f-8be6-8a1a85efee7e</CallHandlerObjectId>
    <CallhandlerURI>/vmrest/callhandlerprimarytemplates/83c9b890-6659-4c0f-8be6-
    8a1a85efee7e</CallhandlerURI>
    <DisplayNameRule>1</DisplayNameRule>
    <DoesntExpire>false</DoesntExpire>
    <CantChange>false</CantChange>
    <MailboxStoreObjectId>e983490d-78a5-45aa-b9a0-31f51460a5bd</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>PHGreeting</ExitTargetConversation>
    <ExitTargetHandlerObjectId>063956f9-c5ca-4e8b-be67-
    ff945a8a5d99</ExitTargetHandlerObjectId>
    <RepeatMenu>1</RepeatMenu>
    <FirstDigitTimeout>5000</FirstDigitTimeout>
    <InterdigitDelay>3000</InterdigitDelay>
    <PromptVolume>50</PromptVolume>
    <DelayAfterGreeting>0</DelayAfterGreeting>
    <AddressAfterRecord>false</AddressAfterRecord>
    <ConfirmDeleteMessage>false</ConfirmDeleteMessage>
    <ConfirmDeleteDeletedMessage>false</ConfirmDeleteDeletedMessage>
    <ConfirmDeleteMultipleMessages>true</ConfirmDeleteMultipleMessages>
    <IsClockMode24Hour>false</IsClockMode24Hour>
    <RouteNDRToSender>true</RouteNDRToSender>
    <NotificationType>0</NotificationType>
    <SendReadReceipts>1</SendReadReceipts>
    <ReceiveQuota>-2</ReceiveQuota>
    <SendQuota>-2</SendQuota>
    <WarningQuota>-2</WarningQuota>
    <IsSetForVmEnrollment>true</IsSetForVmEnrollment>
    <VoiceNameRequired>false</VoiceNameRequired>
    <SendBroadcastMsg>false</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>6780a194-6efd-4311-819f-
    494a082bb093</MessageAgingPolicyObjectId>
    <MessageAgingPolicyURI>/vmrest/messageagingpolicies/6780a194-6efd-4311-819f-
    494a082bb093</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>2e0da21b-54e4-4b51-9f09-
    960049a5e806</SearchByExtensionSearchSpaceObjectId> 
    <SearchByExtensionSearchSpaceURI>/vmrest/searchspaces/2e0da21b-54e4-4b51-9f09-
    960049a5e806</SearchByExtensionSearchSpaceURI> 
    <SearchByNameSearchSpaceObjectId>2e0da21b-54e4-4b51-9f09-
    960049a5e806</SearchByNameSearchSpaceObjectId> 
    <SearchByNameSearchSpaceURI>/vmrest/searchspaces/2e0da21b-54e4-4b51-9f09-
    960049a5e806</SearchByNameSearchSpaceURI>
   <PartitionObjectId>c6ff147e-c32c-4ade-8f12-46427c795c21</PartitionObjectId> 
   <PartitionURI>/vmrest/partitions/c6ff147e-c32c-4ade-8f12-46427c795c21</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/c2056af2-bed7-4a0d-9039-
   2b13f76bf631/usertemplateroles</UserTemplateRolesURI> 
   <UserTemplateNotificationDevicesURI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-
   2b13f76bf631/usertemplatenotificationdevices</UserTemplateNotificationDevicesURI> 
   <TemplateExternalServiceAccountsURI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-
   2b13f76bf631/templateexternalserviceaccounts</TemplateExternalServiceAccountsURI> 
   <UserTemplateWebPasswordURI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-
   2b13f76bf631/credential/password</UserTemplateWebPasswordURI> 
   <UserTemplateVoicePinURI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-
   2b13f76bf631/credential/pin</UserTemplateVoicePinURI> 
   <UserTemplateMessageActionURI>/vmrest/usertemplates/c2056af2-bed7-4a0d-9039-
   2b13f76bf631/usertemplatemessageactions</UserTemplateMessageActionURI>
</UserTemplate> 
Response Code: 200

JSON Example

To view the details of the user templates based on partition object ID, do the following:

Request URI:
GET https://<connection-server>/vmrest/usertemplates?query=(PartitionObjectId%20is%20<PartitionObjectId>)
Accept: application/json
Content_type: application/json
Connection: keep_alive

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

{
    "URI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-099afef0604d"
    "ObjectId":"a46d269a-6614-485b-8649-099afef0604d"
    "UseDefaultLanguage":"true"
    "UseDefaultTimeZone":"true"
    "Alias":"voicemailusertemplate"
    "DisplayName":"Voice Mail User Template"
    "TimeZone":"190"
    "CreationTime":"2013-02-21T11:39:11Z"
    "CosObjectId":"c93854b3-c59f-44e7-a6a9-0a6e17578672"
    "CosURI":"/vmrest/coses/c93854b3-c59f-44e7-a6a9-0a6e17578672"
    "Language":"1033"
    "LocationObjectId":"830e1a2d-8e90-459f-88f7-700497ba975c"
    "LocationURI":"/vmrest/locations/connectionlocations/830e1a2d-8e90-459f-88f7-
    700497ba975c"
    "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":"caf093ef-5e7b-47dd-9db7-9df360d2923e"
    "PhoneSystemURI":"/vmrest/phonesystems/caf093ef-5e7b-47dd-9db7-9df360d2923e"
    "Undeletable":"true"
    "UseBriefPrompts":"false"
    "Volume":"50"
    "EnAltGreetDontRingPhone":"false"
    "EnAltGreetPreventSkip":"false"
    "EnAltGreetPreventMsg":"false"
    "EncryptPrivateMessages":"false"
    "DeletedMessageSortOrder":"2"
    "SayAltGreetWarning":"false"
    "SaySenderExtension":"false"
    "SayAni":"false"
    "ExitCallActionObjectId":"ecc8570c-c0da-493e-a520-b125529cfee1"
    "CallAnswerTimeout":"4"
    "CallHandlerObjectId":"f4f87905-c20a-4df3-b20e-446c1798df19"
    "CallhandlerURI":"/vmrest/callhandlerprimarytemplates/f4f87905-c20a-4df3-b20e-
    446c1798df19"
    "DisplayNameRule":"1"
    "DoesntExpire":"false"
    "CantChange":"false"
    "MailboxStoreObjectId":"90e5847b-3a87-4c92-a753-eda6ea0fdb4c"
    "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":"d085ebc6-99ac-46a5-92f3-d26f52701585"
    "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":"-2"
    "SendQuota":"-2"
    "WarningQuota":"-2"
    "IsSetForVmEnrollment":"true"
    "VoiceNameRequired":"false"
    "SendBroadcastMsg":"false"
    "UpdateBroadcastMsg":"false"
    "ConversationVui":"VuiStart"
    "SpeechCompleteTimeout":"0"
    "SpeechIncompleteTimeout":"750"
    "UseVui":"false"
    "SkipPasswordForKnownDevice":"false"
    "JumpToMessagesOnLogin":"true"
    "EnableMessageLocator":"false"
    "MessageAgingPolicyObjectId":"12b765a8-a67b-47f6-8ede-3e02aea9f4fe"
    "MessageAgingPolicyURI":"/vmrest/messageagingpolicies/12b765a8-a67b-47f6-8ede-
    3e02aea9f4fe"
    "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":"5000"
    "SkipReverseTime":"5000"
    "UseShortPollForCache":"false"
    "SearchByExtensionSearchSpaceObjectId":"7aaf45b8-ab06-4dda-af16-378b04a95912"
    "SearchByExtensionSearchSpaceURI":"/vmrest/searchspaces/7aaf45b8-ab06-4dda-af16-378b04a95912"
    "SearchByNameSearchSpaceObjectId":"7aaf45b8-ab06-4dda-af16-
    378b04a95912"
    "SearchByNameSearchSpaceURI":"/vmrest/searchspaces/7aaf45b8-ab06-4dda-af16-
    378b04a95912"
    "PartitionObjectId":"9c010254-1493-4e1a-9e47-fe2494792744"
    "PartitionURI":"/vmrest/partitions/9c010254-1493-4e1a-9e47-fe2494792744"
    "UseDynamicNameSearchWeight":"false"
    "LdapType":"0"
    "EnableMessageBookmark":"false"
    "SayTotalDraftMsg":"false"
    "EnableSaveDraft":"false"
    "RetainUrgentMessageFlag":"false"
    "SayMessageLength":"false"
    "CreateSmtpProxyFromCorp":"false"
    "AutoAdvanceMsgs":"false"
    "SaySenderAfter":"false"
    "SaySenderExtensionAfter":"false"
    "SayMsgNumberAfter":"false"
    "SayAniAfter":"false"
    "SayMessageLengthAfter":"false"
    "UserTemplateRolesURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/usertemplateroles"
    "UserTemplateNotificationDevicesURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/usertemplatenotificationdevices"
    "TemplateExternalServiceAccountsURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/templateexternalserviceaccounts"
    "UserTemplateWebPasswordURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/credential/password"
    "UserTemplateVoicePinURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/credential/pin"
    "UserTemplateMessageActionURI":"/vmrest/usertemplates/a46d269a-6614-485b-8649-
    099afef0604d/usertemplatemessageactions"
}
Response Code: 200

NOTE: Same way user templates can be viewed for particular COS object ID, mailbox store object ID, phone system and call handler object ID.

  • PartitionObjectId can be viewed from https://<connection-server>/vmrest/partitions
  • COSObjectId : https://<connection-server>/vmrest/coses
  • PhoneSystem : https://<connection-server>/vmrest/phonesystems

Creating a User Template

The request can be used to create the User Template. It can be used to create the User Template with specific Partition Object ID, COS, MailboxStoreObjectId, Phone System. The following is an example of the POST request that creates a new user template:

  POST https://<connection-server>/vmrest/usertemplates?templateAlias=voicemailusertemplate
Request Body:
<UserTemplate>
    <Alias>ABC_user template</Alias>
    <DisplayName>ABC@user template</DisplayName>
</UserTemplate>

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

Response Code: 201

JSON Example

To create user template:

POST https://<connection-server>/vmrest/usertemplates?templateAlias=voicemailusertemplate
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
    "Alias":"voicemailusertemplate1",
    "DisplayName":"Voice Mail User Template 1"
}

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

Response Code: 201


Creating a User Template with Specific Partition Object ID

The request can be used to create the User Template. It can be used to create the User Template with specific Partition Object ID, COS, MailboxStoreObjectId, Phone System. The following is an example of the POST request that creates a new user template:

 
POST https://<connection-server>/vmrest/usertemplates?templateAlias=voicemailusertemplate
Request Body:
<UserTemplate>
    <Alias>ABCs_user template</Alias>
    <DisplayName>ABCs@user template</DisplayName>
    <PartitionObjectId>00c25bc8-d3d0-45ec-a786-fcf7a35593cf</PartitionObjectId>
</UserTemplate>

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

Response Code: 201

NOTE: Get partition object Id from " https://<connection-server>/vmrest/partitions " . In same way users templates can be created using specific COS object ID, MailboxStoreObjectId, Phone System.

JSON Example

To create user template with specific partition ID, do the following:

Request URI:
POST https://<connection-server>/vmrest/usertemplates?templateAlias=<TemplatealiasName> 
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
    "Alias":"voicemailusertemplate12",
    "DisplayName":"Voice Mail User Templater12",
    "PartitionObjectId":"be52d373-25c4-416c-81c1-b82479061192"
}

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

Response Code: 201


Updating Fields of User Templates

The request can be used to update the fields of a user template. It can be used to update Alias, Display Name, Time Zone, Language, COS, Partition Object ID, Phone System and Basic Setting fields of a user template. The following is an example of the PUT request that updates a user template:

  PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>
Request Body:
<UserTemplate>
    <Alias>ABCD_user template</Alias>
    <UseDefaultLanguage>true</UseDefaultLanguage>
    <Language>1033</Language>
    <UseDefaultTimeZone>true</UseDefaultTimeZone>
    <TimeZone>190</TimeZone>
    <CosObjectId>6f054167-6f6c-4ed5-a498-1776337871ee</CosObjectId> 
    <MediaSwitchObjectId>221ee752-5147-4326-9990-d4a138674f9e</MediaSwitchObjectId> 
</UserTemplate>

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

Response Code: 204

JSON Example

To update fields of a user template:

PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
    "Alias":"ABC_user template",
    "DisplayName":"Auser template",
    "UseDefaultLanguage":"false",
    "TimeZone":"190",
    "MediaSwitchObjectId":"caf093ef-5e7b-47dd-9db7-9df360d2923e",
    "CosObjectId":"c93854b3-c59f-44e7-a6a9-0a6e17578672"
}

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

Response Code: 204


Update Country Code of the User Template

To view the country code, use the following URI:

  GET https://<connection-server>/vmrest/languagemap 

And to check language check; use last 2 characters of language check to change the country code.

The following is an example of the PUT request that updates the country code of a user template:

  PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>
Request Body:
<UserTemplate>
    <Country>SA</Country>
</UserTemplate>

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

Response Code: 204

JSON Example

To update the country code of a user template, do the following:

Request URI:
PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
    "Country":"XY"
}

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

Response Code: 204

NOTE: Country code must only have 2 character codes.


Update Language of User Template

To view the language code, use the following URI:

  PUT https://<connection-server>/vmrest/languagemap

And check language code; use that language code to change language of user template.

The following is an example of the PUT request that updates the language of a user template:

  PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>
Request Body:
<UserTemplate>
    <Language>1025</Language>
</UserTemplate>

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

Response Code: 204

JSON Example

To update the language of a user template, do the following:

Request URI:
PUT https://<connection-server>/vmrest/usertemplates/< usertemplateobjectid >
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
    "Language":"1025"
}

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

Response Code: 204


Delete the User Template

The following is an example of the DELETE request that can be used to delete a user template:

DELETE https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>
Response Code: 204

JSON Example

To delete a user template, do the following:

Request URI:
DELETE https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>
Accept: application/json
Content_type: application/json
Connection: keep_alive
Response Code: 204


Updating Password Settings and Changing Passwords

Example 1: Updating voicemail password The following is an example of the PUT request that can be used to update the voicemail password:

  PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/credential/pin
Request Body:
<UserTemplateCredential>
    <Credentials>142536</Credentials> 
</UserTemplateCredential>

The following is the response from the above *PUT* request for updating credentials and the actual response will depend upon the information given by you:

Response Code: 204

NOTE: Voicemail should be in numeric only.

JSON Example

To update the credentials, do the following:

Request URI:
PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/credential/pin
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
    "Credentials":"10255"
}

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

Response Code: 204

Example 2: To update the fields The following is the response from the above *PUT* request for updating fields and the actual response will depend upon the information given by you:

Request Body:
<UserTemplateCredential>
    <DoesntExpire>true</DoesntExpire>
    <Locked>false</Locked>
    <CantChange>false</CantChange> 
    <CredMustChange>false</CredMustChange>
    <CredentialPolicyObjectId>58f0dc20-f8fc-467d-a648-b5ffbba87dd9</CredentialPolicyObjectId> 
</UserTemplateCredential>
Response Code: 204

NOTE: Updating fields can be done only when "CredMustChange" parameter is false and in order to change authentication rule and to view authentication rule use the following URI:

GET https://<connection-server>/vmrest /authenticationrules

Example 3: Updating web application password The following is an example of the PUT request that can be used to update the web application password:

PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/credential/password
Request Body:
<UserTemplateCredential>
    <Credentials>Cisco123</Credentials> 
</UserTemplateCredential>

The following is the response from the above *PUT* request for updating credentials and the actual response will depend upon the information given by you:

Response Code: 204

NOTE: Web password should be in alphanumeric only.

JSON Example

To update the credentials, do the following:

Request URI:
PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/credential/password
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
    "Credentials":"10255",
    "CantChange":"false",
    "DoesntExpire":"true",
    "Locked":"false",
    "CredMustChange":"false",
    "CredentialPolicyObjectId":"7b282b66-73b1-4989-9d94-3d105b6ef5e8"
}

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

Response Code: 204

The following is the response from the above *PUT* request for updating fields and the actual response will depend upon the information given by you:

Request Body:
<UserTemplateCredential>
    <DoesntExpire>true</DoesntExpire>
    <Locked>false</Locked>
    <CantChange>false</CantChange> 
    <CredMustChange>false</CredMustChange>
    <CredentialPolicyObjectId>58f0dc20-f8fc-467d-a648-b5ffbba87dd9</CredentialPolicyObjectId> 
</UserTemplateCredential>
Response Code: 204

NOTE: Updating fields can be done only when "CredMustChange" parameter is false and in order to change authentication rule and to view authentication rule use the following URI:

GET https://<connection-server>/vmrest /authenticationrules


Adding or Deleting Roles

To view the roles object ID use the following URI:

  GET https://<connection-server>/vmrest/roles

Example 1: Adding the roles The following is an example of the POST request that can be used to add the roles:

PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplateroles
Request Body:
<UserTemplateRole>
    <RoleObjectId>4f077e4e-61c7-4ce8-a58a-2c4bc6089319</RoleObjectId>
</UserTemplateRole>

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

Response Code: 201

JSON Example

To add the roles, do the following:

Request URI:
POST https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplateroles
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
    "RoleObjectId":"04d0f1ef-a8c6-454a-8cf0-0e8db7bb2b15"
}

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

Response Code: 201

Example 2: Viewing roles of user template The following is an example of the GET request that can be used to view the roles:

  GET https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplateroles

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

<UserTemplateRole>
    <URI>/vmrest/usertemplates/d8054a3a-6c09-4a25-9880-
    6589d2f1dc85/usertemplateroles/973e143e-af15-4ef4-a7c1-5fafd9cc53d4</URI>
    <ObjectId>973e143e-af15-4ef4-a7c1-5fafd9cc53d4</ObjectId>
    <UserObjectId>d8054a3a-6c09-4a25-9880-6589d2f1dc85</UserObjectId>
    <UserURI>/vmrest/users/d8054a3a-6c09-4a25-9880-6589d2f1dc85</UserURI>
    <RoleObjectId>ba166947-41e8-4ec9-ad14-03658d91240e</RoleObjectId>
    <RoleURI>/vmrest/roles/ba166947-41e8-4ec9-ad14-03658d91240e</RoleURI>
    <RoleName>Audit Administrator</RoleName>
    <Alias>ABCD_user template</Alias>
</UserTemplateRole>
Response Code: 200

JSON Example

To view the roles, do the following:

Request URI:
GET https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplateroles
Accept: application/json
Content_type: application/json
Connection: keep_alive

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

{
  "@total":"1"
  "UserTemplateRole":
  {
    "URI":"/vmrest/usertemplates/a9272189-720b-44b3-86e0-
    df7ef519599c/usertemplateroles/167b7661-ee8b-4c83-8867-decb88ec0c1c"
    "ObjectId":"167b7661-ee8b-4c83-8867-decb88ec0c1c"
    "UserObjectId":"a9272189-720b-44b3-86e0-df7ef519599c"
    "UserURI":"/vmrest/users/a9272189-720b-44b3-86e0-df7ef519599c"
    "RoleObjectId":"04d0f1ef-a8c6-454a-8cf0-0e8db7bb2b15"
    "RoleURI":"/vmrest/roles/04d0f1ef-a8c6-454a-8cf0-0e8db7bb2b15"
    "RoleName":"Help Desk Administrator"
    "Alias":"tenant005_usertemplate_1"
  }
}
Response Code: 200

Example 3: Delete role of user template The following is an example of the DELETE request that can be used to view the roles:

DELETE https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplateroles/<usertemplaterolesId>

The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:

Response Code: 204

JSON Example

To delete role of user template, do the following:

Request URI:
DELETE https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplateroles/<usertemplateroleid>
Accept: application/json
Content_type: application/json
Connection: keep_alive

The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:

Response Code: 204


Explanation of Data Fields

Parameter Operations Data Type Comments
Alias String(64) Read/Write A unique text name for addressable objects: Global Users, Contacts, DistributionLists, and PersonalGroups.
DisplayName String(64) Read/Write Enter a descriptive name for the user template.
ObjectID String(36) Read-Only Specifies a globally unique, system-generated identifier for a UserSubscriber object.
UseDefaultLanguage Boolean Read/Write Possible values can be:
  • False: The language is the default language defined for the user template.
  • True: The language is derived from the location to which this user template belongs.

Default value: False

UseDefaultTimeZone Boolean Read/Write Possible values can be:
  • False: The time zone is the default time zone defined for the user template.
  • True: The time zone is derived from the location to which this user template belongs.

Default value: False

City String(64) Read/Write Enter the city. (optional)
State String(64) Read/Write Enter the state. (optional)
Country String(2) Read/Write Enter the country. (optional)
PostalCode String(40) Read/Write Enter the Postal code (optional)
Department String(64) Read/Write Enter the users department. (optional)
Manager String(64) Read/Write Enter the name of the manager. (optional)
Address String(64) Read/Write Enter the user address .(optional)
BillingId String(32) Read/Write Billing ID can be used for organization-specific information, such as accounting information, department names, or project codes.
TimeZone Integer Read/Write Select the desired time zone for the user, or check the Use System Default Time Zone check box.
CreationTime DateTime Read-Only The date and time the user template was created.
CosObjectId String(36) Read/Write The unique identifier of the COS (Class of Service) object to which this user template account is associated.
Language Integer Read/Write Select Use System Default Language or select a language from the list
VoiceName String Read/Write Wav file that contains recorded name.
LocationObjectID String(36) Read-Only The unique identifier of the LocationVMS object to which this user belongs.
AddressMode Integer default The default method the subscriber will use to address messages to other subscribers.

Possible options are:

  • 0=LastNameFirst
  • 1=Extension
  • 2=FirstNameFirst
ClockMode Integer Read-Only The time format used for the message timestamps that the subscriber hears when they listen to their messages over the phone.

Possible options are:

  • 0=SystemDefaultClock
  • 1=HourClock12
  • 2=HourClock24
ConversationTUI String(64) Read-Only The name of the conversation the subscriber uses to set up, send, and retrieve messages.
GreetByName Boolean Read-Only A flag indicating whether the subscriber hears his/her name when they log into their mailbox over the phone.

Values can be:

  • False: Do not play the name.
  • True: Play the recorded voice name.

Default value: True

ListInDirectory Boolean Read/Write A flag indicating whether system should list the subscriber in the phone directory for outside callers.

Possible values can be:

  • False: Do not list the subscriber in the phone directory.
  • True: List the subscriber in the phone directory.

Default value: True

IsVmEnrolled Boolean Read/Write A flag indicating whether system plays the enrollment conversation (record a voice name, indicate if they are listed in the directory, etc.) for the subscriber when they login.

Values can be:

  • False: The enrollment conversation is not played for the subscriber when they login.
  • True: The enrollment conversation is played for the subscriber when they login.

Default value: True

SayCopiedNames Boolean Read/Write A flag indicating whether system announces the "copied" names during message playback for a subscriber.

Values can be:

  • False: Do not announce copied names.
  • True: Announce copied names.

Default value: True

SayDistributionList Boolean Read/Write A flag indicating whether system announces the distribution list that sends a message, if applicable.

Values can be:

  • False: Do not announce the distribution list.
  • True: Announce the distribution list.

Default value: True

SayMsgNumber Boolean Read/Write A flag indicating whether system announces the position of each message in the stack (i.e., 'Message 1', 'Message 2' ,etc.) during message playback for the subscriber.

Values can be:

  • False: Do not play the message number.
  • True: Play the message number.

Default value: True

SaySender Boolean Read/Write A flag indicating whether system announces the sender of a message during message playback for the subscriber.

Values can be:

  • False: Do not announce the sender.
  • True: Announce the sender.

Default value: True

SayTimeStampAfter Boolean Read/Write A flag indicating whether system announces the timestamp after it plays back each message for the subscriber.

Values can be:

  • False: Do not announce the timestamp after each message is played.
  • True: Announce the timestamp after each message is played.

Default value: True

SayTimestampBefore Boolean Read/Write A flag indicating whether system announces the timestamp before it plays back each for the subscriber.

Values can be:

  • False: Do not announce the timestamp before each message is played.
  • True Announce the timestamp before each message is played.

Default value: False

SayTotalNew Boolean Read/Write A flag indicating whether system announces the total number of new messages in the subscriber mailbox.

Values can be:

  • False: Do not announce total number of new messages.
  • True: Announce the total number of new messages in the subscriber mailbox.

Default value: False

SayTotalNewEmail Boolean Read/Write A flag indicating whether system announces the total number of new e-mail messages in the subscriber mailbox.

Values can be:

  • False: Do not announce total number of new e-mail messages.
  • True: Announce the total number of new e-mail messages in the subscriber mailbox.

Default value: False

SayTotalNewFax Boolean Read/Write A flag indicating whether system announces the total number of new fax messages in the subscriber mailbox.

Values can be:

  • False: Do not announce total number of new fax messages.
  • True: Announce the total number of new fax messages in the subscriber mailbox.

Default value: False

SayTotalNewVoice Boolean Read/Write A flag indicating whether system announces the total number of new voice messages in the subscriber mailbox.

Values can be:

  • False: Do not announce total number of new voice messages.
  • True: Announce the total number of new voice messages in the subscriber mailbox.

Default value: True

SayTotalReceipts Boolean Read/Write A flag indicating whether system announces the total number of new receipts in the subscriber mailbox.

Values can be:

  • False: Do not announce total number of new receipts.
  • True: Announce the total number of new receipts in the subscriber mailbox.

Default value: False

SayTotalSaved Boolean Read/Write A flag indicating whether system announces the total number of saved messages in the subscriber mailbox.

Values can be:

  • False: Do not announce total number of saved messages.
  • True: Announce the total number of saved messages in the subscriber mailbox.

Default value: True

Speed Integer Read/Write The audio speed system uses to play back messages to the subscriber. Range: 0-200.
MediaSwitchObjectId String(36) Read-Only The unique identifier of the MediaSwitch object Cisco Unity Connection uses for subscriber Telephone Record and Playback (TRAP) sessions and to dial MWI on or off requests when the Cisco Unity Connection system has dual switch integration.
Undeletable Boolean Read/Write Tells whether it can be deleted by administrator or not.
UseBriefPrompts Boolean Read/Write A flag indicating whether the subscriber hears brief or full phone menus when accessing system over the phone.

Default value: False

Volume Integer Read/Write The audio volume expressed as a percentage that Cisco Unity Connection uses to play back message. Range: 0-100
EnAltGreetDontRingPhone Boolean Read-Only A flag indicating whether a caller is prevented from being transferred to the subscriber phone when the subscriber alternate greeting is turned on.

Values can be:

  • False: Ring the phone.
  • True: Send the caller to the alternate greeting.

Default value: False

EnAltGreetPreventSkip Boolean Read-Only A flag indicating whether callers can skip the greeting while it is playing when the alternate greeting is turned on.

Values can be:

  • False: If alternate greeting is active, callers cannot skip the greeting\
  • True: If alternate greeting is active, callers can skip the greeting.

Default value: False

EnAltGreetPreventMsg Boolean Read-Only A flag indicating whether callers can leave a message after the greeting when the subscriber alternate greeting is turned on.

Values can be:

  • False: If alternate greeting is active, callers can leave a message for the subscriber
  • True: If alternate greeting is active, callers cannot leave a message for the subscriber.

Default value: False

EncryptPrivateMessages Boolean Read-Only A flag indicating whether system encrypts messages from the subscriber that are marked private.

Values can be:

  • False: Do not encrypt private messages.
  • True: Encrypt private messages.

Default value: False

DeletedMessageSortOrder Integer Read-Only The order in which system presents deleted messages to the subscriber.
SayAltGreetWarning Boolean Read-Only A flag indicating whether Cisco Unity Connection notifies the subscriber when they login via the phone (plays conversation) or CPCA (displays a warning banner) if their alternate greeting is turned on.

Values can be:

  • False: Do not notify the subscriber that their alternate greeting is turned on.
  • True: Notify the subscriber when they login if their alternate greeting is turned on.

Default value: False

SaySenderExtension Boolean Read-Only A flag indicating whether Cisco Unity Connection during message playback, plays the primary extension information of the subscriber who sent the message after playing the sender's voice name.

Values can be:

  • False: Do not play the extension information of the subscriber who sent the message.
  • True: After playing the sender's voice name, play the primary extension information of the subscriber who sent the message.

Default value: False

SayAni Boolean Read-Only A flag indicating whether Cisco Unity Connection plays the Automatic Number Identification (ANI) information during message playback for voice messages from unidentified callers.

Default value: False

ExitCallActionObjectId String(36) Read-Only The unique identifier of the CallAction object that is taken when a caller exits the subscriber conversation by pressing the * key or timing out.
CallAnswerTimeout Integer Read/Write The number of rings to wait for a subscriber destination to answer before the call is forwarded to the subscriber's primary phone.
CallHandlerObjectId String(36) Read-Only The unique identifier of the primary CallHandler object for the subscriber.
DisplayNameRule Integer Read/Write The format for generating the user display name.
DoesntExpire Boolean Read/Write A flag indicating whether or not the user credential will automatically expire (and the user required to change the credential upon its expiration) based on a defined schedule. Regardless, the user still may change the credential (if allowed by CantChange).

Values can be:

  • False: The user credential will automatically expire. The expiration of the credential is controlled by the value of the column tbl_CredentialPolicy->MaxDays.
  • True: The user credential will not automatically expire.

Default value: False

CantChange Boolean Read-Only A flag indicating whether the user can set/change their credential (i.e., the credential specified by the associated credential policy).

Values can be:

  • False: User is allowed to change their credential.
  • True: User cannot change their credential.

Default value: False

MailboxStoreObjectId String(36) Read-Only The unique identifier of the MailboxStore object where a mailbox is created for a new subscriber created with this template.
SavedMessageStackOrder String(36) Read/Write The order in which system plays the following types of saved messages:
  • Urgent voice messages
  • Non-urgent voice messages
  • Urgent fax messages
  • Non-urgent fax messages
  • Urgent e-mail messages
  • Non-urgent e-mail messages
  • Receipts and notices
NewMessageStackOrder String(36) Read/Write The order in which system plays the following types new messages:
  • Urgent voice messages
  • Non-urgent voice messages* Urgent fax messages
  • Non-urgent fax messages
  • Urgent e-mail messages
  • Non-urgent e-mail messages
  • Receipts and notices
MessageLocatorSortOrder Integer Read/Write The order in which system will sort messages when the "Message Locator" feature is enabled.
SavedMessageSortOrder Integer Read/Write The order in which system will sort saved messages.
NewMessageSortOrder Integer Read/Write The order in which system will sort new messages.
MessageTypeMenu Boolean Read/Write A flag indicating whether system plays the message type menu when the subscriber logs on to system over the phone.

Values can be:

  • False: Do not play message type menu.
  • True: Play message type menu.

Default value: False

EnablePersonalRules Boolean Read/Write A flag indicating whether a subscriber's personal rules are enabled. Subscribers can use this setting to disable all personal rules at once.

Values can be:

  • False: Call routing rules disabled for subscriber.
  • 1: Call routing rules enabled for subscriber.
  • True: Call routing rules enabled for subscriber.

Default value: True

ForcedAuthorizationCode String(36) Read-Only A valid authorization code that is entered prior to extending calls to classes of dialed numbers, for example, external, toll and international calls.
RecordUnknownCallerName Boolean Read/Write A flag indicating whether a caller should be promoted to record his/her name if Unity does not receive caller id.

Default value: True

RingPrimaryPhoneFirst Boolean Read/Write A flag indicating whether a subscriber's primary phone should be rung before trying other destinations in a personal group.

Default value: False

PromptSpeed Integer Read/Write The audio speed system uses to play back prompts to the subscriber.
ExitAction Integer Read/Write Type of call action to take, e.g., hang-up, go to another object, etc.
ExitTargetConversation String(64) Read/Write The name of the conversation to which the caller is routed.
ExitTargetHandlerObjectId String(36) Read-Only The unique identifier of the specific object to send along to the target conversation.
RepeatMenu Integer Read/Write The number of times to repeat a menu in TUI. Possible range 0-250
FirstDigitTimeout Integer Read/Write The amount of time to wait (in milliseconds) for first digits when collecting touch tones. Range: 500-10000.
InterdigitDelay Integer Read-Only The amount of time to wait (in milliseconds) for input between touch tones when collecting digits in TUI. Range: 1000-10000
PromptVolume Integer Read/Write The volume level for playback of system prompts. Range: 0-100.
DelayAfterGreeting Integer Read/Write The amount of time (in milliseconds) Cisco Unity Connection will delay after playing greeting. Range: 0-50000.
ClientMatterCode String(40) Read-Only The client matter code to transmit to Call Manger when a phone number is dialed on an outbound call. The CMC is entered after a phone number is dialed so that the customer can assign account or billing codes to the call. Whether or not the CMC will be transmitted is dictated by a setting on outbound call. The subscriber's CMC is used only if the outbound call doesn't have its own CMC.
AddressAfterRecord Boolean Read/Write A flag indicating whether the subscriber will be prompted to address message before or after it is recorded.

Values can be:

  • False: Prompt subscriber to address message before recording.
  • True: Prompt subscriber to address message after recording.

Default value: False

ConfirmDeleteMessage Boolean Read/Write A flag indicating whether system will request confirmation from a subscriber before proceeding with a deletion of a single new or saved message.

Values can be:

  • False: system will not request confirmation from a subscriber before proceeding with a deletion of a single new or saved message.
  • True: system will request confirmation from a subscriber before proceeding with a deletion of a single new or saved message.

Default value: False

ConfirmDeleteMultipleMessages Boolean Read/Write A flag indicating whether system allows the subscriber to choose which message they want to delete or whether system permanently deletes the specified type of messages. A change what system does when subscribers press 3 > 2 > 2 from the Main menu to permanently delete multiple deleted messages at once.

Values can be:

  • False: System does not prompt the subscriber to choose, and instead permanently deletes the type of messages you specify: either deleted voice messages or all deleted messages (voice, fax, and e-mail, as applicable).
  • True: System allows the subscriber to choose which messages they want to delete; subscriber can either delete their deleted voice messages or delete all of their deleted messages.

Default value: True

PabLastImported String(36) Read-Only The date and time when the personal address book was last imported from a groupware package into the personal groups for a user.
IsClockMode24Hour Boolean Read/Write The time format used for the message timestamps that the subscriber hears when they listen to their messages over the phone.

Values can be:

  • False: 12-Hour clock - The subscriber hears message timestamps in the time format of a 12-hour clock. For example, a subscriber will hear 1:00 PM when listening to the timestamp of a message left at 1:00 PM.
  • True: 24-Hour clock - The subscriber hears message timestamps in the time format of a 24-hour clock. For example, a subscriber will hear 13:00 when listening to the timestamp of a message left at 1:00 PM.

Default value: False

RouteNDRToSender Boolean Read/Write For an undeliverable message, whether NDR messages will appear in the subscriber mailbox or are deleted by the system.
NotificationType Integer Read/Write The notification type to use for this mailbox created.
SendReadReceipts Integer Read/Write A flag indicating whether the mailbox created with this subscriber allows the system to send read receipts on its behalf.

Values can be:

  • 0: Disable
  • 1: Enable
SendQuota Integer Read/Write The mailbox size (in bytes) send limit. (2048 MB)

Values can be:

  • 1: The quota is unlimited.
  • 2: The default system quota is assigned.
WarningQuota Integer Read/Write The mailbox size (in bytes) warning limit. (2048 MB)

Values can be:

  • 1: The quota is unlimited.
  • 2: The default system quota is assigned.
ReceiveQuota Integer Read/Write The mailbox size (in bytes) receive limit. (2048 MB)

Values can be:

  • 1: The quota is unlimited.
  • 2: The default system quota is assigned.
MailboxDn String(36) Read-Only The distinguished name of the mailbox.
SynchScheduleObjectId String(36) Read-Only The unique identifiers of the Schedule object to use for synchronization Calendar information from groupware (such as Exchange).
IsSetForVmEnrollment Boolean Read-Only Temporary placeholder until IsVmEnrolled can be phased out.
SendBroadcastMsg Boolean Read/Write A flag indicating whether the subscriber may send broadcast messages.

Values can be:

  • False: Cannot send broadcast messages.
  • True: Can send broadcast messages.

Default value: False

UpdateBroadcastMsg Boolean Read/Write A flag indicating whether the subscriber has the ability to update broadcast messages that are active or will be active in the future.

Values can be:

  • False: Cannot update broadcast messages.
  • True: Can update broadcast messages.

Default value: False

ConversationVUI Boolean Read/Write The VUI conversation assigned to the subscriber.
SpeechCompleteTimeout Integer Read-Only Specifies the required length of silence (in milliseconds) following user speech before the recognizer finalizes a result.
SpeechIncompleteTimeout Integer Read-Only Specifies the required length of silence (in milliseconds) from when the speech prior to the silence matches an active grammar.
UseVui Boolean Read/Write A flag indicating whether the speech recognition conversation is the default conversation for the subscriber.

Values can be:

  • False: Speech recognition conversation is not default conversation for the subscriber.
  • True: Speech recognition conversation is the default conversation for the subscriber.

Default value: False

SkipPasswordForKnownDevice Boolean Read/Write A flag indicating whether the subscriber will be asked for his/her PIN when attempting to sign-in from a known device.

Default value: False

JumpToMessagesOnLogin Boolean Read/Write A flag indicating whether the subscriber conversation jumps directly to the first message in the message stack after subscriber sign-in.

Values can be:

  • False: Subscriber conversation does not jump directly to first message in the message stack after subscriber sign-in.
  • True: Subscriber conversation jumps directly to the first message in the message stack after subscriber sign-in.

Default value: True

EnableMessageLocator Boolean Read/Write A flag indicating whether the message locator feature is enabled for the subscriber.

Values can be:

  • False: Message locator feature is disabled for subscriber.
  • True: Message locator feature is enabled for subscriber.

Default value: False

MessageAgingPolicyObjectId String(36) Read-Only The unique identifier of the MessageAgingPolicy object that applies to the mailbox created for a new subscriber created with this template.
AssistantRowsPerPage Integer Read-Only This controls the number of entries to display per page for all tables in the Unity Assistant, e.g. the Private List Members table.
InboxMessagesPerPage Integer Read-Only The number of messages Unity Inbox displays in a page.
InboxAutoRefresh Integer Read-Only The rate (in minutes) at which Unity Inbox performs a refresh.
InboxAutoResolveMessageRecipients Integer Read-Only A flag indicating whether Cisco Unity Connection automatically resolves a recipient address entered in the To, Cc or Bcc fields to a subscriber or distribution list. Known as the "AutoResolve" feature.
PcaAddressBookRowsPerPage Integer Read-Only Controls the number of matching entries the Address Book displays per page, when a search is performed. The Address Book is used across multiple PCA applications and so this setting applies globally.
PcaHomePage String(36) Read-Only The Home Page is the first page that is displayed after logging in to the PCA.
EnableTts Boolean Read/Write A flag indicating whether TTS is enabled for the subscriber. Only relevant if TTS enabled in User's COS also.

Values can be:

  • False: TTS is disabled for the subscriber.
  • True: TTS is enabled for the subscriber

Default value: True

ConfirmationConfidenceThreshold Integer Read-Only Voice Recognition Confirmation Confidence Threshold.
AnnounceUpcomingMeetings Integer Read-Only The amount ahead of time, in minutes, that Connection will warn the subscriber of upcoming meetings when the subscriber calls into the system.
SpeechConfidenceThreshold Integer Read-Only When the engine matches a spoken phrase, it associates a confidence level with that conclusion. This parameter determines what confidence level should be considered a successful match. A higher value means the engine is will report fewer successful matches, but it will be more confident in the matches that it reports. Range: 0-100.
SpeechSpeedVsAccuracy Integer Read-Only Sets accuracy and performance of speech.
SpeechSensitivity Integer Read-Only A variable level of sound sensitivity that enables the speech engine to filter out background noise and not mistake it for speech.
EnableVisualMessageLocator Boolean Read/Write A flag indicating whether the visual message locator feature is enabled for the subscriber. The visual message locator feature presents a list of messages on the subscriber's IP phone display for the subscriber to select from visually.

Values can be:

  • False: Visual message locator feature disabled for subscriber.
  • True: Visual message locator feature enabled for subscriber.

Default value: False

ContinuousAddMode Boolean Read/Write A flag indicating whether when addressing, after entering one recipient name, whether the subscriber is asked to enter another name or assume the subscriber is finished adding names and is ready to move on to recording the message or applying message options.

Values can be:

  • False: Unity Connection prompts subscribers to press 1 to add more recipients.
  • True: Unity Connection does not prompt subscribers to press 1 to add more recipients. Instead, subscribers continue entering recipient names or extensions (as applicable) until they indicate that they have completed addressing.

Default value: False

NameConfirmation Boolean Read/Write Whether voice name of the user or distribution list is played or not.

Values can be:

  • False: No voice name played.
  • True: Voice name of subscriber or DL is played.

Default value: False

CommandDigitTimeout Integer(4) Read-Only The amount of time (in milliseconds) between digits on a multiple digit menu command entry (i.e. different than the inter digit timeout that is used for strings of digits such as extensions and transfer strings).

Default value: 1500 Range: 250-5000

SaveMessageOnHangup Boolean Read/Write A flag indicating when hanging up while listening to a new message, whether the message is marked new again or is marked read.

Values can be:

  • False: Message is marked new again.
  • True: Message is marked read.

Default value: False

SkipForwardTime Int(4) Read-Only Indicates the amount of time (in milliseconds) to jump forward when skipping ahead in a voice or TTS message using either DTMF or voice commands while reviewing messages.

Default Value: 5000 Range: 1000-60000

SkipReverseTime Int(4) Read-Only Indicates the amount of time (in milliseconds) to jump backward when skipping in reverse in a voice or TTS message using either DTMF or voice commands while reviewing messages.

Default Value: 5000 Range: 1000-60000

UseShortPollForCache Boolean Read-Only A flag indicating whether the user's polling cycle for retrieving calendar information will be the shorter "power user" polling cycle.

Values can be:

  • False: The subscriber's polling cycle is determined by the system default polling cycle. (default value) (System configuration setting "Normal Calendar Caching Poll Interval").
  • True: The shorter "power user" polling cycle is used. (System configuration setting "Short Calendar Caching Poll Interval").

Default value: False

SearchByExtensionSearchSpaceObjectId String(36) Read-Only The unique identifier of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by extension (dial string).
SearchByNameSearchSpaceObjectId String(36) Read-Only The unique identifier of the SearchSpace which is used to limit the visibility to dilatable/addressable objects when searching by name (character string).
PartitionObjectId String(36) Read/Write The unique identifier of the Partition to which a subscriber's DtmfAccessId created with this template will be assigned.
UseDynamicNameSearchWeight Boolean Read-Only Use dynamic name search weight. When this user addresses objects, the name search weight for those objects will automatically be incremented.
LdapCcmPkid String(36) Read/Write The pkid of associated end user in the sleeping SeaDragon database.
LdapType Integer Read-Only The LDAP configuration information for the user.
FaxServerObjectId String(36) Read-Only The unique identifier of the FaxServer object for the subscriber.
LdapCcmUserId String(36) Read-Only The userid of associated end user in the sleeping SeaDragon database.
XferString String(36) Read-Only Alternate transfer option.
EnableMessageBookmark Boolean Read/Write A flag indicating whether Message Bookmark is enabled for the subscriber.

Values can be:

  • False: Message Bookmark feature is disabled for subscriber.
  • True: Message Bookmark feature is enabled for subscriber.

Default value: False

SayTotalDraftMsg Boolean Read/Write A flag indicating whether Cisco Unity Connection announces the total number of draft messages in the subscriber mailbox.

Values can be:

  • False: Do not announce total number of draft messages.
  • True: Announce the total number of draft messages in the subscriber mailbox.

Default value: False

EnableSaveDraft Boolean Read/Write A flag indicating whether the save draft message feature is enabled for the subscriber.

Values can be:

  • False: Do not save draft messages.
  • True: Save draft messages.

Default value: False

RetainUrgentMessageFlag Boolean Read/Write Urgent message flag on a message is retained for both reply and forward message actions.

Default value: False

SayMessageLength Boolean Read/Write A flag indicating whether Cisco Unity Connection announces the length of each message during message playback.

Default value: False

CreateSmtpProxyFromCorp Boolean Read/Write SMTP proxy address matching the corporate e-mail address created for user.
AutoAdvanceMsgs Boolean Read-Only A flag indicating that the conversation will, during playback, advance to the next message in the playback stack automatically after it is done playing the after message menu.

Values can be:

  • False: Do not automatically skip to the next message after playing the after message menu once.
  • True: Do advanced automatically to the next message after playing the after message menu once.

Default value: False

SaySenderAfter Boolean Read-Only This flag works exactly the same as the SaySender flag on a user, except the conversation plays the sender in the message footer.

Default value: False

SaySenderExtensionAfter Boolean Read-Only This flag works exactly the same as the SaySenderExtension flag on a user, except the conversation plays the sender's extension in the message footer.

Default value: False

SayMsgNumberAfter Boolean Read-Only This flag works exactly the same as the SayMsgNumber flag on a user, except the conversation plays the message number in the message footer.

Default value: False

SayAniAfter Boolean Read-Only This flag works exactly the same as the SayAni flag on a user, except the conversation plays the ani in the message footer.

Default value: False

SayMessageLengthAfter Boolean Read-Only This flag works exactly the same as the SayMessageLength flag on a user, except the conversation plays the message length in the message footer.

Default value: False

Rating: 0.0/5 (0 votes cast)

Personal tools