| Layer | Agent |
| Direction | To CallGem |
| Type of Service | CG |
| Interface ID | AG |
| Message Purpose | This message requests CallGem to log an agent into a campaign |
| Example | AL\CNCustCare\AN2\ADTom\TEBobbie-Jo\AE1522 |
| Explanation | The agent application assigns Tom to work on Bobbie-Jo's team on the CustCare campaign, with the Agent Identification Number 2. CallGem is also being advised Tom's extension identifier, 1522, which is required when the telephony layer is directly managing the connection with the switch (i.e. there is a split API). |
| Notes |
An agent may be logged into a campaign when it is both open and also suspended, but
not when it is closed. If the request is successful CallGem will respond with a
Logged In [LI] message
See
Agent Work Flow |
| Parameters | ||||||
|---|---|---|---|---|---|---|
| Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
| AA | AutoAccept | boolean | false | 0 | 0 | This Parameter indicates to CallGem that the specified agent will ALWAYS accept a transfer. |
| AD | AgentDescription | string | false | 1 | 80 | Typically a name. Must be unique across all open campaigns. When operating in Multi-Tenancy, must be unique within tenant. |
| AE | AgentExtensionIdentifier | string | true | 1 | 120 | Required by the telephony layer to give each agent extension a unique identifier. If not passed, the first agent endpoint login will default its extension address from the user configuration. |
| AN | AgentIdentifier | string | true | 1 | 80 | User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ; |
| AW | AutoWrap | boolean | false | 0 | 0 | This parameter enables automatic generation of the TC message when the agent is logged into a predictive campaign. |
| CN | CampaignName | string | true | 1 | 80 | User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ; |
| CR | CallRecording | boolean | false | 0 | 0 | This parameter enables recording for the agent. By default CR is disabled. |
| LN | LicenseToken | string | false | 1 | 80 | This parameter is reserved for Sytel's use |
| NU | NailedUp | boolean | false | 0 | 0 | This parameter indicates that the agent will be nailed-up. |
| PL | ProxyLogin | boolean | false | 0 | 0 | From V10.6.244 - This parameter is used to indicate that the sender is issuing this login request as a proxy. This will mean all events relating to this agent will be consumed silently. |
| QI | UserIdentifier | string | false | 1 | 80 | From V10.7.28 - Identifies this endpoint login as part of a User session. If the User identifier ID is specified, CallGem will treat this as a request to add this endpoint to the user session. User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ; |
| SI | SessionIdentifier | string | false | 1 | 120 | The Session Identifier of the call whose customer connection should be used as the new agent. |
| TD | TenantDescriptor | string | false | 1 | 80 | The tenant that this agent is logging on to. If not passed, the default tenant is assumed. Agent identifiers and addresses must be unique within the scope of a tenant. |
| TE | Team | string | false | 1 | 80 | Agents may be allocated to teams (for subsequent CallGem reporting). Even though this parameter is optional, if you are going to offer users access to Softdial Reporter™ 5 we strongly advise you to implement this parameter. |
| TK | Token | string | false | 1 | 80 | Token parameter |
| VA | VirtualAgent | boolean | false | 0 | 0 | This parameter indicates that the agent is a virtual agent. |