Cisco Unity Connection Provisioning Interface (CUPI) API -- Call Handler APIs

From DocWiki

(Difference between revisions)
Jump to: navigation, search
(Created page with "'''Links to Other API pages:''' Cisco_Unity_Connection_APIs {| align="right" border="1" |align="center"|'''CUPI Guide Contents''' |- |[[Cisco Unity Connection Provisioning In...")
Line 19: Line 19:
*To transfer calls---A call handler can be used to route callers to a user. For example, after hours, you could transfer calls that come to a technical support call handler directly to the mobile phone of the person who is on call, or to another call handler.  
*To transfer calls---A call handler can be used to route callers to a user. For example, after hours, you could transfer calls that come to a technical support call handler directly to the mobile phone of the person who is on call, or to another call handler.  
Administrator can use this API to create/update/delete/fetch the call handler. You can update various attributes of call handler using this API.
Administrator can use this API to create/update/delete/fetch the call handler. You can update various attributes of call handler using this API.
 +
 +
 +
== Listing the Call Handlers ==
 +
 +
The following is an example of the GET request that fetch the list of call handlers:
 +
<pr>
 +
GET https://<connection-server>/vmrest/handlers/callhandlers
 +
</pr>
 +
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
 +
<pr>
 +
<Callhandlers total="2">
 +
<Callhandler>
 +
<URI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3</URI>
 +
<CreationTime>2013-01-02T15:42:48Z</CreationTime>
 +
<Language>1033</Language>
 +
<Undeletable>true</Undeletable>
 +
<VoiceName>9d168d20-303d-4019-b381-cd430e478540.wav</VoiceName>
 +
<VoiceFileURI>/vmrest/voicefiles/99cbec60-ef57-41a5-a0bd-5d1b79e6b7f7</VoiceFileURI>
 +
<VoiceNameURI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3/voicename</VoiceNameURI>
 +
<LocationObjectId>fa15de52-b98d-4de9-a868-ed02f957e38f</LocationObjectId>
 +
<LocationURI>/vmrest/locations/connectionlocations/fa15de52-b98d-4de9-a868-ed02f957e38f</LocationURI>
 +
<EditMsg>true</EditMsg>
 +
<IsPrimary>false</IsPrimary>
 +
<OneKeyDelay>1500</OneKeyDelay>
 +
<ScheduleSetObjectId>2eee2b88-8e45-4b77-8b4c-f52aaa1e39e4</ScheduleSetObjectId>
 +
<ScheduleSetURI>/vmrest/schedulesets/2eee2b88-8e45-4b77-8b4c-f52aaa1e39e4</ScheduleSetURI>
 +
<SendUrgentMsg>0</SendUrgentMsg>
 +
<MaxMsgLen>300</MaxMsgLen>
 +
<IsTemplate>false</IsTemplate>
 +
<ObjectId>fc922cfc-6583-471b-b8ab-9971e02418f3</ObjectId>
 +
<RecipientDistributionListObjectId>e93ca9db-8659-4e07-bee6-7af3f5c1a1db</RecipientDistributionListObjectId>
 +
<RecipientDistributionListURI>/vmrest/distributionlists/e93ca9db-8659-4e07-bee6-7af3f5c1a1db</RecipientDistributionListURI>
 +
<DisplayName>Opening Greeting</DisplayName>
 +
<AfterMessageAction>2</AfterMessageAction>
 +
<AfterMessageTargetConversation>PHGreeting</AfterMessageTargetConversation>
 +
<AfterMessageTargetHandlerObjectId>2f4b7240-f56a-4644-b22a-b1a346a5a9b2</AfterMessageTargetHandlerObjectId>
 +
<TimeZone>190</TimeZone>
 +
<UseDefaultLanguage>true</UseDefaultLanguage>
 +
<UseDefaultTimeZone>true</UseDefaultTimeZone>
 +
<MediaSwitchObjectId>2dcf1e57-80d6-43d3-b245-3693fe78397d</MediaSwitchObjectId>
 +
