Cisco Unity Connection Provisioning Interface (CUPI) API -- Interview Handler APIs
Interview Handler APIs
Interview Handler APIs
Interview Handler Questions APIs
Listing the Interview Handlers
The following is an example of the GET request that fetch the list of interview handlers:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
To view the list of interview handlers, do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Listing Specific Tenant Related Interview Handlers by System Administrator
In Cisco Unity Connection 10.5(2) and later, the system administrator can use TenantObjectID to list the specific tenant related interview handlers using the following URI:
|
To get the TenantObjectID, use the following URI:
|
Viewing the Details of Specific Interview Handler
The following is an example of the GET request that lists the details of interview handler represented by the provided value of interview handler ID:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
To view the list of interview handlers, do the following:
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
Delete the Interview Handler
This request can be used to delete an interview handler specified by an object ID.
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
JSON Example
To delete interview handler, do the following:
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
Updating the Interview Handler
Example 1: Modify the Interview Handler The following is an example of the PUT request that can be used to modify the interview handler.
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Note |
The Inherit Language field from the call is selected and the UseDefaultLanguage field will get updated in the database as the Language field is specified. |
JSON Example
To update the interview handler, do the following:
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
|
|
RecipientSubscriberObjectId and RecipientUserURI fields are replaced with RecipientDistributionListObjectId and RecipientDistributionListURI The table given below lists the possible values of the After Interview Action:
AfterInterviewAction | AfterMessageAction | AfterMessageTargetConversation | AfterMessageTargetHandlerObjectId |
---|---|---|---|
CallAction (Refer to the table given below) | 1-8 | NA | NA |
CallHandler | 2 | PHTransfer/PHGreeting | <object-id> of call handler having IsPrimary parameter as true. URI to get object id of call handlers: https://<connection-server>/vmrest/handlers/callhandlers?query=(IsPrimary%20is%201) |
Interview Handler | 2 | PHInterview | <object-id> of interview handler. URI to get object id of Interview handlers: https://<connection-server>/vmrest/handlers/interviewhandlers. |
Directory Handler | 2 | AD | <object-id> of directory handler. URI to get object id of directory handlers: https://<connection-server>/vmrest/handlers/directoryhandlers |
Conversation | 2 | BroadcastMessageAdministrator
|
NA |
User with Mailbox | 2 | PHTransfer/PHGreeting | <object-id> which can be captured from /vmrest/users. |
Name | Call Action Value | Description |
---|---|---|
Ignore | 0 | Ignore - no action taken. |
Hangup | 1 | Hangup - the call is immediately terminated. |
Goto | 2 | Goto - go to an object such as a call handler, directory handler or interview handler. |
Error | 3 | Error - play the error greeting. |
TakeMsg | 4 | Take a message. |
SkipGreeting | 5 | Skip greeting. |
RestartGreeting | 6 | RestartGreeting - restart greeting on current handler |
TransferAltContact | 7 | Transfer to Alternate Contact Number |
RouteFromNextRule | 8 | Route From Next Call Routing Rule |
Explanation of Data Fields
Parameter | Operations | Data Type | Comments | |
---|---|---|---|---|
URI | Read Only | String | Interview Handler URI | |
Creation Time | Read Only | Datetime | Stores the time of creation of Interview Handler | |
Language | Read/Write | Integer | Stores code for language where valid values
range from 1024 to 58378 and 0 is not allowed. All possible language code
values can be fetched using
|
|
DisplayName | Read/Write | String (64) | Name of an interview handler | |
Undeletable | Read/Write | Boolean | A flag indicating whether this handler can
be deleted via an administrative application such as Cisco Unity Connection
Administration. It is used to prevent the deletion of factory defaults such as
the "Opening Greeting" call handler.
Possible values:
|
|
VoiceName | Read/Write | String (40) | The name of the .wav file containing the recorded audio of the name of an interview handler. | |
VoiceFileURI | Read Only | String | Specifies the URI of voice file. | |
VoiceNameURI | Read Only | String | Specifies the URI of voice name. | |
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 | |
SendUrgentMsg | Read/Write | Integer | A flag indicating whether an unidentified
caller is given a choice to mark a message as Urgent or Normal, or if not given
the choice, whether the message is always marked Normal (default value) or
Urgent.
Possible values :-
|
|
ObjectId | Read Only | String (36) | Object ID of interview handler. | |
TenantObjectId | Read Only | String (36) | The unique identifier of the tenant to which the interview handler belongs. This field is reflected in the response only if the interview handler belongs to a particular tenant. | |
RecipientDistributionListObjectId | Read/Write | String (36) | Object ID of distribution list if the recipient of interview handler is set to distribution list. | |
RecipientDistributionListURI | Read Only | String | URI of the distribution list. | |
RecipientSubscriberObjectId | Read/Write | String (36) | Object ID of the subscriber if the recipient of interview handler is set to a user. | |
RecipientSubscriberURI | Read/Write | String | URI of the subscriber. | |
AfterMessageAction | Read/Write | Integer | Possible types of call action to take,
e.g., hang-up, go to another object, etc.
Default value: 4 |
|
AfterMessageTargetConversation | Read/Write | String (64) | The name of the conversation used to set up, send, and retrieve messages. | |
AfterMessageTargetHandlerObjectId | Read/Write | String (36) | Specifies the URI of the target specified. | |
UseCallLanguage | Read/Write | Boolean | A flag indicating whether Cisco Unity
Connection will use the language assigned to the call.
Possible values:
Default value: true |
|
UseDefaultLanguage | Read/Write | Boolean | A flag that is dependent on the value of
Language Field. If Language is set to Null, UseDefaultLanguage is set to
true(1). If any language is specified, UseDefaultLanguage is set to false(0).
Default value: true. |
|
DispatchDelivery | Read/Write | Boolean | A flag indicating that all messages left
for the interview handler is for dispatch delivery.
Possible values:-
Default value: false |
|
PartitionObjectId | Read/Write | String (36) | The unique identifier of the Partition to which the InterviewHandler is assigned. | |
PartitionURI | Read Only | String | Specifies the partition URI. | |
InterviewQuestionsURI | Read Only | String | Specifies the URI of interview questions of an interview handler | |
DtmfAccessId | Read/Write | Integer | Specifies an extension number where minimum length can be 1 and maximum length can be 40. |