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

From DocWiki

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 API

Administrator can use this API to create/update/delete/fetch the user with mailbox. Various attributes of user, for example notification device, greetings, contact, private list, phone menu, call transfer, screening, or personal data, can also be updated using this API .


Listing the Users

The request can be used to fetch the list of all users.

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

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

<Users total="2">
 <User>
  <URI>/vmrest/users/4d5df6e3-a036-4f16-8f1e-d48e7e9b73c1</URI>
  <ObjectId>4d5df6e3-a036-4f16-8f1e-d48e7e9b73c1</ObjectId>
  <TenantObjectId>fe6541fb-b42c-44f2-8404-ded14cbf7438</TenantObjectId>
  <Alias>undeliverablemessagesmailbox</Alias>
  <DisplayName>Undeliverable Messages</DisplayName>
  <TimeZone>0</TimeZone>
  <CreationTime>2013-03-05T10:54:38Z</CreationTime>
  <CosObjectId>610c9c71-32be-4465-b61a-523f24a9d828</CosObjectId>
  <CosURI>/vmrest/coses/610c9c71-32be-4465-b61a-523f24a9d828</CosURI>
  <Language>0</Language>
  <LocationObjectId>42a9ab40-490d-4819-9bfb-8ddce4f430ff</LocationObjectId>
  <LocationURI>/vmrest/locations/connectionlocations/42a9ab40-490d-4819-9bfb-8ddce4f430ff</LocationURI>
  <ListInDirectory>false</ListInDirectory>
  <IsVmEnrolled>true</IsVmEnrolled>
  <MediaSwitchObjectId>ec1e2636-fc14-44fc-8cda-d6c1a3d61150</MediaSwitchObjectId>
  <PhoneSystemURI>/vmrest/phonesystems/ec1e2636-fc14-44fc-8cda-d6c1a3d61150</PhoneSystemURI>
  <CallHandlerObjectId>13a3c5fc-f706-4bd0-aeeb-32dad2c4a29b</CallHandlerObjectId>
  <CallhandlerURI>/vmrest/handlers/callhandlers/13a3c5fc-f706-4bd0-aeeb-32dad2c4a29b</CallhandlerURI>
  <DtmfAccessId>99999</DtmfAccessId>
  <VoiceNameRequired>false</VoiceNameRequired>
  <PartitionObjectId>da2114bf-cde7-43d8-9709-cd3895a9d41b</PartitionObjectId>
  <PartitionURI>/vmrest/partitions/da2114bf-cde7-43d8-9709-cd3895a9d41b</PartitionURI>
  <MwisURI>/vmrest/users/4d5df6e3-a036-4f16-8f1e-d48e7e9b73c1/mwis</MwisURI>
  <NotificationDevicesURI>/vmrest/users/4d5df6e3-a036-4f16-8f1e-d48e7e9b73c1/notificationdevices</NotificationDevicesURI>
  <MessageHandlersURI>/vmrest/users/4d5df6e3-a036-4f16-8f1e-d48e7e9b73c1/messagehandlers</MessageHandlersURI>
  <ExternalServiceAccountsURI>/vmrest/users/4d5df6e3-a036-4f16-8f1e-d48e7e9b73c1/externalserviceaccounts</ExternalServiceAccountsURI>
  <AlternateExtensionsURI>/vmrest/users/4d5df6e3-a036-4f16-8f1e-d48e7e9b73c1/alternateextensions</AlternateExtensionsURI>
  <PrivateListsURI>/vmrest/users/4d5df6e3-a036-4f16-8f1e-d48e7e9b73c1/privatelists</PrivateListsURI>
  <SmtpProxyAddressesURI>/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%204d5df6e3-a036-4f16-8f1e- d48e7e9b73c1)</SmtpProxyAddressesURI>
  <AlternateNamesURI>/vmrest/alternatenames?query=(GlobalUserObjectId%20is%204d5df6e3-a036-4f16-8f1e-d48e7e9b73c1)              
