Agent namespace

Learn about the Agent namespace methods and type definitions in the Service Client API.

Methods

The Agent namespace includes the following methods:

• get
• getState
• getStateList
• setState

get

Signature	<static> get() → {agent.Agent}
Description	Gets the agent's attributes.
Returns	agent.Agent

getState

Signature	<static> getState() → {media.State}
Description	Gets the agent's state.
Returns	media.State

getStateList

Signature	<static> getStateList() → {Array.<media.State>}
Description	Gets the list of possible agent states.
Returns	Array.<media.State>

setState

Signature	<static> setState(stateOperationName)
Description	Sets the agent's state.
Parameters	Name Type Description stateOperationName string An operationName from the agent states list. See State.

Type definitions

The agent namespace includes the following object types:

• Agent

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.