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

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


Call Handler Templates APIs

Each call handler that you add in Cisco Unity Connection is based on a template. Settings from the template are applied as the call handler is created. Unity Connection comes with one default call handler template, which has settings that are suitable for most call handlers. You can also create new templates. Before you create call handlers, review the settings in the template that you plan to use and determine whether you need to make changes or create new templates. For each template, you should consider enabling the transfer, caller input, greetings, and message settings that will be needed for the call handlers that you plan to create. Following Points should be noted:-

  • If you change settings on a call handler template, the new settings are in effect only for new call handlers that are created by using that template. Changes to template settings do not affect existing call handlers.
  • Deleting a call handler template does not affect any call handlers that were based on that template when they were created.
  • Default Template cannot be deleted.

Administrator can use this API to create/update/delete/fetch the system call handler templates. Various attributes of a call handler template can also be updated using this API.


Listing the Call Handler Templates

The following is an example of the GET request that fetch the list of call handler templates:

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

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

<CallhandlerTemplates total="1">
  <CallhandlerTemplate>
    <URI>/vmrest/callhandlertemplates/5024347a-aac2-463a-98c8-a745a805dc3b</URI>
    <CreationTime>2013-01-10T09:23:20Z</CreationTime>
    <Language>1033</Language>
    <DisplayName>System Call Handler Template1</DisplayName>
    <UseDefaultLanguage>false</UseDefaultLanguage>
    <UseDefaultTimeZone>true</UseDefaultTimeZone>
    <Undeletable>true</Undeletable>
    <LocationObjectId>22646a82-1f17-4b42-beec-9cdfd69508c5</LocationObjectId>
    <LocationURI>/vmrest/locations/connectionlocations/22646a82-1f17-4b42-beec-
    9cdfd69508c5</LocationURI>
    <EditMsg>true</EditMsg>
    <IsPrimary>false</IsPrimary>
    <MaxMsgLen>300</MaxMsgLen>
    <OneKeyDelay>1500</OneKeyDelay>
    <ScheduleSetObjectId>10fee566-b137-4652-a378-
    db8a872a161d</ScheduleSetObjectId>
    <ScheduleSetURI>/vmrest/schedulesets/10fee566-b137-4652-a378-
    db8a872a161d</ScheduleSetURI>
    <SendUrgentMsg>0</SendUrgentMsg>
    <IsTemplate>true</IsTemplate>
    <ObjectId>5024347a-aac2-463a-98c8-a745a805dc3b</ObjectId>
    <RecipientDistributionListObjectId>f7408e6e-822e-494b-ab29-
    cff3cf9e0bd9</RecipientDistributionListObjectId>
    <RecipientDistributionListURI>/vmrest/distributionlists/f7408e6e-822e-494b-ab29-
    cff3cf9e0bd9</RecipientDistributionListURI>
    <AfterMessageAction>2</AfterMessageAction>
    <AfterMessageTargetConversation>PHGreeting</AfterMessageTargetConversation>
    <AfterMessageTargetHandlerObjectId>16cf736f-7254-4654-ab09-
    08fe743332a9</AfterMessageTargetHandlerObjectId>
    <TimeZone>190</TimeZone>
    <MediaSwitchObjectId>abf4b7d1-89d5-45c2-bdc8-
    d3b13f5040f5</MediaSwitchObjectId>
    <PhoneSystemURI>/vmrest/phonesystems/abf4b7d1-89d5-45c2-bdc8-
    d3b13f5040f5</PhoneSystemURI>
    <UseCallLanguage>false</UseCallLanguage>
    <SendSecureMsg>false</SendSecureMsg>
    <EnablePrependDigits>false</EnablePrependDigits>
    <DispatchDelivery>false</DispatchDelivery>
    <CallSearchSpaceObjectId>f3beb4e4-0be5-417f-9491-
    e233c6d4a40e</CallSearchSpaceObjectId>
    <CallSearchSpaceURI>/vmrest/searchspaces/f3beb4e4-0be5-417f-9491-
    e233c6d4a40e</CallSearchSpaceURI>
    <InheritSearchSpaceFromCall>true</InheritSearchSpaceFromCall>
    <PartitionObjectId>5ec15c45-ace9-41ad-a6c4-b56081c79717</PartitionObjectId>
    <PartitionURI>/vmrest/partitions/5ec15c45-ace9-41ad-a6c4-
    b56081c79717</PartitionURI>
    <PlayPostGreetingRecording>0</PlayPostGreetingRecording>
    <SendPrivateMsg>0</SendPrivateMsg>
    <PlayAfterMessage>1</PlayAfterMessage>
    <GreetingsURI>/vmrest/callhandlertemplates/5024347a-aac2-463a-98c8-
    a745a805dc3b/templategreetings</GreetingsURI>
    <TransferOptionsURI>/vmrest/callhandlertemplates/5024347a-aac2-463a-98c8-
    a745a805dc3b/templatetransferoptions</TransferOptionsURI>
    <MenuEntriesURI>/vmrest/callhandlertemplates/5024347a-aac2-463a-98c8-
    a745a805dc3b/templatemenuentries</MenuEntriesURI>
  </CallhandlerTemplate>
