Class ContactService

Class to handling contact services

Hierarchy

ContactService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContactService(): ContactService

- Defined in agent-sdk/src/lib/acd/service/contact-service.ts:22
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 TRANSFER_WORK_ITEM_SKILL_TS

TRANSFER_WORK_ITEM_SKILL_TS: string = '/InContactAPI/services/v33.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>

- Defined in agent-sdk/src/lib/acd/service/contact-service.ts:92
Accept the incoming contact for consult
example
```
acceptConsultContact(23423423);
```
Parameters
- contactId: string
  
  contact id
Returns Promise<HttpResponse>

acceptContact

acceptContact(contactId: string): Promise<HttpResponse>

- Defined in agent-sdk/src/lib/acd/service/contact-service.ts:63
Accept the incoming contact
example
```
acceptContact(23423423);
```
Parameters
- contactId: string
  
  contact id
Returns Promise<HttpResponse>

activateContact

activateContact(contactId: string): Promise<HttpResponse>

- Defined in agent-sdk/src/lib/acd/service/contact-service.ts:34
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>

- Defined in agent-sdk/src/lib/acd/service/contact-service.ts:150
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>

- Defined in agent-sdk/src/lib/acd/service/contact-service.ts:308
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>

- Defined in agent-sdk/src/lib/acd/service/contact-service.ts:180
End the contact
example
```
endContact(23423423);
```
Parameters
- contactId: string
  
  contact id
Returns Promise<HttpResponse>

rejectContact

rejectContact(contactId: string): Promise<HttpResponse>

- Defined in agent-sdk/src/lib/acd/service/contact-service.ts:120
Reject the incoming contact
example
```
rejectContact(23423423);
```
Parameters
- contactId: string
  
  contact id
Returns Promise<HttpResponse>

sendLocalPostEventData

sendLocalPostEventData(customData: LocalPostEvent): Promise<unknown>

- Defined in agent-sdk/src/lib/acd/service/contact-service.ts:336
Method to send payload sent via local post event
example
- connectLocalPostapi(customData)
Parameters
- customData: LocalPostEvent
  
  contains an object containing port, path and payload
Returns Promise<unknown>
- API Returns Response JSON

transferWorkItemContact

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

- Defined in agent-sdk/src/lib/acd/service/contact-service.ts:221
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>

- Defined in agent-sdk/src/lib/acd/service/contact-service.ts:265
Method to transfer work item contact to a skill
example
```
transferWorkItemContact("123", "skill name");
```
Parameters
- contactId: string
- skillName: string
Returns Promise<HttpResponse>

Generated using TypeDoc