</AlternateNamesURI>
 </User>
 <User>
  <URI>/vmrest/users/671fd8d1-7240-4e60-9194-0ec9c4a626ce</URI>
  <ObjectId>671fd8d1-7240-4e60-9194-0ec9c4a626ce</ObjectId>
  <Alias>operator</Alias>
  <DisplayName>Operator</DisplayName>
  <TimeZone>0</TimeZone>
  <CreationTime>2013-03-05 10:54:39.02</CreationTime>
  <CosObjectId>610c9c71-32be-4465-b61a-523f24a9d828</CosObjectId>
  <CosURI>/vmrest/coses/610c9c71-32be-4465-b61a-523f24a9d828</CosURI>
  <Language>0</Language>
  <LocationObjectId>42a9ab40-490d-4819-9bfb-8ddce4f430ff</LocationObjectId>
  <LocationURI>/vmrest/locations/connectionlocations/42a9ab40-490d-4819-9bfb-8ddce4f430ff</LocationURI>
  <ListInDirectory>false</ListInDirectory>
  <IsVmEnrolled>true</IsVmEnrolled>
  <MediaSwitchObjectId>ec1e2636-fc14-44fc-8cda-d6c1a3d61150</MediaSwitchObjectId>
  <PhoneSystemURI>/vmrest/phonesystems/ec1e2636-fc14-44fc-8cda-d6c1a3d61150</PhoneSystemURI>
  <CallHandlerObjectId>4546d6df-5120-4fb3-9719-8d521b8a5796</CallHandlerObjectId>
  <CallhandlerURI>/vmrest/handlers/callhandlers/4546d6df-5120-4fb3-9719-8d521b8a5796</CallhandlerURI>
  <DtmfAccessId>99990</DtmfAccessId>
  <VoiceNameRequired>false</VoiceNameRequired>
  <PartitionObjectId>da2114bf-cde7-43d8-9709-cd3895a9d41b</PartitionObjectId>
  <PartitionURI>/vmrest/partitions/da2114bf-cde7-43d8-9709-cd3895a9d41b</PartitionURI>
  <MwisURI>/vmrest/users/671fd8d1-7240-4e60-9194-0ec9c4a626ce/mwis</MwisURI>
  <NotificationDevicesURI>/vmrest/users/671fd8d1-7240-4e60-9194-0ec9c4a626ce/notificationdevices</NotificationDevicesURI>
  <MessageHandlersURI>/vmrest/users/671fd8d1-7240-4e60-9194-0ec9c4a626ce/messagehandlers</MessageHandlersURI>
  <ExternalServiceAccountsURI>/vmrest/users/671fd8d1-7240-4e60-9194-0ec9c4a626ce/externalserviceaccounts</ExternalServiceAccountsURI>
  <AlternateExtensionsURI>/vmrest/users/671fd8d1-7240-4e60-9194-0ec9c4a626ce/alternateextensions</AlternateExtensionsURI>
  <PrivateListsURI>/vmrest/users/671fd8d1-7240-4e60-9194-0ec9c4a626ce/privatelists</PrivateListsURI>
  <SmtpProxyAddressesURI>/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%20671fd8d1-7240-4e60-9194-0ec9c4a626ce)</SmtpProxyAddressesURI>
  <AlternateNamesURI>/vmrest/alternatenames?query=(GlobalUserObjectId%20is%20671fd8d1-7240-4e60-9194-0ec9c4a626ce) </AlternateNamesURI>
</User>
</Users>
 
Response Code: 200

JSON Example

To view the list of users, do the following:

GET https://<connection-server>/vmrest/users
Accept: 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"
 "User":
