Deeptija at 09:41, 3 October 2012

2012-10-03T09:41:43Z

← Older revision		Revision as of 09:41, 3 October 2012
Line 178:		Line 178:

	Note that you cannot use CUPI to delete Greetings.		Note that you cannot use CUPI to delete Greetings.
		+
		+	== Minimum Software Version ==
		+
		+	For information on minimum software required with this API, see [[Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_Basic_User_Template_Information#Minimum_Software_Version]]

Deeptija: 1 revision

2012-10-02T17:48:38Z

1 revision

← Older revision

Revision as of 17:48, 2 October 2012

Deeptija at 13:31, 8 August 2012

2012-08-08T13:31:48Z

New page

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUPI Guide Contents'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|API Overview ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation|Index of All CUPI Documentation]]
|}

__TOC__

== Listing and Viewing ==

The following GET allows users templates to listen to and modify their personal greeting:

<pre> https://<connection_server>/vmrest/callhandlerprimarytemplates/<objectId>/usertemplategreetings </pre>

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

<pre>
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<UserTemplateGreetings total="7">
<UserTemplateGreeting>
<CallHandlerObjectId>a254488a-7f96-4737-9df4-886e3f4b88af</CallHandlerObjectId>
<CallhandlerURI>/vmrest/callhandlerprimarytemplates/a254488a-7f96-4737-9df4-886e3f4b88af</CallhandlerURI>
<IgnoreDigits>false</IgnoreDigits>
<PlayWhat>1</PlayWhat>
<RepromptDelay>20</RepromptDelay>
<Reprompts>30</Reprompts>
<TimeExpires>2012-10-06 09:25:00.0</TimeExpires>
<GreetingType>Alternate</GreetingType>
<AfterGreetingAction>2</AfterGreetingAction>
<AfterGreetingTargetConversation>PHTransfer</AfterGreetingTargetConversation>
<AfterGreetingTargetHandlerObjectId>9e96f34b-22bc-429a-8852-46fbceeff182</AfterGreetingTargetHandlerObjectId>
<PlayRecordMessagePrompt>false</PlayRecordMessagePrompt>
<EnableTransfer>false</EnableTransfer>
<EnAltGreetDontRingPhone>true</EnAltGreetDontRingPhone>
<EnAltGreetPreventSkip>true</EnAltGreetPreventSkip>
<EnAltGreetPreventMsg>true</EnAltGreetPreventMsg>
<LanguageCode>1033</LanguageCode>
</UserTemplateGreeting>
<UserTemplateGreeting>
<CallHandlerObjectId>a254488a-7f96-4737-9df4-886e3f4b88af</CallHandlerObjectId>
<CallhandlerURI>/vmrest/callhandlerprimarytemplates/a254488a-7f96-4737-9df4-886e3f4b88af</CallhandlerURI>
<IgnoreDigits>false</IgnoreDigits>
<PlayWhat>0</PlayWhat>
<RepromptDelay>2</RepromptDelay>
<Reprompts>0</Reprompts>
<TimeExpires>2020-10-06 09:25:00.0</TimeExpires>
<GreetingType>Busy</GreetingType>
<AfterGreetingAction>4</AfterGreetingAction>
<PlayRecordMessagePrompt>true</PlayRecordMessagePrompt>
<EnableTransfer>true</EnableTransfer>
<LanguageCode>1033</LanguageCode>
</UserTemplateGreeting>
<UserTemplateGreeting>
<CallHandlerObjectId>a254488a-7f96-4737-9df4-886e3f4b88af</CallHandlerObjectId>
<CallhandlerURI>/vmrest/callhandlerprimarytemplates/a254488a-7f96-4737-9df4-886e3f4b88af</CallhandlerURI>
<IgnoreDigits>false</IgnoreDigits>
<PlayWhat>0</PlayWhat>
<RepromptDelay>2</RepromptDelay>
<Reprompts>0</Reprompts>
<GreetingType>Error</GreetingType>
<AfterGreetingAction>6</AfterGreetingAction>
<AfterGreetingTargetConversation>PHGreeting</AfterGreetingTargetConversation>
<AfterGreetingTargetHandlerObjectId>08313019-91db-4aed-8ef3-af13a4a72e22</AfterGreetingTargetHandlerObjectId>
<PlayRecordMessagePrompt>true</PlayRecordMessagePrompt>
<EnableTransfer>false</EnableTransfer>
<LanguageCode>1033</LanguageCode>
</UserTemplateGreeting>
<UserTemplateGreeting>
<CallHandlerObjectId>a254488a-7f96-4737-9df4-886e3f4b88af</CallHandlerObjectId>
<CallhandlerURI>/vmrest/callhandlerprimarytemplates/a254488a-7f96-4737-9df4-886e3f4b88af</CallhandlerURI>
<IgnoreDigits>false</IgnoreDigits>
<PlayWhat>0</PlayWhat>
<RepromptDelay>2</RepromptDelay>
<Reprompts>0</Reprompts>
<TimeExpires>2013-01-01 00:00:00.0</TimeExpires>
<GreetingType>Internal</GreetingType>
<AfterGreetingAction>4</AfterGreetingAction>
<PlayRecordMessagePrompt>false</PlayRecordMessagePrompt>
<EnableTransfer>false</EnableTransfer>
<LanguageCode>1033</LanguageCode>
</UserTemplateGreeting>
<UserTemplateGreeting>
<CallHandlerObjectId>a254488a-7f96-4737-9df4-886e3f4b88af</CallHandlerObjectId>
<CallhandlerURI>/vmrest/callhandlerprimarytemplates/a254488a-7f96-4737-9df4-886e3f4b88af</CallhandlerURI>
<IgnoreDigits>false</IgnoreDigits>
<PlayWhat>0</PlayWhat>
<RepromptDelay>2</RepromptDelay>
<Reprompts>0</Reprompts>
<TimeExpires>1972-01-01 00:00:00.0</TimeExpires>
<GreetingType>Off Hours</GreetingType>
<AfterGreetingAction>4</AfterGreetingAction>
<PlayRecordMessagePrompt>true</PlayRecordMessagePrompt>
<EnableTransfer>false</EnableTransfer>
<LanguageCode>1033</LanguageCode>
</UserTemplateGreeting>
<UserTemplateGreeting>
<CallHandlerObjectId>a254488a-7f96-4737-9df4-886e3f4b88af</CallHandlerObjectId>
<CallhandlerURI>/vmrest/callhandlerprimarytemplates/a254488a-7f96-4737-9df4-886e3f4b88af</CallhandlerURI>
<IgnoreDigits>false</IgnoreDigits>
<PlayWhat>0</PlayWhat>
<RepromptDelay>2</RepromptDelay>
<Reprompts>0</Reprompts>
<GreetingType>Standard</GreetingType>
<AfterGreetingAction>4</AfterGreetingAction>
<PlayRecordMessagePrompt>true</PlayRecordMessagePrompt>
<EnableTransfer>false</EnableTransfer>
<LanguageCode>1033</LanguageCode>
</UserTemplateGreeting>
<UserTemplateGreeting>
<CallHandlerObjectId>a254488a-7f96-4737-9df4-886e3f4b88af</CallHandlerObjectId>
<CallhandlerURI>/vmrest/callhandlerprimarytemplates/a254488a-7f96-4737-9df4-886e3f4b88af</CallhandlerURI>
<IgnoreDigits>false</IgnoreDigits>
<PlayWhat>0</PlayWhat>
<RepromptDelay>2</RepromptDelay>
<Reprompts>0</Reprompts>
<TimeExpires>1972-01-01 00:00:00.0</TimeExpires>
<GreetingType>Holiday</GreetingType>
<AfterGreetingAction>4</AfterGreetingAction>
<PlayRecordMessagePrompt>true</PlayRecordMessagePrompt>
<EnableTransfer>false</EnableTransfer>
<LanguageCode>1033</LanguageCode>
</UserTemplateGreeting>
</UserTemplateGreetings>
</pre>

<pre> Response Code: 200 </pre>

The \{greeting type\} can be any one of the following:

*Standard
*Alternate
*Busy
*Closed
*Holiday
*Error
*Internal

Each greeting can be accessed through the following various GET requests:

*https://<connection_server>/vmrest/usertemplate/greetings/Alternate
*https://<connection_server>/vmrest/usertemplate/greetings/Busy
*https://<connection_server>/vmrest/usertemplate/greetings/Error
*https://<connection_server>/vmrest/usertemplate/greetings/Internal
*https://<connection_server>/vmrest/usertemplate/greetings/Off%20Hours
*https://<connection_server>/vmrest/usertemplate/greetings/Standard
*https://<connection_server>/vmrest/usertemplate/greetings/Holiday

== Creating Greetings ==

Note that you cannot use CUPI to create Greetings.

== Modifying Greetings ==

The following is an example of the PUT request that modifies the personal greeting as represented by <greetingtype>:

<pre> https://<connection_server>/vmrest/callhandlerprimarytemplates/<objectId>/usertemplategreetings/<Greeting-type </pre>

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

<pre>
<UserTemplateGreeting>
<EnableTransfer>true</EnableTransfer>
<RepromptDelay>454354</RepromptDelay>
<Reprompts>30</Reprompts>
</UserTemplateGreeting>
</pre>

<pre> Response Code: 204 </pre>

== Deleting Greetings ==

Note that you cannot use CUPI to delete Greetings.

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

Deeptija at 09:41, 3 October 2012

Deeptija: 1 revision

Deeptija at 13:31, 8 August 2012