Difference between revisions of "PEC-Developer/Current/SCAPI/AgentNamespace"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2")
(Published)
Line 6: Line 6:
 
|ComingSoon=No
 
|ComingSoon=No
 
|Platform=GenesysEngage-cloud
 
|Platform=GenesysEngage-cloud
−
|Prereq=
 
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Methods
 
|sectionHeading=Methods
 
|anchor=Methods
 
|anchor=Methods
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|structuredtext=The Agent namespace includes the following methods:
 
|structuredtext=The Agent namespace includes the following methods:
  
Line 23: Line 20:
 
{{{!}}
 
{{{!}}
 
!Signature
 
!Signature
−
{{!}}<static> get() → {{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=Agent|display text=agent.Agent}}}
+
{{!}}<static> get() → &#123;{{Link-SomewhereInThisVersion|manual=SCAPI|topic=AgentNamespace|anchor=Agent|display text=agent.Agent}}&#125;
 
{{!}}-
 
{{!}}-
 
!Description
 
!Description
Line 35: Line 32:
 
{{{!}}
 
{{{!}}
 
!Signature
 
!Signature
−
{{!}}<static> getState() → {{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}}
+
{{!}}<static> getState() → &#123;{{Link-SomewhereInThisManual|topic=MediaNamespace|anchor=State|display text=media.State}}&#125;
 
{{!}}-
 
{{!}}-
 
!Description
 
!Description
Line 76: Line 73:
 
{{!}}}
 
{{!}}}
 
{{!}}}
 
{{!}}}
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 83: Line 78:
 
|anchor=TypeDefinitions
 
|anchor=TypeDefinitions
 
|alignment=Vertical
 
|alignment=Vertical
−
|Media=
 
−
|image=
 
 
|structuredtext=The agent namespace includes the following object types:
 
|structuredtext=The agent namespace includes the following object types:
  
 
*{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=Agent|display text=Agent}}
 
*{{Link-SomewhereInThisManual|topic=AgentNamespace|anchor=Agent|display text=Agent}}
−
 
+
{{AnchorDiv|Agent}}
 
===Agent===
 
===Agent===
 
{{{!}}
 
{{{!}}
Line 121: Line 114:
 
{{!}}}
 
{{!}}}
 
{{!}}}
 
{{!}}}
−
|structuredtextwide=
 
−
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 14:02, March 2, 2022

This topic is part of the manual Service Client API Reference for version Current of Developer.

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() → {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.
Retrieved from "https://all.docs.genesys.com/PEC-Developer/Current/SCAPI/AgentNamespace (2025-07-23 02:21:35)"
Comments or questions about this documentation? Contact us for support!