[
 {
  "URI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1"
  "ObjectId":"6c91a90f-0771-492b-a7a5-083ea246a7e1"
  "TenantObjectId" :"fe6541fb-b42c-44f2-8404-ded14cbf7438"
  "UseDefaultLanguage":"true"
  "Alias":"Texoma"
  "DisplayName":"Texoma"
  "TimeZone":"190"
  "CreationTime":"2013-03-14T10:54:47Z"
  "IsTemplate":"false"
  "CosObjectId":"844e18ef-884c-4f43-b9ce-1dc0d53196c2"
  "CosURI":"/vmrest/coses/844e18ef-884c-4f43-b9ce-1dc0d53196c2"
  "Language":"1033"
  "LocationObjectId":"42a9ab40-490d-4819-9bfb-8ddce4f430ff"
  "LocationURI":"/vmrest/locations/connectionlocations/42a9ab40-490d-4819-9bfb-8ddce4f430ff"
  "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":"true"
  "SayTotalNewEmail":"true"
  "SayTotalNewFax":"false"
  "SayTotalNewVoice":"true"
  "SayTotalReceipts":"false"
  "SayTotalSaved":"true"
  "Speed":"100"
  "MediaSwitchObjectId":"ec1e2636-fc14-44fc-8cda-d6c1a3d61150"
  "PhoneSystemURI":"/vmrest/phonesystems/ec1e2636-fc14-44fc-8cda-d6c1a3d61150"
  "Undeletable":"false"
  "UseBriefPrompts":"false"
  "Volume":"50"
  "EnAltGreetDontRingPhone":"false"
  "EnAltGreetPreventSkip":"false"
  "EnAltGreetPreventMsg":"false"
  "EncryptPrivateMessages":"false"
  "DeletedMessageSortOrder":"2"
  "SayAltGreetWarning":"false"
  "SaySenderExtension":"false"
  "SayAni":"false"
  "CallAnswerTimeout":"4"
  "CallHandlerObjectId":"fc2f99c4-31ac-465b-b143-5d21c760439c"
  "CallhandlerURI":"/vmrest/handlers/callhandlers/fc2f99c4-31ac-465b-b143-5d21c760439c"
  "MessageTypeMenu":"false"
  "NewMessageSortOrder":"1"
  "SavedMessageSortOrder":"2"
  "MessageLocatorSortOrder":"1"
  "NewMessageStackOrder":"1234567"
  "SavedMessageStackOrder":"1234567"
  "EnablePersonalRules":"true"
  "RecordUnknownCallerName":"true"
  "RingPrimaryPhoneFirst":"false"
  "ExitAction":"2"
  "ExitTargetConversation":"PHGreeting"
  "PromptSpeed":"100"
  "ExitTargetHandlerObjectId":"939d4d12-cec8-4fee-ae47-fbf0cf20c33e"
  "RepeatMenu":"1"
  "FirstDigitTimeout":"5000"
  "InterdigitDelay":"3000"
  "PromptVolume":"50"
  "ExitCallActionObjectId":"a5ab392f-dce6-4de2-af7f-92f9ebd14300"
  "AddressAfterRecord":"false"
  "DtmfAccessId":"12345"
  "ConfirmDeleteMessage":"false"
  "ConfirmDeleteDeletedMessage":"false"
  "ConfirmDeleteMultipleMessages":"true"
  "IsClockMode24Hour":"false"
  "SynchScheduleObjectId":"214cc45c-db48-44c6-a239-aa4c5e65e32a"
  "SchScheduleURI":"/vmrest/schedules/214cc45c-db48-44c6-a239-aa4c5e65e32a"
  "RouteNDRToSender":"true"
  "IsSetForVmEnrollment":"true"
  "VoiceNameRequired":"false"
  "SendBroadcastMsg":"false"
  "UpdateBroadcastMsg":"false"
  "ConversationVui":"VuiStart"
  "ConversationName":"SubMenu"
  "SpeechCompleteTimeout":"0"
  "SpeechIncompleteTimeout":"750"
  "UseVui":"false"
  "SkipPasswordForKnownDevice":"false"
  "JumpToMessagesOnLogin":"false"
  "UseDefaultTimeZone":"true"
  "EnableMessageLocator":"false"
  "AssistantRowsPerPage":"5"
  "InboxMessagesPerPage":"20"
  "InboxAutoRefresh":"15"
  "InboxAutoResolveMessageRecipients":"true"
  "PcaAddressBookRowsPerPage":"5"
  "ReadOnly":"false"
  "EnableTts":"true"
  "SmtpAddress":"vishu11@ucbu-aricent-vm463.cisco.com"
  "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":"877942bf-6600-4b7a-809d-159199cfc2ec"
  "SearchByExtensionSearchSpaceURI":"/vmrest/searchspaces/877942bf-6600-4b7a-809d-159199cfc2ec"
  "SearchByNameSearchSpaceObjectId":"877942bf-6600-4b7a-809d-159199cfc2ec"
  "SearchByNameSearchSpaceURI":"/vmrest/searchspaces/877942bf-6600-4b7a-809d-159199cfc2ec"
  "PartitionObjectId":"da2114bf-cde7-43d8-9709-cd3895a9d41b"
  "PartitionURI":"/vmrest/partitions/da2114bf-cde7-43d8-9709-cd3895a9d41b"
  "UseDynamicNameSearchWeight":"false"
  "LdapType":"0"
  "MwisURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/mwis"
  "NotificationDevicesURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/notificationdevices"
  "MessageHandlersURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/messagehandlers"
  "ExternalServiceAccountsURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/externalserviceaccounts"
  "AlternateExtensionsURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/alternateextensions"
  "PrivateListsURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/privatelists"
  "SmtpProxyAddressesURI":"/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%206c91a90f-0771-492b-a7a5-083ea246a7e1)"
  "AlternateNamesURI":"/vmrest/alternatenames?query=(GlobalUserObjectId%20is%206c91a90f-0771-492b-a7a5-083ea246a7e1)"
  }
]
}
Response Code: 200

Listing Specific Tenant Related Users by System Administrator

In Cisco Unity Connection 10.5(2) and later, the system administrator can use TenantObjectID to list the specific tenant related user using the following URI:

 GET https://<connection-server>/vmrest/users?query=(TenantObjectId is <Tenant-ObjectId>)

To get the TenantObjectID, use the following URI:

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

Viewing the Details of a Specific User

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

GET https://<connection-server>/vmrest/users/<user-objectId>

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

