VoiceControlService | nice-cxone-acd-agent-apps

Class to handling voice controls

Hierarchy

VoiceControlService

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new VoiceControlService(): VoiceControlService

example

const voiceControlSvc = new VoiceControlService();

Returns VoiceControlService

Properties

Private acdSession

acdSession: ACDSessionManager = ...

logger

logger: Logger = ...

Protected utilService

utilService: HttpUtilService = ...

Methods

endContact

endContact(contactId: string): Promise<HttpResponse>

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

holdContact

holdContact(contactId: string): Promise<HttpResponse>

Method to hold the active contact
example
```
holdContact(123);
```
Parameters
- contactId: string
  
  Active contactId
Returns Promise<HttpResponse>

maskCall

maskCall(contactId: string): Promise<HttpResponse>

Method to mask a call
example
```
maskCall(contactId);
```
Parameters
- contactId: string
  
  contact Id
Returns Promise<HttpResponse>

muteAgent

muteAgent(): Promise<HttpResponse>

Method to mute the agent
example
```
muteAgent();
```
Returns Promise<HttpResponse>

playVoiceMail

playVoiceMail(contactId: string, playTimeStamp: boolean, position: number): Promise<HttpResponse>

This method will play a voicemail contact audio at the specified position
example
```
playVoiceMail(23423423, true, 50);
```
Parameters
- contactId: string
  
  contact id
- playTimeStamp: boolean
  
  Include date/time in audio playback
- position: number
  
  Position of the wav file at a specified second
Returns Promise<HttpResponse>

recordCall

recordCall(contactId: string): Promise<HttpResponse>

Method to record a call
example
```
recordCall(contactId);
```
Parameters
- contactId: string
  
  contact Id
Returns Promise<HttpResponse>

resumeContact

resumeContact(contactId: string): Promise<HttpResponse>

Method to resume the holding contact
example
```
resumeContact(123);
```
Parameters
- contactId: string
  
  holding contactId
Returns Promise<HttpResponse>

transferVoicemailContact

transferVoicemailContact(contactId: string, agentId: string): Promise<HttpResponse>

Method to transfer voicemail
example
```
transferVoicemailContact("123", "234");
```
Parameters
- contactId: string
- agentId: string
Returns Promise<HttpResponse>

unmaskCall

unmaskCall(contactId: string): Promise<HttpResponse>

Method to stop masking a call
example
```
unmaskCall(contactId);
```
Parameters
- contactId: string
  
  contact Id
Returns Promise<HttpResponse>

unmuteAgent

unmuteAgent(): Promise<HttpResponse>

Method to unmute the agent
example
```
unmuteAgent();
```
Returns Promise<HttpResponse>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns VoiceControlService

Properties

Private acdSession

logger

Protected utilService

Methods

endContact

Parameters

contactId: string

Returns Promise<HttpResponse>

holdContact

Parameters

contactId: string

Returns Promise<HttpResponse>

maskCall

Parameters

contactId: string

Returns Promise<HttpResponse>

muteAgent

Returns Promise<HttpResponse>

playVoiceMail

Parameters

contactId: string

playTimeStamp: boolean

position: number

Returns Promise<HttpResponse>

recordCall

Parameters

contactId: string

Returns Promise<HttpResponse>

resumeContact

Parameters

contactId: string

Returns Promise<HttpResponse>

transferVoicemailContact

Parameters

contactId: string

agentId: string

Returns Promise<HttpResponse>

unmaskCall

Parameters

contactId: string

Returns Promise<HttpResponse>

unmuteAgent

Returns Promise<HttpResponse>