Message Settings API
Administrator can use this API to create and update the message settings. All the parameters for message settings are present in call handler.
|
From the above URI get the call handler URI:
|
Please Find below the combination of values to select language for a call handler: URI for timezone:
|
URI for installed Languages:
|
URI to get all language codes supported:
|
| UseCallLanguage | UseDefaultLanguage | Language | |
| Use System Default Language | false | true | NULL/LanguageCode |
| Inherit Language from Caller | true | true/false | NULL/LanguageCode |
| Particular Language | false | false | Language Code |
Listing Message Settings
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
|
Updating Message Settings
The following is an example of the PUT request that updates message settings:
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
JSON Example
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Updating after Message Actions
Example 1: Call Handler
|
|
The following is an example of the GET request that shows the call handler object ID:
GET https://<connection-server>/vmrest/handlers/callhandlersThe following is the response from the *PUT* request and the actual response will depend upon the information given by you:
|
Example 2: Interview Handler
|
The following is an example of the GET request that shows the interview handler template object ID:
|
The following is the response from the *PUT* request and the actual response will depend upon the information given by you:
|
Example 3: Directory Handler
|
The following is an example of the GET request that shows the interview handler template object ID:
|
The following is the response from the *PUT* request and the actual response will depend upon the information given by you:
|
Example 4: Conversation
Request Body: for broadcast message administrator
|
The following is the response from the *PUT* request for broadcast message administrator and the actual response will depend upon the information given by you:
|
Request Body: for caller system transfer
|
The following is the response from the *PUT* request for caller system transfer and the actual response will depend upon the information given by you:
|
Request Body: for greeting administrator
|
The following is the response from the *PUT* request for greeting administrator and the actual response will depend upon the information given by you:
|
For sign in
|
The following is the response from the *PUT* request for sign in and the actual response will depend upon the information given by you:
|
For system transfer:
|
The following is the response from the *PUT* request for user system transfer and the actual response will depend upon the information given by you:
|
JSON Example
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Explanation of Data Fields
| Parameter | Data Type | Operations | Comments |
|---|---|---|---|
| MaxMsgLen | Integer | Read/Write | The maximum recording length (in seconds)
for messages left by unidentified callers.
Default value : 300 Range: 1-3600 |
| EditMsg | Boolean | Read/Write | Allows callers to be prompted to listen to,
add to, rerecord, or delete their messages.
Values can be: • false: Callers cannot edit messages • true: Callers can edit messages Default value: true |
| UseDefaultLanguage | Boolean | Read/Write | Values can be:
Default value: true |
| UseCallLanguage | Boolean | Read/Write | This flag allows that language to be the
language used by handlers in the system to play prompts for users.
Values can be:
Default value: false |
| SendUrgentMsg | Integer | Read/Write | A flag indicating whether an unidentified
caller can mark a message as "urgent." Values can be:
Default Value: 0 |
| SendPrivateMsg | Integer | Read/Write | Determines if an outside caller can mark
their message as private.
Values can be:
Default Value: 0 |
| SendSecureMsg | Boolean | Read/Write | A flag indicating whether an unidentified
caller can mark a message as "secure."
Values can be:
Default Value: false |
| PlayAfterMessage | Integer | Read/Write | Indicates whether the Sent Message Prompt
Recording referenced by Post Greeting
Values can be:
Default value: 0 |
| AfterMessageAction | Integer | Read/Write | AfterMessageAction can only accept integer
with the following values:
|
| AfterMessageTargetHandlerObjectId | String(36) | Read/Write | The unique identifier of the specific object to send along to the target conversation. |
| AfterMessageTargetConversation | String(64) | Read/Write | The name of the conversation to which the caller is routed. |
| Language | Integer | Read/Write | The Windows Locale ID (LCID) that identifies the language that Cisco Unity Connection plays for system prompts |
Feedback