<User>
  <URI>/vmrest/users/9375d893-c8eb-437b-90bf-7de4b1d0c3e8</URI>
  <ObjectId>9375d893-c8eb-437b-90bf-7de4b1d0c3e8</ObjectId>
  <UseDefaultLanguage>true</UseDefaultLanguage>
  <FirstName>jsdghj</FirstName>
  <Initials>efjoe</Initials>
  <LastName>djghfjk</LastName>
  <Alias>Texoma</Alias>
  <City/>
  <State/>
  <Country>US</Country>
  <PostalCode/>
  <Department/>
  <Manager/>
  <Title>eoufowe</Title>
  <Building/>
  <EmployeeId>2343</EmployeeId>
  <Address/>
  <DisplayName>user_Opera_1</DisplayName>
  <BillingId/>
  <TimeZone>190</TimeZone>
  <CreationTime>2013-03-05T11:24:33Z</CreationTime>
  <IsTemplate>false</IsTemplate>
  <DtmfNameFirstLast>5734453544355</DtmfNameFirstLast>
  <DtmfNameLastFirst>3544355573445</DtmfNameLastFirst>
  <CosObjectId>8ab2b94d-1531-4589-865f-27bd3eea8adc</CosObjectId>
  <CosURI>/vmrest/coses/8ab2b94d-1531-4589-865f-27bd3eea8adc</CosURI>
  <Language>1033</Language>
  <LocationObjectId>42a9ab40-490d-4819-9bfb-8ddce4f430ff</LocationObjectId>
  <LocationURI>/vmrest/locations/connectionlocations/42a9ab40-490d-4819-9bfb-8ddce4f430ff</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>ec1e2636-fc14-44fc-8cda-d6c1a3d61150</MediaSwitchObjectId>
  <PhoneSystemURI>/vmrest/phonesystems/ec1e2636-fc14-44fc-8cda-d6c1a3d61150</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>
  <XferString/>
  <CallAnswerTimeout>4</CallAnswerTimeout>
  <CallHandlerObjectId>287cdcc0-9f77-48e0-a7b1-0f9b1a5ac842</CallHandlerObjectId>
  <CallhandlerURI>/vmrest/handlers/callhandlers/287cdcc0-9f77-48e0-a7b1-0f9b1a5ac842</CallhandlerURI>
  <MessageTypeMenu>false</MessageTypeMenu>
  <NewMessageSortOrder>1</NewMessageSortOrder>
  <SavedMessageSortOrder>2</SavedMessageSortOrder>
  <MessageLocatorSortOrder>1</MessageLocatorSortOrder>
  <NewMessageStackOrder>1234567</NewMessageStackOrder>
  <SavedMessageStackOrder>1234567</SavedMessageStackOrder>
  <EnablePersonalRules>true</EnablePersonalRules>
  <RecordUnknownCallerName>true</RecordUnknownCallerName>
  <RingPrimaryPhoneFirst>false</RingPrimaryPhoneFirst>
  <ExitAction>2</ExitAction>
  <ExitTargetConversation>PHGreeting</ExitTargetConversation>
  <PromptSpeed>100</PromptSpeed>
  <ExitTargetHandlerObjectId>55af319d-7a26-40ad-9b20-153ee1f39e99</ExitTargetHandlerObjectId>
  <RepeatMenu>1</RepeatMenu>
  <FirstDigitTimeout>5000</FirstDigitTimeout>
  <InterdigitDelay>3000</InterdigitDelay>
  <PromptVolume>50</PromptVolume>
  <ExitCallActionObjectId>2b3566bd-0339-43a4-85a1-09ab3177f0e9</ExitCallActionObjectId>
  <AddressAfterRecord>false</AddressAfterRecord>
  <DtmfAccessId>99934</DtmfAccessId>
  <ConfirmDeleteMessage>false</ConfirmDeleteMessage>
  <ConfirmDeleteDeletedMessage>false</ConfirmDeleteDeletedMessage>
  <ConfirmDeleteMultipleMessages>true</ConfirmDeleteMultipleMessages>
  <IsClockMode24Hour>false</IsClockMode24Hour>
  <SynchScheduleObjectId>58dce2eb-9d6d-4621-b81d-a56c80b83897</SynchScheduleObjectId>
  <SynchScheduleURI>/vmrest/schedules/58dce2eb-9d6d-4621-b81d-a56c80b83897</SynchScheduleURI>
  <RouteNDRToSender>true</RouteNDRToSender>
  <IsSetForVmEnrollment>true</IsSetForVmEnrollment>
  <VoiceNameRequired>false</VoiceNameRequired>
  <SendBroadcastMsg>false</SendBroadcastMsg>
  <UpdateBroadcastMsg>false</UpdateBroadcastMsg>
  <ConversationVui>VuiStart</ConversationVui>
  <ConversationName>SubMenu</ConversationName>
  <SpeechCompleteTimeout>0</SpeechCompleteTimeout> 
  <SpeechIncompleteTimeout>750</SpeechIncompleteTimeout>
  <UseVui>false</UseVui>
  <SkipPasswordForKnownDevice>true</SkipPasswordForKnownDevice>
  <JumpToMessagesOnLogin>true</JumpToMessagesOnLogin>
  <UseDefaultTimeZone>true</UseDefaultTimeZone>
  <EnableMessageLocator>false</EnableMessageLocator>
  <DtmfNameFirst>573445</DtmfNameFirst>
  <DtmfNameLast>3544355</DtmfNameLast>
  <AssistantRowsPerPage>5</AssistantRowsPerPage>
  <InboxMessagesPerPage>20</InboxMessagesPerPage>
  <InboxAutoRefresh>15</InboxAutoRefresh>
  <InboxAutoResolveMessageRecipients>true</InboxAutoResolveMessageRecipients>
  <PcaAddressBookRowsPerPage>5</PcaAddressBookRowsPerPage>
  <ReadOnly>false</ReadOnly>
  <EnableTts>true</EnableTts>
  <SmtpAddress>user_operator_1@ucbu-aricent-vm463.cisco.com</SmtpAddress>
  <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>true</UseShortPollForCache>
  <SearchByExtensionSearchSpaceObjectId>5d004dee-14ef-4fc4-83b8-850274628286</SearchByExtensionSearchSpaceObjectId>
  <SearchByExtensionSearchSpaceURI>/vmrest/searchspaces/5d004dee-14ef-4fc4-83b8-850274628286</SearchByExtensionSearchSpaceURI>
  <SearchByNameSearchSpaceObjectId>5d004dee-14ef-4fc4-83b8-850274628286</SearchByNameSearchSpaceObjectId>
  <SearchByNameSearchSpaceURI>/vmrest/searchspaces/5d004dee-14ef-4fc4-83b8-850274628286</SearchByNameSearchSpaceURI>
  <PartitionObjectId>da2114bf-cde7-43d8-9709-cd3895a9d41b</PartitionObjectId>
  <PartitionURI>/vmrest/partitions/da2114bf-cde7-43d8-9709-cd3895a9d41b</PartitionURI>
  <UseDynamicNameSearchWeight>false</UseDynamicNameSearchWeight>
  <LdapType>1</LdapType>
  <FaxServerObjectId>1564dbbc-002f-47b9-a0f3-38f2cd6e2d87</FaxServerObjectId>
  <FaxServerURI>/vmrest/faxservers/1564dbbc-002f-47b9-a0f3-38f2cd6e2d87</FaxServerURI>
  <MwisURI>/vmrest/users/9375d893-c8eb-437b-90bf-7de4b1d0c3e8/mwis</MwisURI>
  <NotificationDevicesURI>/vmrest/users/9375d893-c8eb-437b-90bf-7de4b1d0c3e8/notificationdevices</NotificationDevicesURI>
  <MessageHandlersURI>/vmrest/users/9375d893-c8eb-437b-90bf-7de4b1d0c3e8/messagehandlers</MessageHandlersURI>
  <ExternalServiceAccountsURI>/vmrest/users/9375d893-c8eb-437b-90bf-    7de4b1d0c3e8/externalserviceaccounts</ExternalServiceAccountsURI>
  <AlternateExtensionsURI>/vmrest/users/9375d893-c8eb-437b-90bf-7de4b1d0c3e8/alternateextensions</AlternateExtensionsURI>
  <PrivateListsURI>/vmrest/users/9375d893-c8eb-437b-90bf-7de4b1d0c3e8/privatelists</PrivateListsURI>
  <UserWebPasswordURI>/vmrest/users/7e048531-acdf-460b-884e-415be712d0bc/credential/password</UserWebPasswordURI>
  <UserVoicePinURI>/vmrest/users/7e048531-acdf-460b-884e-415be712d0bc/credential/pin</UserVoicePinURI>
  <UserRoleURI>/vmrest/users/7e048531-acdf-460b-884e-415be712d0bc/userroles</UserRoleURI>
  <SmtpProxyAddressesURI>/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%209375d893-c8eb-437b-90bf-7de4b1d0c3e8)</SmtpProxyAddressesURI>
  <AlternateNamesURI>/vmrest/alternatenames?query=(GlobalUserObjectId%20is%209375d893-c8eb-437b-90bf-7de4b1d0c3e8)  </AlternateNamesURI>
