SET_AGENT_STATE_REQ
The SET_AGENT_STATE_REQ message, defined in the following tables, allows a client to change an ACD agent’s state.
|
Fixed part Field name |
Value |
Data type |
Byte size |
|---|---|---|---|
|
InvokeID |
A unique ID generated by the CTI client for each request message. This ID is returned in the corresponding confirmation message. |
UINT |
4 |
|
reserved |
Set this value to 1. |
UINT |
4 |
|
AgentState |
The value representing the current state of the associated agent (see Table 1). |
USHORT |
2 |
|
reserved |
Set this value to 0. |
USHORT |
2 |
|
reserved |
Set this value to 0. |
USHORT |
2 |
|
EventReasonCode |
A Unified CCX code indicating the reason for the agent state change (see Table 1). |
USHORT |
2 |
|
ForcedFlag |
Unified CCX is requested to force this state change regardless of its validity. Used only with AGENT_STATE_LOGIN or AGENT_STATE_LOGOFF: 0: FALSE 1: TRUE 2: Agent authentication only. No agent state change. Use with AGENT_STATE_LOGIN (Version 12) |
UCHAR |
1 |
|
AgentCapacity[Version 12] |
Specifies the agent capacity. 0x1: Outbound feature enabled |
UINT |
4 |
|
Floating part Field name |
Value |
Data type |
Maximum size |
|---|---|---|---|
|
AgentInstrument[6] (required) |
The agent’s IP phone number. |
STRING |
64 |
|
AgentPassword[49] (optional) |
The password that allows an agent to log into a CSQ. This field is required when AgentState is AGENT_STATE_LOGIN. |
STRING |
64 |
|
AgentID[194] |
The agent’s Unified CCX login ID. This field is required when the AgentState is AGENT_STATE_LOGIN or AGENT_STATE_LOGOFF. |
STRING |
129 |
|
ActiveTerminal[303] (Version 18 and later) |
This field contains the device name of the selected terminal by the agent if Unified CCX complies with the following conditions:
|
STRING |
64 |