AgentStateResponse | nice-cxone-acd-agent-apps

Model class for agent state

Hierarchy

CXoneEvent
- AgentStateResponse

Constructors

constructor

new AgentStateResponse(): AgentStateResponse

Inherited from CXoneEvent.constructor
Returns AgentStateResponse

Properties

agentId

agentId: number

remarks: ID of Agent

agentStateName

agentStateName: string

remarks: Name of state for the Agent

canDialAgent

canDialAgent: boolean

remarks: Represents whether agent can be dialed or not

canDirectTransferVoicemail

canDirectTransferVoicemail: boolean

remarks: Represents whether agent can be direct transfered a voicemail or not

contactId

contactId: string

remarks: ID of active Contact if any

email

email: string = null

remarks: Email address of Agent

firstName

firstName: string

remarks: Agent first name

isActive

isActive: boolean

remarks: Indicates if agent is in ACTIVE state

isAttendantUser

isAttendantUser: boolean

remarks: Represents whether agent is Attendant user or not

isFavorite

isFavorite: boolean

remarks: Represents whether agent is marked as favorite or not on UI

isOutbound

isOutbound: boolean

remarks: Indicates if active Contact is using an outbound Skill

lastName

lastName: string

remarks: Agent last name

lastPollTime

lastPollTime: Date

remarks: ISO 8601 timestamp of last database poll. Value should be passed in "updatedSince" parameter on next call

lastUpdateTime

lastUpdateTime: Date

remarks: Time of last record update

mediaName

mediaName: string

remarks: Channel name of Contact if any

outStateCode

outStateCode: number

remarks: ID for Unavailable state

outStateDescription

outStateDescription: string

remarks: Name of Unavailable state

skillId

skillId: string

remarks: ID of Skill Agent is working on

skillName

skillName: string

remarks: Name of Skill Agent is working on

startDate

startDate: Date

remarks: ISO 8601 time the Agent started on current Skill

stationPhoneNumber

stationPhoneNumber: number

remarks: Agent Phone for current session

teamId

teamId: number

remarks: ID of Agent Team

teamName

teamName: string

remarks: Name of Agent Team

unavailableStateName

unavailableStateName: string

remarks: Name of Unavailable state from updated agent-state API

userId

userId: string

remarks: userId of Agent

userName

userName: string

remarks

Methods

parse

parse(data: {}): void

Overrides CXoneEvent.parse
- Defined in common-sdk/src/lib/model/agent-state-response.ts:164
This method to parse agent state response
example
```
parse(data);
```
Parameters
- data: {}
  
  agent state object
  - [key: string]: string
Returns void

parseUpdatedAgentState

parseUpdatedAgentState(data: {}): void

- Defined in common-sdk/src/lib/model/agent-state-response.ts:200
This method to parse agent state response from the new API with updated agent state
example
```
parseUpdatedAgentState(data);
```
Parameters
- data: {}
  
  new agent state object
  - [key: string]: string
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns AgentStateResponse

Properties

agentId

agentStateName

canDialAgent

canDirectTransferVoicemail

contactId

email

firstName

isActive

isAttendantUser

isFavorite

isOutbound

lastName

lastPollTime

lastUpdateTime

mediaName

outStateCode

outStateDescription

skillId

skillName

startDate

stationPhoneNumber

teamId

teamName

unavailableStateName

userId

userName

Methods

parse

Parameters

data: {}

[key: string]: string

Returns void

parseUpdatedAgentState

Parameters

data: {}

[key: string]: string

Returns void