</User>
Response Code: 200

JSON Example

To view the details of particular user, do the following:

GET https://<connection-server>/vmrest/users/<user-objectId>
Accept: 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/users/6c91a90f-0771-492b-a7a5-083ea246a7e1"
  "ObjectId":"6c91a90f-0771-492b-a7a5-083ea246a7e1"
  "UseDefaultLanguage":"true"
  "Alias":"Texoma"
  "DisplayName":"Texoma"
  "TimeZone":"190"
  "CreationTime":"2013-03-14T10:54:47Z"
  "IsTemplate":"false"
  "CosObjectId":"844e18ef-884c-4f43-b9ce-1dc0d53196c2"
  "CosURI":"/vmrest/coses/844e18ef-884c-4f43-b9ce-1dc0d53196c2"
  "Language":"1033"
  "LocationObjectId":"42a9ab40-490d-4819-9bfb-8ddce4f430ff"
  "LocationURI":"/vmrest/locations/connectionlocations/42a9ab40-490d-4819-9bfb-8ddce4f430ff"
  "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":"true"
  "SayTotalNewEmail":"true"
  "SayTotalNewFax":"false"
  "SayTotalNewVoice":"true"
  "SayTotalReceipts":"false"
  "SayTotalSaved":"true"
  "Speed":"100"
  "MediaSwitchObjectId":"ec1e2636-fc14-44fc-8cda-d6c1a3d61150"
  "PhoneSystemURI":"/vmrest/phonesystems/ec1e2636-fc14-44fc-8cda-d6c1a3d61150"
  "Undeletable":"false"
  "UseBriefPrompts":"false"
  "Volume":"50"
  "EnAltGreetDontRingPhone":"false"
  "EnAltGreetPreventSkip":"false"
  "EnAltGreetPreventMsg":"false"
  "EncryptPrivateMessages":"false"
  "DeletedMessageSortOrder":"2"
  "SayAltGreetWarning":"false"
  "SaySenderExtension":"false"
  "SayAni":"false"
  "CallAnswerTimeout":"4"
  "CallHandlerObjectId":"fc2f99c4-31ac-465b-b143-5d21c760439c"
  "CallhandlerURI":"/vmrest/handlers/callhandlers/fc2f99c4-31ac-465b-b143-5d21c760439c"
  "MessageTypeMenu":"false"
  "NewMessageSortOrder":"1"
  "SavedMessageSortOrder":"2"
  "MessageLocatorSortOrder":"1"
  "NewMessageStackOrder":"1234567"
  "SavedMessageStackOrder":"1234567"
  "EnablePersonalRules":"true"
  "RecordUnknownCallerName":"true"
  "RingPrimaryPhoneFirst":"false"
  "ExitAction":"2"
  "ExitTargetConversation":"PHGreeting"
  "PromptSpeed":"100"
  "ExitTargetHandlerObjectId":"939d4d12-cec8-4fee-ae47-fbf0cf20c33e"
  "RepeatMenu":"1"
  "FirstDigitTimeout":"5000"
  "InterdigitDelay":"3000"
  "PromptVolume":"50"
  "ExitCallActionObjectId":"a5ab392f-dce6-4de2-af7f-92f9ebd14300"
  "AddressAfterRecord":"false"
  "DtmfAccessId":"12345"
  "ConfirmDeleteMessage":"false"
  "ConfirmDeleteDeletedMessage":"false"
  "ConfirmDeleteMultipleMessages":"true"
  "IsClockMode24Hour":"false"
  "SynchScheduleObjectId":"214cc45c-db48-44c6-a239-aa4c5e65e32a"
  "SynchScheduleURI":"/vmrest/schedules/214cc45c-db48-44c6-a239-aa4c5e65e32a"
  "RouteNDRToSender":"true"
  "IsSetForVmEnrollment":"true"
  "VoiceNameRequired":"false"
  "SendBroadcastMsg":"false"
  "UpdateBroadcastMsg":"false"
  "ConversationVui":"VuiStart"
  "ConversationName":"SubMenu"
  "SpeechCompleteTimeout":"0"
  "SpeechIncompleteTimeout":"750"
  "UseVui":"false"
  "SkipPasswordForKnownDevice":"false"
  "JumpToMessagesOnLogin":"false"
  "UseDefaultTimeZone":"true"
  "EnableMessageLocator":"false"
  "AssistantRowsPerPage":"5"
  "InboxMessagesPerPage":"20"
  "InboxAutoRefresh":"15"
  "InboxAutoResolveMessageRecipients":"true"
  "PcaAddressBookRowsPerPage":"5"
  "ReadOnly":"false"
  "EnableTts":"true"
  "SmtpAddress":"vishu11@ucbu-aricent-vm463.cisco.com"
  "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":"877942bf-6600-4b7a-809d-159199cfc2ec"
  "SearchByExtensionSearchSpaceURI":"/vmrest/searchspaces/877942bf-6600-4b7a-809d-159199cfc2ec"
  "SearchByNameSearchSpaceObjectId":"877942bf-6600-4b7a-809d-159199cfc2ec"
  "SearchByNameSearchSpaceURI":"/vmrest/searchspaces/877942bf-6600-4b7a-809d-159199cfc2ec"
  "PartitionObjectId":"da2114bf-cde7-43d8-9709-cd3895a9d41b"
  "PartitionURI":"/vmrest/partitions/da2114bf-cde7-43d8-9709-cd3895a9d41b"
  "UseDynamicNameSearchWeight":"false"
  "LdapType":"0"
  "MwisURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/mwis"
  "NotificationDevicesURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/notificationdevices"
  "MessageHandlersURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/messagehandlers"
  "ExternalServiceAccountsURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/externalserviceaccounts"
  "AlternateExtensionsURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/alternateextensions"
  "PrivateListsURI":"/vmrest/users/6c91a90f-0771-492b-a7a5-083ea246a7e1/privatelists"
  "SmtpProxyAddressesURI":"/vmrest/smtpproxyaddresses?query=(ObjectGlobalUserObjectId%20is%206c91a90f-0771-492b-a7a5-083ea246a7e1)"
  "AlternateNamesURI":"/vmrest/alternatenames?query=(GlobalUserObjectId%20is%206c91a90f-0771-492b-a7a5-083ea246a7e1)"
}
Response Code: 200