</CallhandlerTemplates>
Response Code: 200

JSON Example

To view the list of call handler templates, do the following:

Request URI:
GET: https://<connection-server>/vmrest/callhandlertemplates
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"
  "CallhandlerTemplate":  [
  {
    "URI":"/vmrest/callhandlertemplates/7a022382-8d0a-4289-880d-d2a432494b02"
    "CreationTime":"2013-02-25T09:39:23Z"
    "Language":"1033"
    "DisplayName":"System Call Handler Template"
    "UseDefaultLanguage":"true"
    "UseDefaultTimeZone":"true"
    "Undeletable":"true"
    "LocationObjectId":"cff1347e-87af-4409-bead-d1970625f82e"
    "LocationURI":"/vmrest/locations/connectionlocations/cff1347e-87af-4409-bead-
    d1970625f82e"
    "EditMsg":"true"
    "IsPrimary":"false"
    "MaxMsgLen":"300"
    "OneKeyDelay":"1500"
    "ScheduleSetObjectId":"5fc5a5d7-eaf6-4f4d-80cf-f76f3893ac0e"
    "ScheduleSetURI":"/vmrest/schedulesets/5fc5a5d7-eaf6-4f4d-80cf-f76f3893ac0e"
    "SendUrgentMsg":"0"
    "IsTemplate":"true"
    "ObjectId":"7a022382-8d0a-4289-880d-d2a432494b02"
    "RecipientDistributionListObjectId":"dea18b5b-4493-4715-a558-cb85778fd823"
    "RecipientDistributionListURI":"/vmrest/distributionlists/dea18b5b-4493-4715-a558-
    cb85778fd823"
    "AfterMessageAction":"2"
    "AfterMessageTargetConversation":"PHGreeting"
    "AfterMessageTargetHandlerObjectId":"c6af281b-dc8b-45b4-a1e9-eccc523d5fb2"
    "TimeZone":"190"
    "MediaSwitchObjectId":"0ad0b88c-4a70-4cf7-913e-d5d7a921caca"
    "PhoneSystemURI":"/vmrest/phonesystems/0ad0b88c-4a70-4cf7-913e-d5d7a921caca"
    "UseCallLanguage":"true"
    "SendSecureMsg":"false"
    "EnablePrependDigits":"false"
    "DispatchDelivery":"false"
    "CallSearchSpaceObjectId":"2e836e16-f715-4a18-bb7c-ee5e33281706"
    "CallSearchSpaceURI":"/vmrest/searchspaces/2e836e16-f715-4a18-bb7c-
    ee5e33281706"
    "InheritSearchSpaceFromCall":"true"
    "PartitionObjectId":"97bf6afe-346e-4275-967e-43c50be79d32"
    "PartitionURI":"/vmrest/partitions/97bf6afe-346e-4275-967e-43c50be79d32"
    "PlayPostGreetingRecording":"0"
    "SendPrivateMsg":"0"
    "PlayAfterMessage":"1"
    "GreetingsURI":"/vmrest/callhandlertemplates/7a022382-8d0a-4289-880d-
    d2a432494b02/templategreetings"
    "TransferOptionsURI":"/vmrest/callhandlertemplates/7a022382-8d0a-4289-880d-
    d2a432494b02/templatetransferoptions"
    "MenuEntriesURI":"/vmrest/callhandlertemplates/7a022382-8d0a-4289-880d-
    d2a432494b02/templatemenuentries"
  }
  ]
}
Response Code: 200