<PhoneSystemURI>/vmrest/phonesystems/2dcf1e57-80d6-43d3-b245-3693fe78397d</PhoneSystemURI>
 +
<UseCallLanguage>true</UseCallLanguage>
 +
<SendSecureMsg>false</SendSecureMsg>
 +
<EnablePrependDigits>false</EnablePrependDigits>
 +
<DispatchDelivery>false</DispatchDelivery>
 +
<CallSearchSpaceObjectId>1736fdd9-b6f9-4a92-ad25-17d5b8228700</CallSearchSpaceObjectId>
 +
<CallSearchSpaceURI>/vmrest/searchspaces/1736fdd9-b6f9-4a92-ad25-17d5b8228700</CallSearchSpaceURI>
 +
<InheritSearchSpaceFromCall>true</InheritSearchSpaceFromCall>
 +
<PartitionObjectId>0017febb-15bf-4454-9a5c-3b26e19aa14a</PartitionObjectId>
 +
<PartitionURI>/vmrest/partitions/0017febb-15bf-4454-9a5c-3b26e19aa14a</PartitionURI>
 +
<PlayPostGreetingRecording>0</PlayPostGreetingRecording>
 +
<SendPrivateMsg>0</SendPrivateMsg>
 +
<PlayAfterMessage>1</PlayAfterMessage>
 +
<GreetingsURI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3/greetings</GreetingsURI>
 +
<TransferOptionsURI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3/transferoptions</TransferOptionsURI>
 +
<MenuEntriesURI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3/menuentries</MenuEntriesURI>
 +
<CallHandlerOwnerURI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3/callhandlerowners</CallHandlerOwnerURI>
 +
</Callhandler>
 +
<Callhandler>
 +
<URI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2</URI>
 +
<CreationTime>2013-01-02T15:42:49Z</CreationTime>
 +
<Language>1033</Language>
 +
<Undeletable>true</Undeletable>
 +
<VoiceName>a797edef-e693-400f-bb7c-8fe889c3d758.wav</VoiceName>
 +
<VoiceFileURI>/vmrest/voicefiles/9a1a20ca-acb3-4ddc-9cde-0d10a2921427</VoiceFileURI>
 +
<VoiceNameURI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2/voicename</VoiceNameURI>
 +
<LocationObjectId>fa15de52-b98d-4de9-a868-ed02f957e38f</LocationObjectId>
 +
<LocationURI>/vmrest/locations/connectionlocations/fa15de52-b98d-4de9-a868-ed02f957e38f</LocationURI>
 +
<EditMsg>true</EditMsg>
 +
<IsPrimary>false</IsPrimary>
 +
<OneKeyDelay>1500</OneKeyDelay>
 +
<ScheduleSetObjectId>1cd28472-ced0-44ce-a8f7-cd7692ce7594</ScheduleSetObjectId>
 +
<ScheduleSetURI>/vmrest/schedulesets/1cd28472-ced0-44ce-a8f7-cd7692ce7594</ScheduleSetURI>
 +
<SendUrgentMsg>0</SendUrgentMsg>
 +
<MaxMsgLen>300</MaxMsgLen>
 +
<IsTemplate>false</IsTemplate>
 +
<ObjectId>2f4b7240-f56a-4644-b22a-b1a346a5a9b2</ObjectId>
 +
<RecipientDistributionListObjectId>e93ca9db-8659-4e07-bee6-7af3f5c1a1db</RecipientDistributionListObjectId>
 +
<RecipientDistributionListURI>/vmrest/distributionlists/e93ca9db-8659-4e07-bee6-7af3f5c1a1db</RecipientDistributionListURI>
 +
<DisplayName>Goodbye</DisplayName>
 +
<AfterMessageAction>1</AfterMessageAction>
 +
<TimeZone>190</TimeZone>
 +
<UseDefaultLanguage>true</UseDefaultLanguage>
 +
<UseDefaultTimeZone>true</UseDefaultTimeZone>
 +
<MediaSwitchObjectId>2dcf1e57-80d6-43d3-b245-3693fe78397d</MediaSwitchObjectId>
 +