Creating a User

This request can be used to create a new user. The mandatory fields for creation of a user are alias and DtmfAccessId. The URI for getting user template alias is:

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

The URI for getting MailboxStoreObjectId is:

https://<connection-server>/vmrest/mailboxstores.

The ObjectId field in the response body of above URI is used as MailboxStoreObjectId. Users can be created in two ways:

1. This creates the user using default mailbox store:

 
POST https://<connection-server>/vmrest/users?templateAlias=<usertemplatealias>

2. This creates the user using specified mailbox store object ID:

POST https://<connection-server>/vmrest/users?templateAlias=<usertemplateAlias>&MailboxStoreObjectId=<mailboxStore-ObjectId>
<User>
  <Alias>texoma</Alias>
  <DtmfAccessId >123422</DtmfAccessId >
</User>

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
/vmrest/users/f82b301d-1ec8-44c6-a3ee-0012269439bf

JSON Example

To create user, do the following:

POST https://<Connection-server>/vmrest/users?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
/vmrest/users/f82b301d-1ec8-44c6-a3ee-0012269439bf

Updating a User

The following is an example of the PUT request that update details of a user:

PUT https://<connection-server>/vmrest/users/<user-objectid>
<User>
  <Alias>Texoma</Alias>
  <UseShortPollForCache> true</UseShortPollForCache>
  <ListInDirectory>true </ListInDirectory>
  <SkipPasswordForKnownDevice>true </SkipPasswordForKnownDevice>
  <IsVmEnrolled> true</IsVmEnrolled>
  <RouteNDRToSender >true</RouteNDRToSender >
  <MediaSwitchObjectId>ec1e2636-fc14-44fc-8cda-d6c1a3d61150 </MediaSwitchObjectId>
  <DtmfAccessId>99934</DtmfAccessId>
  <PartitionObjectId>da2114bf-cde7-43d8-9709-cd3895a9d41b</PartitionObjectId>
  <CosObjectId>8ab2b94d-1531-4589-865f-27bd3eea8adc</CosObjectId>
  <SearchByExtensionSearchSpaceObjectId>877942bf-6600-4b7a-809d-159199cfc2ec</SearchByExtensionSearchSpaceObjectId>