Viewing the Details of Specific Call Handler Template

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

  GET https://<connection-server>/vmrest/callhandlertemplates/<callhandlertemplate-objectid>

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

<CallhandlerTemplate>
    <URI>/vmrest/callhandlertemplates/edcd2336-2c01-49d1-89ff-8746466e0a5e</URI>
    <CreationTime>2013-01-12T11:40:19Z</CreationTime>
    <Language>1033</Language>
    <DisplayName>CallHandler1</DisplayName>
    <UseDefaultLanguage>false</UseDefaultLanguage>
    <UseDefaultTimeZone>true</UseDefaultTimeZone>
    <Undeletable>false</Undeletable>
    <LocationObjectId>22646a82-1f17-4b42-beec-9cdfd69508c5</LocationObjectId>
    <LocationURI>/vmrest/locations/connectionlocations/22646a82-1f17-4b42-beec-
    9cdfd69508c5</LocationURI>
    <EditMsg>true</EditMsg>
    <IsPrimary>false</IsPrimary>
    <MaxMsgLen>300</MaxMsgLen>
    <OneKeyDelay>1500</OneKeyDelay>
    <ScheduleSetObjectId>10fee566-b137-4652-a378-db8a872a161d</ScheduleSetObjectId>
    <ScheduleSetURI>/vmrest/schedulesets/10fee566-b137-4652-a378-
    db8a872a161d</ScheduleSetURI>
    <SendUrgentMsg>0</SendUrgentMsg>
    <IsTemplate>true</IsTemplate>
    <ObjectId>edcd2336-2c01-49d1-89ff-8746466e0a5e</ObjectId>
    <RecipientSubscriberObjectId>f74c4f98-598e-4c47-bf1a-
    2b78fc2c2953</RecipientSubscriberObjectId>
    <RecipientUserURI>/vmrest/users/f74c4f98-598e-4c47-bf1a-2b78fc2c2953</RecipientUserURI>
    <AfterMessageAction>1</AfterMessageAction>
    <TimeZone>190</TimeZone>
    <MediaSwitchObjectId>abf4b7d1-89d5-45c2-bdc8-d3b13f5040f5</MediaSwitchObjectId>
    <PhoneSystemURI>/vmrest/phonesystems/abf4b7d1-89d5-45c2-bdc8-
    d3b13f5040f5</PhoneSystemURI>
    <UseCallLanguage>false</UseCallLanguage>
    <SendSecureMsg>false</SendSecureMsg>
    <EnablePrependDigits>false</EnablePrependDigits>
    <DispatchDelivery>false</DispatchDelivery>
    <CallSearchSpaceObjectId>f3beb4e4-0be5-417f-9491-e233c6d4a40e</CallSearchSpaceObjectId>
    <CallSearchSpaceURI>/vmrest/searchspaces/f3beb4e4-0be5-417f-9491-
    e233c6d4a40e</CallSearchSpaceURI>
    <InheritSearchSpaceFromCall>true</InheritSearchSpaceFromCall>
    <PartitionObjectId>5ec15c45-ace9-41ad-a6c4-b56081c79717</PartitionObjectId>
    <PartitionURI>/vmrest/partitions/5ec15c45-ace9-41ad-a6c4-b56081c79717</PartitionURI>
    <PlayPostGreetingRecording>0</PlayPostGreetingRecording>
    <SendPrivateMsg>0</SendPrivateMsg>
    <PlayAfterMessage>1</PlayAfterMessage>
    <GreetingsURI>/vmrest/callhandlertemplates/edcd2336-2c01-49d1-89ff-
    8746466e0a5e/templategreetings</GreetingsURI>
    <TransferOptionsURI>/vmrest/callhandlertemplates/edcd2336-2c01-49d1-89ff-
    8746466e0a5e/templatetransferoptions</TransferOptionsURI>
    <MenuEntriesURI>/vmrest/callhandlertemplates/edcd2336-2c01-49d1-89ff-
    8746466e0a5e/templatemenuentries</MenuEntriesURI>
</CallhandlerTemplate>
Response Code: 200

JSON Example

To view a specific call handler template, do the following:

Request URI:
GET: https://<connection-server>/vmrest/callhandlertemplates/<callhandlertemplate-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/callhandlertemplates/93b8ada5-c92f-47e6-8d24-9c269293d63c"
    "CreationTime":"2013-02-26T06:45:09Z"
    "Language":"1033"
    "DisplayName":"Call_Handler1"
    "UseDefaultLanguage":"true"
    "UseDefaultTimeZone":"false"
    "Undeletable":"false"
    "LocationObjectId":"cff1347e-87af-4409-bead-d1970625f82e"
    "LocationURI":"/vmrest/locations/connectionlocations/cff1347e-87af-4409-bead-
    d1970625f82e"
    "EditMsg":"true"
    "IsPrimary":"false"
    "MaxMsgLen":"500"
    "OneKeyDelay":"1500"
    "ScheduleSetObjectId":"5c42abd2-84a5-4fcf-84cf-d0a19c70f207"
    "ScheduleSetURI":"/vmrest/schedulesets/5c42abd2-84a5-4fcf-84cf-d0a19c70f207"
    "SendUrgentMsg":"1"
    "IsTemplate":"true"
    "ObjectId":"93b8ada5-c92f-47e6-8d24-9c269293d63c"
    "RecipientDistributionListObjectId":"8337a757-b074-42ff-85bd-acda2dfd5d28"
    "RecipientDistributionListURI":"/vmrest/distributionlists/8337a757-b074-42ff-85bd-
    acda2dfd5d28"
    "AfterMessageAction":"2"
    "AfterMessageTargetConversation":"AD"
    "AfterMessageTargetHandlerObjectId":"4783cb28-79a6-409a-bf57-18f8208b4e61"
    "TimeZone":"190"
    "MediaSwitchObjectId":"343dc222-2d1a-4a19-a5b6-894725542475"
    "PhoneSystemURI":"/vmrest/phonesystems/343dc222-2d1a-4a19-a5b6-894725542475"
    "UseCallLanguage":"true"
    "SendSecureMsg":"false"
    "EnablePrependDigits":"false"
    "DispatchDelivery":"true"
    "CallSearchSpaceObjectId":"2e836e16-f715-4a18-bb7c-ee5e33281706"
    "CallSearchSpaceURI":"/vmrest/searchspaces/2e836e16-f715-4a18-bb7c-ee5e33281706"
    "InheritSearchSpaceFromCall":"true"
    "PartitionObjectId":"44bdcf73-d5c1-4866-957d-fb35686cbe76"
    "PartitionURI":"/vmrest/partitions/44bdcf73-d5c1-4866-957d-fb35686cbe76"
    "PlayPostGreetingRecording":"2"
    "SendPrivateMsg":"0"
    "PlayAfterMessage":"2"
    "GreetingsURI":"/vmrest/callhandlertemplates/93b8ada5-c92f-47e6-8d24-
    9c269293d63c/templategreetings"
    "TransferOptionsURI":"/vmrest/callhandlertemplates/93b8ada5-c92f-47e6-8d24-
    9c269293d63c/templatetransferoptions"
}
Response Code: 200


Creating a New Call Handler Template

Mandatory parameters are:

  • Display Name
  • Phone System – Fetch phone systems using URI: https://<connection-server>/vmrest/phonesystems
  • Message recipient – The message recipient can be a distribution list or a user. Use the following URI to fetch users or distribution lists respectively.
  • https://<connection-server>/vmrest/users
  • https://<connection-server>/vmrest/distributionlists

The following is an example of the POST request that creates a new call handler template:

  POST https://<connection-server>/vmrest/callhandlertemplates
Request Body:
  <CallhandlerTemplate>
    <DisplayName>System Call Handler Template1</DisplayName>
    <RecipientSubscriberObjectId>f74c4f98-598e-4c47-bf1a-
    2b78fc2c2953</RecipientSubscriberObjectId>
    <MediaSwitchObjectId>abf4b7d1-89d5-45c2-bdc8-d3b13f5040f5</MediaSwitchObjectId>
  </CallhandlerTemplate>

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 a new call handler template, do the following:

Request URI:
POST: https://<connection-server>/vmrest/callhandlertemplates
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
"DisplayName":"Tenant",
"RecipientDistributionListObjectId":"8337a757-b074-42ff-85bd-acda2dfd5d28",
"MediaSwitchObjectId":"343dc222-2d1a-4a19-a5b6-894725542475"
}

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