<PhoneSystemURI>/vmrest/phonesystems/2dcf1e57-80d6-43d3-b245-3693fe78397d</PhoneSystemURI>
 +
<UseCallLanguage>true</UseCallLanguage>
 +
<SendSecureMsg>false</SendSecureMsg>
 +
<EnablePrependDigits>false</EnablePrependDigits>
 +
<DispatchDelivery>false</DispatchDelivery>
 +
<CallSearchSpaceObjectId>1736fdd9-b6f9-4a92-ad25-17d5b8228700</CallSearchSpaceObjectId>
 +
<CallSearchSpaceURI>/vmrest/searchspaces/1736fdd9-b6f9-4a92-ad25-17d5b8228700</CallSearchSpaceURI>
 +
<InheritSearchSpaceFromCall>true</InheritSearchSpaceFromCall>
 +
<PartitionObjectId>0017febb-15bf-4454-9a5c-3b26e19aa14a</PartitionObjectId>
 +
<PartitionURI>/vmrest/partitions/0017febb-15bf-4454-9a5c-3b26e19aa14a</PartitionURI>
 +
<PlayPostGreetingRecording>0</PlayPostGreetingRecording>
 +
<SendPrivateMsg>0</SendPrivateMsg>
 +
<PlayAfterMessage>1</PlayAfterMessage>
 +
<GreetingsURI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2/greetings</GreetingsURI>
 +
<TransferOptionsURI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2/transferoptions</TransferOptionsURI>
 +
<MenuEntriesURI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2/menuentries</MenuEntriesURI>
 +
<CallHandlerOwnerURI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2/callhandlerowners</CallHandlerOwnerURI>
 +
</Callhandler>
 +
</Callhandlers>
 +
Response Code: 200
 +
JSON Example
 +
To list of the call handlers, do the following:
 +
Request URI:
 +
GET https://<connection-server>/vmrest/handlers/callhandlers
 +
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": "2",
 +
