ContactService | nice-cxone-acd-agent-apps

Class to handling contact services

Hierarchy

ContactService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContactService(): ContactService

example

const contactSvc = new ContactService();

Returns ContactService

Properties

Private TRANSFER_WORK_ITEM_SKILL

TRANSFER_WORK_ITEM_SKILL: string = '/InContactAPI/services/v23.0/agent-sessions/{sessionId}/interactions/{contactId}/transfer-work-item-to-skill'

Private acdSession

acdSession: ACDSessionManager = ...

logger

logger: Logger = ...

Protected utilService

utilService: HttpUtilService = ...

Methods

acceptConsultContact

acceptConsultContact(contactId: string): Promise<HttpResponse>

Accept the incoming contact for consult
example
```
acceptConsultContact(23423423);
```
Parameters
- contactId: string
  
  contact id
Returns Promise<HttpResponse>

acceptContact

acceptContact(contactId: string): Promise<HttpResponse>

Accept the incoming contact
example
```
acceptContact(23423423);
```
Parameters
- contactId: string
  
  contact id
Returns Promise<HttpResponse>

activateContact

activateContact(contactId: string): Promise<HttpResponse>

Used to set the contact status to active
example
```
activateContact(23423423);
```
Parameters
- contactId: string
  
  contact id
Returns Promise<HttpResponse>

amdOverride

amdOverride(contactId: string, type: amdOverrideType): Promise<HttpResponse>

Override AMD
example
```
amdOverride(23423423, 'answeringMachine')
```
Parameters
- contactId: string
  
  contact id
- type: amdOverrideType
  
  'answeringMachine' | 'faxMachine' | 'badMachine'
Returns Promise<HttpResponse>

answeringMachineOverride

answeringMachineOverride(contactId: string, type: amdOverrideType): Promise<HttpResponse>

This method to override answering machine. This should be used when a call is in active state
example
```
answeringMachineOverride(23423423)
```
Parameters
- contactId: string
  
  contact id
- type: amdOverrideType
  
  'faxMachine' | 'badNumber'
Returns Promise<HttpResponse>

endContact

endContact(contactId: string): Promise<HttpResponse>

End the contact
example
```
endContact(23423423);
```
Parameters
- contactId: string
  
  contact id
Returns Promise<HttpResponse>

rejectContact

rejectContact(contactId: string): Promise<HttpResponse>

Reject the incoming contact
example
```
rejectContact(23423423);
```
Parameters
- contactId: string
  
  contact id
Returns Promise<HttpResponse>

transferWorkItemContact

transferWorkItemContact(contactId: string, agentUserName: string): Promise<HttpResponse>

Method to transfer work item contact
example
```
transferWorkItemContact("123", "234");
```
Parameters
- contactId: string
- agentUserName: string
Returns Promise<HttpResponse>

transferWorkItemSkill

transferWorkItemSkill(contactId: string, skillName: string): Promise<HttpResponse>

Method to transfer work item contact to a skill
example
```
transferWorkItemContact("123", "skill name");
```
Parameters
- contactId: string
- skillName: string
Returns Promise<HttpResponse>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ContactService

Properties

Private TRANSFER_WORK_ITEM_SKILL

Private acdSession

logger

Protected utilService

Methods

acceptConsultContact

Parameters

contactId: string

Returns Promise<HttpResponse>

acceptContact

Parameters

contactId: string

Returns Promise<HttpResponse>

activateContact

Parameters

contactId: string

Returns Promise<HttpResponse>

amdOverride

Parameters

contactId: string

type: amdOverrideType

Returns Promise<HttpResponse>

answeringMachineOverride

Parameters

contactId: string

type: amdOverrideType

Returns Promise<HttpResponse>

endContact

Parameters

contactId: string

Returns Promise<HttpResponse>

rejectContact

Parameters

contactId: string

Returns Promise<HttpResponse>

transferWorkItemContact

Parameters

contactId: string

agentUserName: string

Returns Promise<HttpResponse>

transferWorkItemSkill

Parameters

contactId: string

skillName: string

Returns Promise<HttpResponse>