Delete the Call Handler Template

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

DELETE https://<connection-server>/vmrest/callhandlertemplates/<callhandlertemplate-objectid>

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 a call handler template, do the following:

Request URI:
DELETE: https://<connection-server>/vmrest/callhandlertemplates/<callhandlertemplate-objectid>
Accept: 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


Assigning a Schedule to a Call Handler Template

The following is an example of the PUT request that can be used to assign a schedule to a call handler template:

PUT https://<connection-server>/vmrest/callhandlertemplates/<callhandlertemplate-objectid>
The ScheduleSetObjectId can be fetched using the URI https://<connection-server>/vmrest/schedulesets.
<CallhandlerTemplate>
    <ScheduleSetObjectId>eb11c6cc-fc9e-4651-8c01-8f0b2e421918</ScheduleSetObjectId>
</CallhandlerTemplate>

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 assign a schedule to a call handler template, do the following:

Request URI:
PUT: https://<connection-server>/vmrest/callhandlertemplates/<callhandlertemplate-objectid>
Accept: application/json
Content_type: application/json
Connection: keep_alive
{
    "ScheduleSetObjectId":"5c42abd2-84a5-4fcf-84cf-d0a19c70f207"
}

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

Updating Partition of the Call Handler Template

This PUT request can be used to assign partition to a call handler template.

PUT https://<connection-server>/vmrest/callhandlertemplates/<callhandlertemplate-objectid>

To fetch PartitionObjectId, use the URI https://<connection-server>/vmrest/partitions.


<CallhandlerTemplate>
    <PartitionObjectId>46a0377b-00d7-40a0-8738-81106fc730ea</PartitionObjectId>
</CallhandlerTemplate>

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 partition of call handler template, do the following:

<pre>
PUT: https://<connection-server>/vmrest/callhandlertemplates/<callhandlertemplate-objectid>
Accept: application/json
Content_type: application/json
Connection: keep_alive

{

   "PartitionObjectId":"fe2fe907-bdcb-416e-89b7-c1bb130d0f98"

} </pre> 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

Updating Language Option of the Call Handler Template

This PUT request can be used to update language for a call handler template. To know languages installed on the server following URI can be used:

PUT https://<connection-server>/vmrest/installedlanguages
PUT https://<connection-server>/vmrest/callhandlertemplates<callhandlertemplate-objectid>

Example 1: The Inherit language field from the call is selected but the UseDefaultLanguage field is not updated

<CallhandlerTemplate>
    <UseDefaultLanguage>true</UseDefaultLanguage>
    <UseCallLanguage>false</UseCallLanguage>
</CallhandlerTemplate>

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: The Inherit Language field from the call is selected but this the UseDefaultLanguage field is not updated in the database as the language field is missing as the Language field is NULL and UseDefaultLanguage is by default set to TRUE.

Example 2: The Inherit language field from the call is selected and the UseDefaultLanguage field is updated

Request Body:
<CallhandlerTemplate>
    <UseCallLanguage>true</UseCallLanguage>
    <UseDefaultLanguage>false</UseDefaultLanguage> 
    <Language>1033</Language>
</CallhandlerTemplate>

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: The Inherit Language field from the call is selected but the UseDefaultLanguage field is updated in the database as the Language field is specified. The Inherit Language field from the call is selected but the UseDefaultLanguage field is updated in the database as the Language field is specified. Language code for installed language can be fetched from: https://<connection-server>/vmrest/installedlanguages Language code can be fetched from the URI: https://<connection-server>/vmrest/languagemap The below table specify the details of value for each field:

UseCallLanguage UseDefaultLanguage Language Description
false true Null/Language Code This will select the default language.
true true/false Null/Language Code This will inherit the language from user.
false false Language Code This will select the particular language as per the code.

JSON Example

To update language option of call handler template, do the follwoing:

Request URI:
PUT: https://<connection-server>/vmrest/callhandlertemplates/<callhandlertemplate-objectid>
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
    "UseCallLanguage":"true",
    "UseDefaultLanguage":"false",
    "Language":"1033"
}

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

Updating Timezone of a Call Handler Template

