Jump to: navigation, search
(Created target blank page For Version: HTCC:9.0.0DRAFT)
 
 
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
= Agent Namespace=
 +
{{NoteFormat|The content on this page is no longer updated. To find the latest content, go to [https://all.docs.genesys.com/PEC-Developer/Current/SCAPI/AgentNamespace Agent namespace].}}
 +
__TOC__
 +
==Methods==
 +
The Agent namespace includes the following methods:
 +
* [[AgentNamespace#get|get]]
 +
* [[AgentNamespace#getState|getState]]
 +
* [[AgentNamespace#getStateList|getStateList]]
 +
* [[AgentNamespace#setState|setState]]
 +
 
 +
===get===
 +
{|
 +
! Signature
 +
| <static> get() → {[[AgentNamespace#Agent|agent.Agent]]}
 +
|-
 +
! Description
 +
| Gets the agent's attributes.
 +
|-
 +
! Returns
 +
| [[AgentNamespace#Agent|agent.Agent]]
 +
|}
 +
 
 +
===getState===
 +
{|
 +
! Signature
 +
| <static> getState() → {[[MediaNamespace#State|media.State]]}
 +
|-
 +
! Description
 +
| Gets the agent's state.
 +
|-
 +
! Returns
 +
| [[MediaNamespace#State|media.State]]
 +
|}
 +
 
 +
===getStateList===
 +
{|
 +
! Signature
 +
| <static> getStateList() → {Array.<[[MediaNamespace#State|media.State]]>}
 +
|-
 +
! Description
 +
| Gets the list of possible agent states.
 +
|-
 +
! Returns
 +
| Array.<[[MediaNamespace#State|media.State]]>
 +
|}
 +
 
 +
===setState===
 +
{|
 +
! Signature
 +
| <static> setState(''stateOperationName'')
 +
|-
 +
! Description
 +
| Sets the agent's state.
 +
|-
 +
! Parameters
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| stateOperationName
 +
| string
 +
| An <tt>operationName</tt> from the agent states list. See [[MediaNamespace#State|State]].
 +
|}
 +
|}
 +
 
 +
==Type Definitions==
 +
The agent namespace includes the following object types:
 +
* [[AgentNamespace#Agent|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.
 +
|-
 +
| roles
 +
| Array.<string>
 +
| An array of the agent's roles. Possible roles are:
 +
* ROLE_AGENT &mdash; mandatory for users of Workspace Web Edition
 +
* ROLE_SUPERVISOR &mdash; enables users to perform supervisor operations like monitoring.
 +
* ROLE_ADMIN &mdash; provides administrator access to the [[Documentation:HTCC:API:Welcome|Genesys Web Services API]].
 +
|}
 +
|}
 +
 
 +
 
 +
[[Category:V:HTCC:9.0.0DRAFT]]

Latest revision as of 16:58, February 1, 2022

Agent Namespace

Important
The content on this page is no longer updated. To find the latest content, go to Agent namespace.

Methods

The Agent namespace includes the following methods:

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

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.
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 February 1, 2022, at 16:58.
Comments or questions about this documentation? Contact us for support!