"Callhandler": [
 +
{
 +
"URI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898",
 +
"CreationTime": "2013-02-14T05:05:43Z",
 +
"Language": "1033",
 +
"Undeletable": "true",
 +
"VoiceName": "43145be7-0101-4ba1-9448-76834baa153f.wav",
 +
"VoiceFileURI": "/vmrest/voicefiles/2374c796-b006-4b29-a35e-8b0b1d576e50",
 +
"VoiceNameURI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898/voicename",
 +
"LocationObjectId": "bbf3e6ed-0278-479c-9a6e-2da8756eeb6f",
 +
"LocationURI": "/vmrest/locations/connectionlocations/bbf3e6ed-0278-479c-9a6e-2da8756eeb6f",
 +
"EditMsg": "true",
 +
"IsPrimary": "false",
 +
"OneKeyDelay": "1500",
 +
"ScheduleSetObjectId": "96e43ab7-b6c1-49b1-ba27-008b8f8870e4",
 +
"ScheduleSetURI": "/vmrest/schedulesets/96e43ab7-b6c1-49b1-ba27-008b8f8870e4",
 +
"SendUrgentMsg": "0",
 +
"MaxMsgLen": "300",
 +
"IsTemplate": "false",
 +
"ObjectId": "6702cce8-853f-4cbd-8579-35c595213898",
 +
"RecipientDistributionListObjectId": "24865f76-fa95-412d-bc56-a48ef9e1531a",
 +
"RecipientDistributionListURI": "/vmrest/distributionlists/24865f76-fa95-412d-bc56-a48ef9e1531a",
 +
"DisplayName": "Opening Greeting",
 +
"AfterMessageAction": "2",
 +
"AfterMessageTargetConversation": "PHGreeting",
 +
"AfterMessageTargetHandlerObjectId": "8c400830-7e92-4908-9ca6-a4b123f1bd19",
 +
"TimeZone": "190",
 +
"UseDefaultLanguage": "true",
 +
"UseDefaultTimeZone": "true",
 +
"MediaSwitchObjectId": "a984674b-98d1-442e-83a9-2dcc0824af9e",
 +
"PhoneSystemURI": "/vmrest/phonesystems/a984674b-98d1-442e-83a9-2dcc0824af9e",
 +
"UseCallLanguage": "true",
 +
"SendSecureMsg": "false",
 +
"EnablePrependDigits": "false",
 +
"DispatchDelivery": "false",
 +
"CallSearchSpaceObjectId": "5a07d332-6fc5-4a3f-baba-3cb4ea630280",
 +
"CallSearchSpaceURI": "/vmrest/searchspaces/5a07d332-6fc5-4a3f-baba-3cb4ea630280",
 +
"InheritSearchSpaceFromCall": "true",
 +
"PartitionObjectId": "d50e9d0b-656e-416d-b5b7-43c4d2e2fd0b",
 +
"PartitionURI": "/vmrest/partitions/d50e9d0b-656e-416d-b5b7-43c4d2e2fd0b",
 +
"PlayPostGreetingRecording": "0",
 +
"SendPrivateMsg": "0",
 +
"PlayAfterMessage": "1",
 +
"GreetingsURI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898/greetings",
 +
"TransferOptionsURI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898/transferoptions",
 +
"MenuEntriesURI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898/menuentries",
 +
"CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898/callhandlerowners"
 +
},
 +
{
 +
"URI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5",
 +
"CreationTime": "2013-02-14T05:05:44Z",
 +
"Language": "1033",
 +
"Undeletable": "true",
 +
"VoiceName": "389d2d11-f74c-4df1-9766-098800b8fe74.wav",
 +
"VoiceFileURI": "/vmrest/voicefiles/c8cd8b94-8d2f-47d6-841e-ca1d3a02bdc2",
 +
"VoiceNameURI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5/voicename",
 +
"LocationObjectId": "bbf3e6ed-0278-479c-9a6e-2da8756eeb6f",
 +
"LocationURI": "/vmrest/locations/connectionlocations/bbf3e6ed-0278-479c-9a6e-2da8756eeb6f",
 +
"EditMsg": "true",
 +
"IsPrimary": "false",
 +
"OneKeyDelay": "1500",
 +
"ScheduleSetObjectId": "96e43ab7-b6c1-49b1-ba27-008b8f8870e4",
 +
"ScheduleSetURI": "/vmrest/schedulesets/96e43ab7-b6c1-49b1-ba27-008b8f8870e4",
 +
"SendUrgentMsg": "0",
 +
"MaxMsgLen": "300",
 +
"IsTemplate": "false",
 +
"ObjectId": "426e4f1c-0cf1-43dc-a52b-63db2c0704c5",
 +
"RecipientSubscriberObjectId": "053afdf6-78e8-4a54-9384-e6c32c68dacd",
 +
"RecipientUserURI": "/vmrest/users/053afdf6-78e8-4a54-9384-e6c32c68dacd",
 +
"DisplayName": "Operator",
 +
"AfterMessageAction": "2",
 +
"AfterMessageTargetConversation": "PHGreeting",
 +
"AfterMessageTargetHandlerObjectId": "8c400830-7e92-4908-9ca6-a4b123f1bd19",
 +
"DtmfAccessId": "0",
 +
"TimeZone": "190",
 +
"UseDefaultLanguage": "true",
 +
"UseDefaultTimeZone": "true",
 +
"MediaSwitchObjectId": "a984674b-98d1-442e-83a9-2dcc0824af9e",
 +
"PhoneSystemURI": "/vmrest/phonesystems/a984674b-98d1-442e-83a9-2dcc0824af9e",
 +
"UseCallLanguage": "true",
 +
"SendSecureMsg": "false",
 +
"EnablePrependDigits": "false",
 +
"DispatchDelivery": "false",
 +
"CallSearchSpaceObjectId": "5a07d332-6fc5-4a3f-baba-3cb4ea630280",
 +
"CallSearchSpaceURI": "/vmrest/searchspaces/5a07d332-6fc5-4a3f-baba-3cb4ea630280",
 +
"InheritSearchSpaceFromCall": "true",
 +
"PartitionObjectId": "d50e9d0b-656e-416d-b5b7-43c4d2e2fd0b",
 +
"PartitionURI": "/vmrest/partitions/d50e9d0b-656e-416d-b5b7-43c4d2e2fd0b",
 +
"PlayPostGreetingRecording": "0",
 +
"SendPrivateMsg": "0",
 +
"PlayAfterMessage": "1",
 +
"GreetingsURI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5/greetings",
 +
"TransferOptionsURI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5/transferoptions",
 +
"MenuEntriesURI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5/menuentries",
 +
"CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5/callhandlerowners"
 +
}
 +
]
 +
}
 +