This PUT request can be used to update timezone for a call handler template. It can be set to default or particular timezone. The mandatory fields for this request are:

  • UseDefaultTimeZone
  • TimeZone

To know timzones installed on the server following URI can be used: https://<connection-server>/vmrest/timezones

PUT https://<connection-server>/vmrest/callhandlertemplates/<callhandlertemplate-objectid>
Request Body:
<CallhandlerTemplate>
    <UseDefaultTimeZone>false</UseDefaultTimeZone>
    <TimeZone>190</TimeZone>
</CallhandlerTemplate>
Response Code: 204

JSON Example

To update timezone of call handler template, do the following:

Request URI:
PUT: https://<connection-server>/vmrest/callhandlertemplates/<callhandlertemplate-objectid>
Accept: application/json
Content_type: application/json
Connection: keep_alive
Request Body:
{
    "UseDefaultTimeZone":"false",
    "TimeZone":"190"
}

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


Explanation of Data Fields

Parameter Operations Data Type Comments
URI Read Only String Call Handler Template URI
AfterMessageAction r/w Integer Specifies the after message action.Possible Values Refer to the table 1 under the section Enum Type as given at the end of the document

Default value:1

AfterMessageTargetConversation r/w String Specifies DisplayName of the conversation to go to after taking a message.

Possible Values Refer to the table 11 under the section Enum type as given at the end of document.

AfterMessageTargetHandlerObjectId r/w String(36) The Unique Identifier of the call action object that Cisco Unity Connection performs after taking a message.
CallSearchspaceObjectId r/w String(36) Is present only if a search space is selected.

URI To fetch possible values of CallSearchspaceObjectId :https://<connection-server>//vmrest/searchspaces

CallSearchSpaceURI Read Only String URL for search spaces.
CreationTime Read Only Datetime Specifies the creation date and time of the call handler. Format: YYYY-MM-DDThh:mm:ssZ. The default value is the current system date and time
DispatchDelivery r/w Boolean A flag indicating that all messages left for the call handler is for dispatch delivery.

Possible Values

  • false:- specifies no dispatch delivery.
  • true:- specifies dispatch delivery.

Default value is false

DisplayName r/w String(64) Name of the Call Handler Template
EditMsg r/w Boolean A flag that determines whether the caller can edit messages.

Possible Values

  • false : Callers cannot edit messages
  • true : Callers can edit messages

Default value is true.

EnablePrependDigits r/w Boolean Specifies if Prepend Digits to Dialed Extensions is enabled.

Possible Values

  • false:- System will not prepend digits when dialing the transfer extension
  • true:- System will prepend digits when dialing the transfer extension

Default value is false

InheritSeachSpaceFromCall r/w Boolean Specifies if the search space is to be inherited from the call.

Possible Values:

  • true:- Inherit from call.
  • false:- Do not inherit from call.

Default value is true

IsPrimary Read Only Boolean A flag indicating whether this is a "primary" call handler for a subscriber, or an "application" call handler.

Note:- Each subscriber is associated with a call handler, which is referred to as the "primary call handler" for that subscriber. An "application call handler" is just a normal call handler.

Possible Values:

  • false: Not a primary call handler
  • true: Primary call handler

Default value is false.

IsTemplate Read Only Boolean Used to provide default values for selected columns when creating new call handlers.

Possible Values:

  • false: Not a template
  • true: Is a template

Default value is true

