As of Friday October 16th, access to restricted content on this site now requires you to log in with your Genesys account. If you don't have an account, you can request one at these locations: Request MyPartner Portal Account or Request My Support Account.
Jump to: navigation, search

Agent Namespace


The Agent namespace includes the following methods:


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


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


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


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

Type Definitions

The agent namespace includes the following object types:


Description Represents the JSON structure of the agent.
Type Object
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.
roles Array.<string> An array of the agent's roles. Possible roles are:
  • ROLE_AGENT — mandatory for users of Workspace Web Edition
  • ROLE_SUPERVISOR — enables users to perform supervisor operations like monitoring.
  • ROLE_ADMIN — provides administrator access to the Genesys Web Services API.
This page was last edited on March 28, 2016, at 15:09.


Comment on this article:

blog comments powered by Disqus