Response Code: 200
 +
</pr>

Revision as of 11:38, 4 September 2013

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation


Contents


Call Handler APIs

Call handlers answer calls, greet callers with recorded prompts, provide callers with information and options, route calls, and take messages. They are a basic component of Cisco Unity Connection. Your plan for call handlers can be simple, using only the predefined call handlers, or you can create up to 40,000 new call handlers. You may want to use call handlers in the following ways:

  • As an automated attendant---A call handler can be used in place of a human operator to answer and direct calls by playing greetings and responding to key presses. The automated attendant can provide a menu of options. For example, "For Sales, press 1; for Service, press 2; for our business hours, press 3".
  • To offer prerecorded audio text---A call handler can be used to provide information that customers request frequently. For example, "Our normal business hours are Monday through Friday, 8 a.m. to 5 p.m.", or to play a pre-recorded message that all callers hear before they can interact with the system.
  • As a message recipient---A call handler can be used to take messages for the organization. For example, "All of our customer service representatives are busy. Please state your name, phone number, and account number, and we will return your call as soon as possible.".
  • To transfer calls---A call handler can be used to route callers to a user. For example, after hours, you could transfer calls that come to a technical support call handler directly to the mobile phone of the person who is on call, or to another call handler.

Administrator can use this API to create/update/delete/fetch the call handler. You can update various attributes of call handler using this API.


Listing the Call Handlers

