Transfer Rule API
First get the call handler URI of a particular user: GET
|
From call handler URI get for transfer options: GET
|
For alternate transfer rule: GET
|
For closed transfer rule: GET
|
For Standard transfer rule: GET
|
Listing All Transfer Rules
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Viewing the Alternate Transfer Rule
The following is an example of the GET request that lists the details of alternate transfer rule:
|
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 alternate transfer rule, 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:
|
|
Updating Transfer Option
The following is an example of the PUT request that updates the transfer option:
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
JSON Example
To update the transfer rule, 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:
|
Explanation of Data Fields
Parameter | Data Type | Operations | Comments |
---|---|---|---|
TransferOptionType | String(64) | Read Only | The type of transfer option, e.g. "Standard," "Off Hours," or "Alternate." |
Enabled | Boolean | Read/Write | To enable transfer rules.
Possible values:
Default value: false |
TimeExpires | DateTime | Read/Write | The date and time when this transfer option expires. If the transfer rule is enabled, the value is NULL or a date in the future. If the transfer rule is disable, the value is a past date. |
Actions | Integer | Read/Write | A flag indicating whether Cisco Unity Connection transfers the call to the call handler greeting or attempts to transfer the
call to an extension.
Values can be:
|
TransferType | Integer | Read/Write | The type of call transfer Cisco Unity Connection will perform - supervised or unsupervised (also referred to as "Release to
Switch" transfer).
Values:
|
TransferRings | Integer | Read/Write | The number of times the extension rings before Cisco Unity Connection considers it a "ring no answer" and plays the subscriber
or handler greeting.
Applies only when the "TransferType" column is set to supervised (1). This value should never be less than 2 for a supervised transfer. Possible Values: 2-20 Default value: 4 |
PlayTransferPrompt | Boolean | Read/Write | Enables "Wait While I Transfer Your Call" Prompt.
Values:
Default value: true |
TransferHoldingMode | Integer | Read/Write | The action Cisco Unity Connection will take when the extension is busy.
Applies only when the "TransferType" column is set to supervised (1). Values:
|
TransferAnnounce | Boolean | Read/Write | A flag indicating whether Cisco Unity Connection plays "transferring call" when the subscriber answers the phone.
Requires a "TransferType" of supervised (1). Values:
Default value: false |
TransferIntroduce | Boolean | Read/Write | A flag indicating whether Cisco Unity Connection will say "call for <recorded name of the call handler>" when the subscriber
answers the phone.
Requires a "TransferType" of supervised (1). This functionality is normally used when a single extension number is being shared by multiple subscribers or a scenario where the subscriber who is the message recipient takes calls for more than one dialed extension. The introduction alerts the subscriber who answers that the call is for the call handler. Default value: false |
TransferConfirm | Boolean | Read/Write | A flag indicating whether Cisco Unity Connection prompts the subscriber to accept or refuse a call ("Press 1 to take the call
or 2 and I'll take a message"). If the call is accepted, it is transferred to the subscriber phone. If the call is refused,
Cisco Unity Connection plays the applicable subscriber greeting.
Requires a "TransferType" of supervised (1). Typically this is used in conjunction with the call screening option ("TransferScreening" column) enabled. This combination enables the subscriber to hear the name of the caller and then decide if they want to take the call or not. Values:
Default value: false |
TransferScreening | Boolean | Read/Write | Requires a "TransferType" of supervised (1).
Normally this column is used along with "TransferConfirm" to allow the subscriber to screen calls. Values:
Default value: false |