</User>

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 details of a user:

PUT https://<connection-server>/vmrest/users/<user-objectid>
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
  "DtmfAccessId":"123”
}

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 Language and TimeZone:

UseCallLanguage UseDefaultLanguage Language
Use System Default Language false true NULL/LanguageCode
Inherit Language from Caller true true/false NULL/LanguageCode
Particular Language false false Language Code
  • URI for timezone:
https://<Connection-server>/vmrest/timezones
  • URI for installed Languages:
https://<Connection-server>/vmrest/installedlanguages
  • URI to get Language code:
https://<Connection-server>/vmrest/languagemap
<User>
 <UseDefaultTimeZone>false</UseDefaultTimeZone>
 <TimeZone>175</TimeZone>
 <UseDefaultLanguage>false</UseDefaultLanguage>
 <Language>1034</Language>
</User>
Response Code: 204

JSON Example

To update Language and Timezone

PUT https://<Connection-server>/vmrest/users/<user-objectid> 
Accept: application/json
Content-type:  application/json
Connection: keep-alive
Request Body:
{
"UseDefaultTimeZone":"false",
 "TimeZone":175",
 	"UseDefaultLanguage":"false",
 "Language":"1034"
}
Response Code: 204

Delete a User

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

DELETE https://<connection-server>/vmrest/users/<user-objectid>
Response Code: 204

JSON Example

To delete a user, do the following:

DELETE https://<connection-server>/vmrest/users/<user-objectid>
Accept: application/json
Content-type: application/json
Connection: keep_alive
Response Code: 204

Explanation of Data Fields:

Field Name Operation Data Type Description
Alias Read/Write String(64) A unique text name of a user. Users enter the alias to sign in to the Cisco Personal Communications Assistant (Cisco PCA).

The administrators enter the alias to sign in to Cisco Unity Connection Administration.

DisplayName Read/Write String(64) Descriptive name of the user.
FirstName Read/Write String(64) The first name (i.e., given name) of the user.
LastName Read/Write String(64) The last name (i.e., surname or family name) of the user, by which a user is commonly known.
SmtpAddress Read/Write String(320) The full SMTP address for the user
TimeZone Read/Write Integer(4) The time zone to which this user account is associated. URI for timezone is: https://<Connection-server>/vmrest/timezones.
UseDefaultTimeZone Read/Write Boolean Indicates if the default timezone is being used. Possible values:
  • true: if default time zone is to be used
  • false: to use specific time zone, if false is selected timezone should be also specified.
Language Read/Write Integer The preferred language of this user. For a user with a voice mailbox, it is the language in which the subscriber hears instructions played to them. If the subscriber has TTS enabled by their class of service, it is the language used for TTS.
UseDefaultLanguage Read/Write Boolean Set to true, if the call handler is using default language from the location it belongs to. If false, you need to specify the language, so set the particular language.
LdapType Read/Write Integer The LDAP configuration information for the user. Possible Value:
  • 0-Do not Integrate with LDAP directory.
  • 1-Integrate with LDAP directory
  • 2-Authenticate
  • 4-Inactive

