Using the Extensions Attribute
T-Server supports the use of the Extensions attribute as documented in the Genesys Events and Models Reference Manual and the Platform SDK 8 .NET (or Java) API Reference.
Additionally, the Extensions described in the following table are also supported.
Use of the Extensions Attribute
Extension | Used In | Description | |
---|---|---|---|
Key | Type | ||
ACCOUNT_CODE |
string or integer |
TPrivateService EventPrivateInfo |
The requested or reported account code. The key name of this Extensions attribute is defined by the accode-name configuration option. |
ReasonCode |
string or integer |
TAgentNotReady EventAgentNotReady |
When an account code is used as a Walk-Away code, this Extensions attribute specifies the requested or reported account code while the agent is in NotReady state. The default method of reporting the Not Ready activation information. |
NO_ANSWER_TIMEOUT |
string |
TRouteCall |
If set, the value of this Extensions attribute overrides any value set in any of the following configuration options for the current call: |
NO_ANSWER_ACTION |
string |
TRouteCall |
If set, the value of this Extensions attribute overrides any value set in any of the following configuration options for the current call: |
NO_ANSWER_OVERFLOW |
comma-separated list |
TRouteCall |
If set, the value of this Extensions attribute overrides any value set in any of the following configuration options for the current call: |
SUPERVISED_ROUTE |
string |
TRouteCall |
Overrides the value in the supervised-route-timeout configuration option for individual calls. |
ConvertOtherDN |
string or integer |
| |
EmulateLogin |
string |
TAgentLogin |
|
string |
EventAgentLogin |
If this option is set to a value of yes, it indicates that the T-Server has performed an emulated login. | |
WrapUpTime |
integer |
TAgentLogin |
Specifies the amount of emulated wrap-up time (in seconds) allocated to this agent at the end of a business call. This value is effective for the duration of this login's agent session. It can be overridden by the value in the WrapUpTime Extensions attribute in the TAgentNotReady request. |
integer |
TAgentNotReady |
Specifies the amount of emulated wrap-up time (in seconds) allocated to this agent at the end of a business call. This value is effective only for the lifespan of this request. | |
integer |
EventAgentNotReady |
Indicates the amount of emulated wrap-up time (in seconds) allocated to this agent at the end of a business call. | |
BusinessCall |
integer |
Call-related events |
Specifies the business type of a call. Valid values are:
|
BusinessCallType |
string or integer |
TMakeCall
TInitiateTransfer |
Specifies the call business type to be used by T-Server for the new call or the answering party. Valid values are:
|
AgentLogoutOnUnregister |
string |
TAgentLogin TRegisterAddress |
Specifies whether T-Server performs an automatic logout of an agent whenever their client application unregisters its DN from T-Server. Valid values are:
|
AssociateClientWithLogin |
boolean |
TAgentLogin TRegisterAddress |
Specifies whether the client should be associated with the agent session. |
boolean |
EventAgentLogin EventRegistered EventPrivateInfo |
Specifies that the client has been associated with the agent session. | |
AgentEmuLoginOnCall |
boolean |
TAgentLogin TAgentLogout |
Specifies whether T-Server allows an emulated agent login or logout from a device where there is a call in progress. |
LegalGuardTime |
integer |
TAgentLogin |
Specifies the amount of emulated legal guard time allocated to an agent at the end of a business call. |
SyncEmuACW |
integer |
TAgentLogin |
Specifies whether T-Server synchronizes emulated ACW and/or legal guard with the switch for native agents. |
ReleasingParty |
string |
EventReleased EventAbandoned |
Identifies which party was the initiator of the call release. Possible values are:
|
LinkLoad |
string |
EventRouteRequest |
A value of1 High indicates that T-Server is in a high watermark condition. The feature is disabled if the value of the use-link-bandwidth option is set to 0 (zero). Possible values are:
|
Association |
string |
TRegisterAddress |
Specifies the association that T-Server uses when a created DN is not specified in the configuration environment. T-Server uses the value of none (an empty string) when the Extensions attribute is not provided. |
SwitchSpecificType |
string or integer |
TRegisterAddress |
Specifies the switch-specific type that T-Server uses when a created DN is not specified in the configuration environment. T-Server verifies the combination switch device type/switch-specific type in the same manner as for a DN that is configured in the configuration environment. Note: The Disconnect Detection Protocol (DDP) is designed usually to accept unknown switch-specific types that are configured in the configuration environment by processing that type as type 0 (zero). An unknown switch-specific type for the T-Server value in the SwitchSpecificType Extensions attribute key is processed in the same way. |
sdn-licenses-in-use |
integer |
EventServerInfo |
Specifies how many SDN licenses are currently in use. |
sdn-licenses-available |
integer |
Specifies how many SDN licenses are currently available. | |
PICKUP |
string |
TMakeCall |
The value of the PICKUP Extensions attribute can be anything. If the Extensions attribute is present in the TMakeCall request, T-Server picks up the call ringing on the device specified by OtherDN attribute in the request. |
ASSIST |
string |
TInitiateConferece |
The value of the ASSIST Extensions attribute can be anything. An agent can add a supervisor to a call in order to receive assistance by passing the ASSIST Extensions attribute in either of the TInitiateConference or TInitiateTransfer requests and specifying the supervisor’s device as an OtherDN in the request. |
INTRUDE |
string |
TSingleStepConference |
The value of the INTRUDE Extensions attribute can be anything. A device can intrude on a call on another device by passing the INTRUDE Extensions attribute in a TSingleStepConference request and specifying in the OtherDN attribute the device with the call to be intruded on. |
OrigSV-n, NumOfOrigSVs |
string |
EventPartyChanged, EventPartyAdded |
Indicates the supervisors monitoring the main call in a transfer/conference scenario. The NumOfOrigSVs Extensions attribute indicates the number of supervisors listening to the main call. |
ConsultSV-n, NumOfConsultSVs |
string |
EventPartyChanged, EventPartyAdded |
Indicates the supervisors monitoring the consultation call in a transfer/conference scenario. The NumOfConsultSVs Extensions attribute indicates the number of supervisors listening to the consultation call. |
ReleaseController |
string or integer |
TReleaseCall (CSTA Clear Connection) |
Allows overriding the settings of the enable-controller-release configuration option.
|
RPDistributeType |
string (BWDistribute, BWTransfer) |
TRoutePointDistributeCall |
Specifies the method for routing from a Routing Point. If this Extensions attribute has a value of BWDistribute, that is supplied by T-Server, CSTA Connector uses a TPointDistributeCall request as the preferred method for routing from a Routing Point. A value of BWTransfer instructs CSTA Connector to use the blind transfer method for routing. Any other values for this Extensions attribute are ignored. See the enable-rp-distribute configuration option for more information. |