About Greeting API
The greeting type can be any one of the following:
-
Standard
-
Alternate
-
Busy
-
Closed
-
Holiday
-
Error
-
Internal
An end user can have greetings in more than one language. The first resource allows users to access the list of greetings that currently have audio. In case there are no greetings recorded, the list will be empty.
Listing Details of a Greeting
A GET will return a GreetingStreamFiles object that contains a set of GreetingStreamFile objects for the specified greeting type. Each GreetingStreamFile object has a URI that allows access to the greeting audio. The individual audio URI's are in the following format:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
To get the audio/wav file associated with a greeting type, a GET operation on the URL below needs to be performed:
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Get setting for a greeting: Every user with a mailbox has an associated call handler, and thus a full compliment of greetings
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JASON Example
|
|
|
Enabling or Disabling Greetings
The TimeExpires field determines whether a greeting is enabled or disabled. To enable a greeting, TimeExpires needs to be set to a future date, which is the date on which the greeting will expire (be disabled). To disable a greeting, simply set TimeExpires to a date in the past. Also, if TimeExpires is set to null that means it is enabled indefinitely (currently CUPI offers no ability to set this field to null).
TimeExpires is always calculated as GMT. Any time zone conversion is the responsibility of the client.
To enable the Holiday greeting until March 9th 2020, you would use the following PUT request:
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
To disable a greeting you would do a PUT request with the TimeExpires field set to a date in the past, as follows:
|
|
Update Greeting
The HTTPS content type of the PUT operation to update the greeting is "audio/wav" and the payload content is the audio data. If the greeting for the given type and language does not exist, the greeting audio will be created. If the greeting audio already exists, the existing audio is replaced by the new audio.
|
This request consumes audio/wav file. Attach a file to the request for adding or updating the greeting.
|
Using the CUTI to record greetings via the Phone
Greetings can be updated using recorded wave files or by using the Phone interface via the CUTI.
The following example demonstrates how to achieve this task.
-
Record the greeting using CUTI, the details are available at
http://docwiki.cisco.com/wiki/Cisco_Unity_Connection_Telephony_Interface_%28CUTI%29_API_--_Using_CUTI_for_Basic_Call_Operations
-
Update the user greeting with the recorded file:
-
The record operation in Step-1 returns XML/JSON output containing the details of the recorded file.
-
Send a PUT request on the URL
-
|
with the XML/JSON returned in the step above. Below is an example JSON request body:
|
The Put request will update the Greetings. The update of a Greetings wave file is similar whether a audio wave file is being used or the audio is a CallControl XML/JSON schema.