Class BriaClientCall

Hierarchy

default<CallEvents>
- BriaClientCall

Index

Constructors

constructor

new BriaClientCall(client: BriaClient): BriaClientCall

Overrides default.constructor
- Defined in client/Call.ts:279
Parameters
- client: BriaClient
Returns BriaClientCall

Events

callEnd

callEnd(call: BriaCall, id: string): Promise<void> | void

Parameters
- call: BriaCall
- id: string
Returns Promise<void> | void

callStart

callStart(call: BriaCall, id: string): Promise<void> | void

Parameters
- call: BriaCall
- id: string
Returns Promise<void> | void

callUpdate

callUpdate(call: BriaCall, id: string): Promise<void> | void

Parameters
- call: BriaCall
- id: string
Returns Promise<void> | void

optionsUpdated

optionsUpdated(): Promise<void> | void

Returns Promise<void> | void

Properties

calls

calls: BriaCall[] = []

Optional options

options?: CallOptions

Methods

answerCall

answerCall(callId: string): Promise<XML>

- Defined in client/Call.ts:363
Answer a call

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getAnswer

Parameters
- callId: string
Returns Promise<XML>

attendedTransfer

attendedTransfer(callId: string, target: string): Promise<XML>

- Defined in client/Call.ts:448
Request an attended transfer

On Bria versions <6.2.0 this call will throw an exception

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#startAttendedTransferCall

Parameters
- callId: string
- target: string
Returns Promise<XML>

blindTransferByCallId

blindTransferByCallId(callId: string, targetCallId: string): Promise<XML>

- Defined in client/Call.ts:434
Request a blind transfer by callId

On Bria versions <6.2.0, both blindTransferByNumber and and blindTransferByCallId act functionally identical.

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getTransferCall

Parameters
- callId: string
- targetCallId: string
Returns Promise<XML>

blindTransferByNumber

blindTransferByNumber(callId: string, targetNumber: string): Promise<XML>

- Defined in client/Call.ts:419
Request a blind transfer by number

On Bria versions <6.2.0, both blindTransferByNumber and and blindTransferByCallId act functionally identical.

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getTransferCall

Parameters
- callId: string
- targetNumber: string
Returns Promise<XML>

endCall

endCall(callId: string): Promise<XML>

- Defined in client/Call.ts:372
End a call

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getEndCall

Parameters
- callId: string
Returns Promise<XML>

getCallOptions

getCallOptions(): Promise<CallOptions>

- Defined in client/Call.ts:471
Get call options

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getStatusCallOptions

Returns Promise<CallOptions>

getCalls

getCalls(): Promise<BriaCall[]>

- Defined in client/Call.ts:338
Get static list of calls

Instead of using this method, you should access client.call.calls, this method is used when Bria posts a call update event internally

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getStatusCall

Returns Promise<BriaCall[]>

holdCall

holdCall(callId: string): Promise<XML>

- Defined in client/Call.ts:381
Place call on hold

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getHold

Parameters
- callId: string
Returns Promise<XML>

mergeCall

mergeCall(callId: string): Promise<XML>

- Defined in client/Call.ts:461
Merge calls into local conference

This call will not provide any error if call ID is invalid

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#Merge

Parameters
- callId: string
  
  This call should not be on hold.
Returns Promise<XML>

placeCall

placeCall(call: Call): Promise<XML>

- Defined in client/Call.ts:354
Place a call

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getCall

Parameters
- call: Call
Returns Promise<XML>

populate

populate(): Promise<void>

Overrides default.populate
- Defined in client/Call.ts:287
Returns Promise<void>

resumeCall

resumeCall(callId: string): Promise<XML>

- Defined in client/Call.ts:390
Resume call that was on hold

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getResume

Parameters
- callId: string
Returns Promise<XML>

sendDTMF

sendDTMF(digit: number | DTMFDigit, type: DTMFType): Promise<XML>

- Defined in client/Call.ts:400
Send a DTMF tone to the call recipient

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getDTMF

Parameters
- digit: number | DTMFDigit
- type: DTMFType
  
  start/stop
Returns Promise<XML>

setCallOptions

setCallOptions(options: Partial<CallOptions>): Promise<XML>

- Defined in client/Call.ts:490
Set call options

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiHandlingCalls.htm#getCallOptions

Parameters
- options: Partial<CallOptions>
  
  Partial call options
Returns Promise<XML>

startCallRecording

startCallRecording(callId: string, filename: string, suppressPopup?: boolean): Promise<XML>

- Defined in client/Call.ts:501
Start a call recording

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiRecording.htm#Start

Parameters
- callId: string
- filename: string
  
  Do not include extension, Bria includes it automatically
- suppressPopup: boolean = false
  
  Show call recording popup when ended
Returns Promise<XML>

stopCallRecording

stopCallRecording(callId?: string): Promise<XML>

- Defined in client/Call.ts:516
Stop a call recording

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiRecording.htm#Stop

Parameters
- Optional callId: string
  
  If null, call recording is stopped for the current live call
Returns Promise<XML>

Generated using TypeDoc