Language r/w Integer The Windows Locale ID (LCID) which identifies the language that Cisco Unity Connection plays the handler system prompts.
LocationObjectId Read Only String(36) The unique identifier of the Location object to which this handler belongs.
LocationURI Read Only String Specifies the URI of locations
MaxMsgLen Integer The maximum recording length (in seconds) for messages left by unidentified callers. This value is used when the call handler is set to an action of "Take Message" (either by an after greeting action in the messagingrule table or via a user input action in the menuentry table. This value only gets applied to unidentified callers leaving a message. This value is not used for subscriber-subscriber messaging. Instead the COS for the calling subscriber determines the maximum recorded message length.

Possible Values: Range 1-3600

default value is 300
MediaSwitchObjectId r/w String(36) Specifies the object Id of the Phone System the call handler belongs to.

URI To fetch MediaSwitchObjectId :https://<connection-server>/vmrest/phonesystems

PhoneSystemURI Read Only String Specifies the URI of Phone Systems
ObjectId Read Only String(36) Object Id of the Call Handler Template.
OneKeyDelay r/w Integer The amount of time (in milliseconds) that Cisco Unity Connection waits for additional input after callers press a single key that is not locked. If there is no input within this time, Cisco Unity Connection performs the action assigned to the single key. When a caller interrupts a greeting with a digit, Cisco Unity Connection will wait this number of milliseconds to see if they are going to enter more digits. Once this timeout is reached (or the caller terminates the input with a #), Cisco Unity Connection will do a look-up of the resulting string of numbers for a match with a DTMFAccessID value in the dialing domain. If a match is found, the call is sent to the matching object. If no match is found, the "Error greeting" for the call handler is invoked.
If a key is "locked" then this value does not apply. Instead action is taken immediately on that key instead of allowing more digits. A value of 0 disables one key input .

Possible Values: Range:- 0 - 10000 Default value is1500

PartitionObjectId r/w String(36) Specifies the object Id of the partition the Call Handler belongs to.

URI To fetch PartitionObjectId :https://<connection-server>/vmrest/partitions

PartitionURI Read Only String Specifies the URI of partitions.
PlayAfterMessage r/w Integer Specifies what should be played after the message

Possible Values: Refer to the table 3 under the section Enum Type as given at the end of the document Default Value:1

PlayAfterMessageRecodingObjectId r/w String(36) Object Id of the recording.

URI To fetch its value  :https://<connection-server>/vmrest/postgreetingrecordings from above URI get objectid.

PlayPostGreetingReording r/w Integer Indicates whether the recording referenced by PostGreetingRecordingObjectId should be played.

Possible Values: Refer to the table 2 under the section Enum type as given at the end of document. Default value is 0

PostGreetingRecordingObjectId r/w String(36) Specifies the object Id of the Post Greeting recording.

URI To fetch its value  :https://<connection-server>/vmrest/postgreetingrecordings from above URI get objectid.

PostGreetingURI Read Only String URI of the Post Greeting Recording
PrependDigits r/w String Touch-Tone digits to be prepended to extension when dialing transfer number ( #, 0,1...9,*). Digits, plus, hash and asterisk only are allowed
RecipientDistributionListObjectId r/w String(36) Object Id of the distribution list that is the message recipient.

URI To fetch its value  :https://<connection-server>/vmrest/ from above URI get objectid.

RecipientDistributaionListURI Read Only String URI of distribution lists
RecipientSubscriberObjectId r/w String(36) Object id of a User with a mailbox that is the message recipient.
SchduleSetObjectId r/w String(36) Object Id of the schedule set assigned to the Call Handler.
SchduleSetURI Read Only String Specifies the URI of schedule sets.
SendPrivateMsg r/w Integer Determines if an outside caller can mark their message as private.

Possible Values: Refer to the table 4 under the section Enum type as given at the end of document. Default value is 0

SendSecureMsg r/w Boolean A flag indicating whether an unidentified caller can mark a message as "secure."
Default value is false
SendUrgentMsg r/w Integer A flag indicating whether an unidentified caller can mark a message as "urgent."

Possible Values: Refer to the table 5 under the section Enum type as given at the end of document. Default value is 0(Never)

TimeZone r/w Integer Used when the UseDefaultTimezone is set to false. To know the Integer Time Zone codes for the Time Zones installed on the server following URI can be used: https://<connection-server>/vmrest/timezones

Example: 190 is the code for (GMT+05:30) Asia/Kolkata

UseCallLanguage r/w Boolean A flag indicating whether Cisco Unity Connection will use the language assigned to the call.

Possible values:

  • true
  • false

Default value is true

UseDefaultLanguage r/w Boolean A flag that is dependent on the value of Language Field. if Language is set to Null, UseDefaultLanguage is set to true.if any language is specified, UseDefaultLanguage is set to false
UseDefaultTimeZone r/w Boolean A flag indicating whether Cisco Unity Connection will use the system default Time Zone.

Possible values:

  • true
  • false

Default value is false

GreetingsURI Read Only String Specifies the URI of greetings.
TransferOptionsURI Read Only String Specifies the URI of transfer options.
MenuEntriesURI Read Only String Specifies the URI of menu entries.

Rating: 0.0/5 (0 votes cast)

Personal tools