Default Value: 0

LocationObjectId Read Only String(36) The unique identifier of the LocationVMS object to which the user belongs to.
IsTemplate Read Only Boolean A flag indicating whether this instance of a user object is a "template" for creating new users.

Possible values:

  • true: if user template
  • false: if user

Default Value: false

Initials Read/Write String(64) The initial letters of some or all of the names of the user.
Title Read/Write String(64) The position or function of a user within an organization, such as 'Vice President'.
EmployeeId Read/Write String(64) The numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization.
Address Read/Write String(128) The physical address such as a house number and street name where the user is located, or with which a user is associated.
Building Read/Write String(64) The name of the building where the user is based.
City Read/Write String(64) The name of a locality, such as a city, county or other geographic region where the user is located, or with which a user is associated.
State Read/Write String(64) The full name of the state or province where this user is located, or with which a user is associated.
PostalCode Read/Write String(40) For users in the United States, the zip code where the user is located. For users in Canada, Mexico, and other countries, the postal code where the user is located.
Country Read/Write String(2) The two-letter ISO 3166-1 country code where the user is located, or with which a user is associated. URI to fetch available country code: https://<Connection-server>/vmrest/languagemap. From the response fetch last 2 letter of the Languagetag parameter.
Department Read/Write String(64) The name or number for the department or subdivision of an organization to which a person belongs to.
Manager Read/Write String(64) The name of the person who is the manager or supervisor of the user. Any character except non-printing ASCII characters can be used here.
BillingId Read/Write String(32) Accounting information or project code associated with the user. Any ASCII or Unicode character can be used here.
EmailAddress Read/Write String(320) The corporate email address of the user.
DtmfAccessId Read/Write String(40) The DTMF access id (i.e., extension) of the subscriber.
XferString Read/Write String(40) The cross-server transfer extension. If NULL, the user's primary extension is used.
FaxServerObjectId Read/Write String(36) The unique identifier of the FaxServer object for the subscriber.
PartitionObjectId Read/Write String(36) The unique identifier of the partition associated with the user
MediaSwitchObjectId Read/Write String(36) The unique identifier of the MediaSwitch object associated with the user
SearchByExtensionSearchSpaceObjectId Read/Write String(36) The unique identifier of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by extension (dial string).
SearchByNameSearchSpaceObjectId Read/Write String(36) The unique identifier of the SearchSpace which is used to limit the visibility to dialable/addressable objects when searching by name (character string).
CosObjectId Read/Write String(36) The unique identifier of the class of service object to which this user account is associated.
CallHandlerObjectId Read/Write String(36) The unique identifier of the primary CallHandler object for the subscriber.
ScheduleSetObjectId Read/Write String(36) The unique identifier of the schedule set Cisco Unity Connection will use for making standard versus off hours decisions within this call handler.

Note: To update the ScheduleSetObjectId ,first go to the user URI, then go to the callhandler URI, and then update the scheduleset.

TenantObjectId Read Only String (36) The unique identifier of the tenant to which the user belongs. This field is reflected in the response only if the user belongs to a particular tenant.
IsVmEnrolled Read/Write Boolean A flag indicating whether Cisco Unity Connection plays the enrollment conversation (record a voice name, indicate if they are listed in the directory, etc.) for the subscriber when they login.

Possible values:

  • 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

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

Possible values:

  • false: Do not Skip PIN When Calling From a Known Extension
  • true: Skip PIN When Calling From a Known Extension

Default value: false

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

Possible values:

  • false: Do not list in Directory
  • true: List in directory

Default value: false

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

Possible values:

  • false: The subscriber's polling cycle is determined by the system default polling cycle. (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

RouteNDRToSender Read/Write Boolean Flag indicating whether to Send Non-Delivery Receipts on Failed Message Delivery.

Possible values:

  • true: Send Non-Delivery Receipts on Failed Message Delivery.
  • false: Do not Send Non-Delivery Receipts on Failed Message Delivery.

Default value: true

Undeletable Read Only Boolean Flag indicating whether a user cannot be deleted or not.

Possible values:

  • true: For default users
  • false: For other created users
VoiceName Read/Write String(40) The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.
DialablePhoneNumber Read/Write String(255) The phone number of the fax machine that the user sends faxes to for printing.
PhoneNumber Read Only String(255) The corporate Phone number.
CreateSmtpProxyFromCorp Read/Write Boolean Flag indicating whether an SMTP proxy address matching the corporate e-mail address (column EmailAddress) should be created for the user.

Possible values:

  • false: Do not create matching SMTP proxy address.
  • true: Create matching SMTP proxy address.

Default value: false MailboxStoreName Read Only String Mailbox store name used by the user

Rating: 5.0/5 (1 vote cast)

Personal tools