JSDoc: Class: TelephonyConnector

Constructor

new TelephonyConnector()

Source:

types.js, line 1077

Methods

acceptCall(call) → {Promise.<CallResult>}

Accept call

Parameters:

Name	Type	Description
`call`	PhoneCall	The call to be accepted

Source:

types.js, line 1093

Returns:

Type: Promise.<CallResult>

addParticipant(contact:, parentCall:, isBlindTransfer:) → {Promise.<ParticipantResult>}

Add participant to call

Parameters:

Name	Type	Description
`contact:`	Contact	The transfer target
`parentCall:`	PhoneCall	The call to which a participant will be added
`isBlindTransfer:`	Boolean	True if blind transfering a call and hanging up upon transfer

Source:

types.js, line 1212

Returns:

Type: Promise.<ParticipantResult>

conference(calls) → {Promise.<HoldToggleResult>}

Conference calls

Parameters:

Name	Type	Description
`calls`	Array.<PhoneCall>

Source:

types.js, line 1201

Returns:

Type: Promise.<HoldToggleResult>

declineCall(call) → {Promise.<CallResult>}

Decline call

Parameters:

Name	Type	Description
`call`	PhoneCall	The call to be declined

Source:

types.js, line 1103

Returns:

Type: Promise.<CallResult>

dial(contact, dialOptions) → {Promise.<CallResult>}

Dial out Number

Parameters:

Name	Type	Description
`contact`	Contact
`dialOptions`	DialOptions

Source:

types.js, line 1165

Returns:

Type: Promise.<CallResult>

endCall(call, agentStatus) → {Promise.<HangupResult>}

End call

Parameters:

Name	Type	Description
`call`	PhoneCall	The call to be ended
`agentStatus`	AGENT_STATUS

Source:

types.js, line 1114

Returns:

Type: Promise.<HangupResult>

getActiveCalls() → {Promise.<ActiveCallsResult>}

Get the currently active calls

Source:

types.js, line 1083

Returns:

Type: Promise.<ActiveCallsResult>

getAgentConfig() → {Promise.<AgentConfigResult>}

Get agentConfig

Source:

types.js, line 1236

Returns:

Type: Promise.<AgentConfigResult>

getPhoneContacts(filterType) → {Promise.<PhoneContactsResult>}

Get phone contacts

Parameters:

Name	Type	Description
`filterType`	ContactsFilter

Source:

types.js, line 1182

Returns:

Type: Promise.<PhoneContactsResult>

getSignedRecordingUrl(recordingUrl, vendorCallKey, callId) → {Promise.<SignedRecordingUrlResult>}

Get the signed recording url

Parameters:

Name	Type	Description
`recordingUrl`	String
`vendorCallKey`	String
`callId`	String

Source:

types.js, line 1272

Returns:

Type: Promise.<SignedRecordingUrlResult>

getVoiceCapabilities() → {Promise.<VoiceCapabilitiesResult>}

Get voice capabilities

Source:

types.js, line 1253

Returns:

Type: Promise.<VoiceCapabilitiesResult>

hold(call) → {Promise.<HoldToggleResult>}

Hold call

Parameters:

Name	Type	Description
`call`	PhoneCall	The call to be held

Source:

types.js, line 1144

Returns:

Type: Promise.<HoldToggleResult>

mute(call) → {Promise.<MuteToggleResult>}

Mute call

Parameters:

Name	Type	Description
`call`	PhoneCall	(an optional participant call to mute)

Source:

types.js, line 1124

Returns:

Type: Promise.<MuteToggleResult>

pauseRecording() → {Promise.<RecordingToggleResult>}

Pause recording

Source:

types.js, line 1220

Returns:

Type: Promise.<RecordingToggleResult>

resume(call) → {Promise.<HoldToggleResult>}

Resume call

Parameters:

Name	Type	Description
`call`	PhoneCall	The call to be resumed

Source:

types.js, line 1154

Returns:

Type: Promise.<HoldToggleResult>

resumeRecording() → {Promise.<RecordingToggleResult>}

Resume recording

Source:

types.js, line 1228

Returns:

Type: Promise.<RecordingToggleResult>

sendDigits(digits)

Send digits

Parameters:

Name	Type	Description
`digits`	string

Source:

types.js, line 1173

setAgentConfig(config) → {Promise.<GenericResult>}

Set Agent Config

Parameters:

Name	Type	Description
`config`	AgentConfig

Source:

types.js, line 1245

Returns:

Type: Promise.<GenericResult>

superviseCall(supervisedCallInfo)

Supervise a call

Parameters:

Name	Type	Description
`supervisedCallInfo`	SupervisedCallInfo	CallInfo of the call to be supervised

Source:

types.js, line 1281

Returns:

supervisorBargeIn(supervisedCallInfo)

Supervisor Barges into a ongoing call

Parameters:

Name	Type	Description
`supervisedCallInfo`	SupervisedCallInfo	CallInfo of the supervised call which supervisor barges in

Source:

types.js, line 1299

Returns:

supervisorDisconnect(supervisedCallInfo)

Supervisor disconnects from a call

Parameters:

Name	Type	Description
`supervisedCallInfo`	SupervisedCallInfo	CallInfo of the supervised call to be disconnected

Source:

types.js, line 1290

Returns:

swap(call1, call2) → {Promise.<HoldToggleResult>}

Swap calls

Parameters:

Name	Type	Description
`call1`	PhoneCall
`call2`	PhoneCall

Source:

types.js, line 1192

Returns:

Type: Promise.<HoldToggleResult>

unmute(call) → {Promise.<MuteToggleResult>}

Unmute call

Parameters:

Name	Type	Description
`call`	PhoneCall	(an optional participant call to unmute)

Source:

types.js, line 1134

Returns:

Type: Promise.<MuteToggleResult>

wrapUpCall(call)

Wrap up call

Parameters:

Name	Type	Description
`call`	PhoneCall

Source:

types.js, line 1261