The following is an example of the GET request that fetch the list of call handlers: <pr> GET https://<connection-server>/vmrest/handlers/callhandlers </pr> The following is the response from the above *GET* request and the actual response will depend upon the information given by you: <pr> <Callhandlers total="2"> <Callhandler> <URI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3</URI> <CreationTime>2013-01-02T15:42:48Z</CreationTime> <Language>1033</Language> <Undeletable>true</Undeletable> <VoiceName>9d168d20-303d-4019-b381-cd430e478540.wav</VoiceName> <VoiceFileURI>/vmrest/voicefiles/99cbec60-ef57-41a5-a0bd-5d1b79e6b7f7</VoiceFileURI> <VoiceNameURI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3/voicename</VoiceNameURI> <LocationObjectId>fa15de52-b98d-4de9-a868-ed02f957e38f</LocationObjectId> <LocationURI>/vmrest/locations/connectionlocations/fa15de52-b98d-4de9-a868-ed02f957e38f</LocationURI> <EditMsg>true</EditMsg> <IsPrimary>false</IsPrimary> <OneKeyDelay>1500</OneKeyDelay> <ScheduleSetObjectId>2eee2b88-8e45-4b77-8b4c-f52aaa1e39e4</ScheduleSetObjectId> <ScheduleSetURI>/vmrest/schedulesets/2eee2b88-8e45-4b77-8b4c-f52aaa1e39e4</ScheduleSetURI> <SendUrgentMsg>0</SendUrgentMsg> <MaxMsgLen>300</MaxMsgLen> <IsTemplate>false</IsTemplate> <ObjectId>fc922cfc-6583-471b-b8ab-9971e02418f3</ObjectId> <RecipientDistributionListObjectId>e93ca9db-8659-4e07-bee6-7af3f5c1a1db</RecipientDistributionListObjectId> <RecipientDistributionListURI>/vmrest/distributionlists/e93ca9db-8659-4e07-bee6-7af3f5c1a1db</RecipientDistributionListURI> <DisplayName>Opening Greeting</DisplayName> <AfterMessageAction>2</AfterMessageAction> <AfterMessageTargetConversation>PHGreeting</AfterMessageTargetConversation> <AfterMessageTargetHandlerObjectId>2f4b7240-f56a-4644-b22a-b1a346a5a9b2</AfterMessageTargetHandlerObjectId> <TimeZone>190</TimeZone> <UseDefaultLanguage>true</UseDefaultLanguage> <UseDefaultTimeZone>true</UseDefaultTimeZone> <MediaSwitchObjectId>2dcf1e57-80d6-43d3-b245-3693fe78397d</MediaSwitchObjectId> <PhoneSystemURI>/vmrest/phonesystems/2dcf1e57-80d6-43d3-b245-3693fe78397d</PhoneSystemURI> <UseCallLanguage>true</UseCallLanguage> <SendSecureMsg>false</SendSecureMsg> <EnablePrependDigits>false</EnablePrependDigits> <DispatchDelivery>false</DispatchDelivery> <CallSearchSpaceObjectId>1736fdd9-b6f9-4a92-ad25-17d5b8228700</CallSearchSpaceObjectId> <CallSearchSpaceURI>/vmrest/searchspaces/1736fdd9-b6f9-4a92-ad25-17d5b8228700</CallSearchSpaceURI> <InheritSearchSpaceFromCall>true</InheritSearchSpaceFromCall> <PartitionObjectId>0017febb-15bf-4454-9a5c-3b26e19aa14a</PartitionObjectId> <PartitionURI>/vmrest/partitions/0017febb-15bf-4454-9a5c-3b26e19aa14a</PartitionURI> <PlayPostGreetingRecording>0</PlayPostGreetingRecording> <SendPrivateMsg>0</SendPrivateMsg> <PlayAfterMessage>1</PlayAfterMessage> <GreetingsURI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3/greetings</GreetingsURI> <TransferOptionsURI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3/transferoptions</TransferOptionsURI> <MenuEntriesURI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3/menuentries</MenuEntriesURI> <CallHandlerOwnerURI>/vmrest/handlers/callhandlers/fc922cfc-6583-471b-b8ab-9971e02418f3/callhandlerowners</CallHandlerOwnerURI> </Callhandler> <Callhandler> <URI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2</URI> <CreationTime>2013-01-02T15:42:49Z</CreationTime> <Language>1033</Language> <Undeletable>true</Undeletable> <VoiceName>a797edef-e693-400f-bb7c-8fe889c3d758.wav</VoiceName> <VoiceFileURI>/vmrest/voicefiles/9a1a20ca-acb3-4ddc-9cde-0d10a2921427</VoiceFileURI> <VoiceNameURI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2/voicename</VoiceNameURI> <LocationObjectId>fa15de52-b98d-4de9-a868-ed02f957e38f</LocationObjectId> <LocationURI>/vmrest/locations/connectionlocations/fa15de52-b98d-4de9-a868-ed02f957e38f</LocationURI> <EditMsg>true</EditMsg> <IsPrimary>false</IsPrimary> <OneKeyDelay>1500</OneKeyDelay> <ScheduleSetObjectId>1cd28472-ced0-44ce-a8f7-cd7692ce7594</ScheduleSetObjectId> <ScheduleSetURI>/vmrest/schedulesets/1cd28472-ced0-44ce-a8f7-cd7692ce7594</ScheduleSetURI> <SendUrgentMsg>0</SendUrgentMsg> <MaxMsgLen>300</MaxMsgLen> <IsTemplate>false</IsTemplate> <ObjectId>2f4b7240-f56a-4644-b22a-b1a346a5a9b2</ObjectId> <RecipientDistributionListObjectId>e93ca9db-8659-4e07-bee6-7af3f5c1a1db</RecipientDistributionListObjectId> <RecipientDistributionListURI>/vmrest/distributionlists/e93ca9db-8659-4e07-bee6-7af3f5c1a1db</RecipientDistributionListURI> <DisplayName>Goodbye</DisplayName> <AfterMessageAction>1</AfterMessageAction> <TimeZone>190</TimeZone> <UseDefaultLanguage>true</UseDefaultLanguage> <UseDefaultTimeZone>true</UseDefaultTimeZone> <MediaSwitchObjectId>2dcf1e57-80d6-43d3-b245-3693fe78397d</MediaSwitchObjectId> <PhoneSystemURI>/vmrest/phonesystems/2dcf1e57-80d6-43d3-b245-3693fe78397d</PhoneSystemURI> <UseCallLanguage>true</UseCallLanguage> <SendSecureMsg>false</SendSecureMsg> <EnablePrependDigits>false</EnablePrependDigits> <DispatchDelivery>false</DispatchDelivery> <CallSearchSpaceObjectId>1736fdd9-b6f9-4a92-ad25-17d5b8228700</CallSearchSpaceObjectId> <CallSearchSpaceURI>/vmrest/searchspaces/1736fdd9-b6f9-4a92-ad25-17d5b8228700</CallSearchSpaceURI> <InheritSearchSpaceFromCall>true</InheritSearchSpaceFromCall> <PartitionObjectId>0017febb-15bf-4454-9a5c-3b26e19aa14a</PartitionObjectId> <PartitionURI>/vmrest/partitions/0017febb-15bf-4454-9a5c-3b26e19aa14a</PartitionURI> <PlayPostGreetingRecording>0</PlayPostGreetingRecording> <SendPrivateMsg>0</SendPrivateMsg> <PlayAfterMessage>1</PlayAfterMessage> <GreetingsURI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2/greetings</GreetingsURI> <TransferOptionsURI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2/transferoptions</TransferOptionsURI> <MenuEntriesURI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2/menuentries</MenuEntriesURI> <CallHandlerOwnerURI>/vmrest/handlers/callhandlers/2f4b7240-f56a-4644-b22a-b1a346a5a9b2/callhandlerowners</CallHandlerOwnerURI> </Callhandler> </Callhandlers> Response Code: 200 JSON Example To list of the call handlers, do the following: Request URI: GET https://<connection-server>/vmrest/handlers/callhandlers 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": "2", "Callhandler": [ { "URI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898", "CreationTime": "2013-02-14T05:05:43Z", "Language": "1033", "Undeletable": "true", "VoiceName": "43145be7-0101-4ba1-9448-76834baa153f.wav", "VoiceFileURI": "/vmrest/voicefiles/2374c796-b006-4b29-a35e-8b0b1d576e50", "VoiceNameURI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898/voicename", "LocationObjectId": "bbf3e6ed-0278-479c-9a6e-2da8756eeb6f", "LocationURI": "/vmrest/locations/connectionlocations/bbf3e6ed-0278-479c-9a6e-2da8756eeb6f", "EditMsg": "true", "IsPrimary": "false", "OneKeyDelay": "1500", "ScheduleSetObjectId": "96e43ab7-b6c1-49b1-ba27-008b8f8870e4", "ScheduleSetURI": "/vmrest/schedulesets/96e43ab7-b6c1-49b1-ba27-008b8f8870e4", "SendUrgentMsg": "0", "MaxMsgLen": "300", "IsTemplate": "false", "ObjectId": "6702cce8-853f-4cbd-8579-35c595213898", "RecipientDistributionListObjectId": "24865f76-fa95-412d-bc56-a48ef9e1531a", "RecipientDistributionListURI": "/vmrest/distributionlists/24865f76-fa95-412d-bc56-a48ef9e1531a", "DisplayName": "Opening Greeting", "AfterMessageAction": "2", "AfterMessageTargetConversation": "PHGreeting", "AfterMessageTargetHandlerObjectId": "8c400830-7e92-4908-9ca6-a4b123f1bd19", "TimeZone": "190", "UseDefaultLanguage": "true", "UseDefaultTimeZone": "true", "MediaSwitchObjectId": "a984674b-98d1-442e-83a9-2dcc0824af9e", "PhoneSystemURI": "/vmrest/phonesystems/a984674b-98d1-442e-83a9-2dcc0824af9e", "UseCallLanguage": "true", "SendSecureMsg": "false", "EnablePrependDigits": "false", "DispatchDelivery": "false", "CallSearchSpaceObjectId": "5a07d332-6fc5-4a3f-baba-3cb4ea630280", "CallSearchSpaceURI": "/vmrest/searchspaces/5a07d332-6fc5-4a3f-baba-3cb4ea630280", "InheritSearchSpaceFromCall": "true", "PartitionObjectId": "d50e9d0b-656e-416d-b5b7-43c4d2e2fd0b", "PartitionURI": "/vmrest/partitions/d50e9d0b-656e-416d-b5b7-43c4d2e2fd0b", "PlayPostGreetingRecording": "0", "SendPrivateMsg": "0", "PlayAfterMessage": "1", "GreetingsURI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898/greetings", "TransferOptionsURI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898/transferoptions", "MenuEntriesURI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898/menuentries", "CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/6702cce8-853f-4cbd-8579-35c595213898/callhandlerowners" }, { "URI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5", "CreationTime": "2013-02-14T05:05:44Z", "Language": "1033", "Undeletable": "true", "VoiceName": "389d2d11-f74c-4df1-9766-098800b8fe74.wav", "VoiceFileURI": "/vmrest/voicefiles/c8cd8b94-8d2f-47d6-841e-ca1d3a02bdc2", "VoiceNameURI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5/voicename", "LocationObjectId": "bbf3e6ed-0278-479c-9a6e-2da8756eeb6f", "LocationURI": "/vmrest/locations/connectionlocations/bbf3e6ed-0278-479c-9a6e-2da8756eeb6f", "EditMsg": "true", "IsPrimary": "false", "OneKeyDelay": "1500", "ScheduleSetObjectId": "96e43ab7-b6c1-49b1-ba27-008b8f8870e4", "ScheduleSetURI": "/vmrest/schedulesets/96e43ab7-b6c1-49b1-ba27-008b8f8870e4", "SendUrgentMsg": "0", "MaxMsgLen": "300", "IsTemplate": "false", "ObjectId": "426e4f1c-0cf1-43dc-a52b-63db2c0704c5", "RecipientSubscriberObjectId": "053afdf6-78e8-4a54-9384-e6c32c68dacd", "RecipientUserURI": "/vmrest/users/053afdf6-78e8-4a54-9384-e6c32c68dacd", "DisplayName": "Operator", "AfterMessageAction": "2", "AfterMessageTargetConversation": "PHGreeting", "AfterMessageTargetHandlerObjectId": "8c400830-7e92-4908-9ca6-a4b123f1bd19", "DtmfAccessId": "0", "TimeZone": "190", "UseDefaultLanguage": "true", "UseDefaultTimeZone": "true", "MediaSwitchObjectId": "a984674b-98d1-442e-83a9-2dcc0824af9e", "PhoneSystemURI": "/vmrest/phonesystems/a984674b-98d1-442e-83a9-2dcc0824af9e", "UseCallLanguage": "true", "SendSecureMsg": "false", "EnablePrependDigits": "false", "DispatchDelivery": "false", "CallSearchSpaceObjectId": "5a07d332-6fc5-4a3f-baba-3cb4ea630280", "CallSearchSpaceURI": "/vmrest/searchspaces/5a07d332-6fc5-4a3f-baba-3cb4ea630280", "InheritSearchSpaceFromCall": "true", "PartitionObjectId": "d50e9d0b-656e-416d-b5b7-43c4d2e2fd0b", "PartitionURI": "/vmrest/partitions/d50e9d0b-656e-416d-b5b7-43c4d2e2fd0b", "PlayPostGreetingRecording": "0", "SendPrivateMsg": "0", "PlayAfterMessage": "1", "GreetingsURI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5/greetings", "TransferOptionsURI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5/transferoptions", "MenuEntriesURI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5/menuentries", "CallHandlerOwnerURI": "/vmrest/handlers/callhandlers/426e4f1c-0cf1-43dc-a52b-63db2c0704c5/callhandlerowners" } ] } Response Code: 200 </pr>

Rating: 0.0/5 (0 votes cast)

Personal tools