Learn about the Agent namespace methods and type definitions in the Service Client API.
Methods
The Agent namespace includes the following methods:
get
| Signature
|
<static> get(succeeded, failed) → {agent.Agent}
|
| Description
|
Gets the agent's attributes.
|
| Parameters
|
| Name
|
Type
|
Description
|
| succeeded
|
function
|
A function called when the operation succeeds.
|
| failed
|
function
|
A function called when the operation fails.
|
|
| Returns
|
agent.Agent
|
getState
| Signature
|
<static> getState(succeeded, failed) → {media.State}
|
| Description
|
Gets the agent's state.
|
| Parameters
|
| Name
|
Type
|
Description
|
| succeeded
|
function
|
A function called when the operation succeeds.
|
| failed
|
function
|
A function called when the operation fails.
|
|
| Returns
|
media.State
|
getStateList
| Signature
|
<static> getStateList(succeeded, failed) → {Array.<media.State>}
|
| Description
|
Gets the list of possible agent states.
|
| Parameters
|
| Name
|
Type
|
Description
|
| succeeded
|
function
|
A function called when the operation succeeds.
|
| failed
|
function
|
A function called when the operation fails.
|
|
| Returns
|
Array.<media.State>
|
setState
| Signature
|
<static> setState(stateOperationName, succeeded, failed)
|
| Description
|
Sets the agent's state.
|
| Parameters
|
| Name
|
Type
|
Description
|
| stateOperationName
|
string
|
An operationName from the agent states list. See State.
|
| succeeded
|
function
|
A function called when the operation succeeds.
|
| failed
|
function
|
A function called when the operation fails.
|
|
Type definitions
The agent namespace includes the following object types:
Agent
| Description
|
Represents the JSON structure of the agent.
|
| Type
|
Object
|
| Properties
|
| Name
|
Type
|
Description
|
| employeeId
|
string
|
The agent's unique identifier used for routing purposes.
|
| firstname
|
string
|
The agent's first name.
|
| lastname
|
string
|
The agent's last name.
|
| username
|
string
|
The agent's username. This is a global unique ID.
|
|
