Service Cloud Connector API Reference

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Service Cloud Connector API Reference
Release Notes
Get Started
Base Connector API
Connector API Methods
Connector API Class Objects
ActiveCallsResult
AgentConfigResult
AgentStatusInfo
AgentWork
AudioStats
AudioStatsElement
CallInfo
CallResult
CapabilitiesResult
ConferenceResult
Contact
ContactsResult
customError
GenericResult
HangupResult
HoldToggleResult
InitResult
LogoutResult
MuteToggleResult
ParticipantResult
Phone
PhoneCall
PhoneCallAttributes
PhoneContactsResult
RecordingToggleResult
SetAgentConfigResult
SharedCapabilitiesResult
SignedRecordingUrlResult
StatsInfo
VoiceCapabilitiesResult
Supervisor API
PDF

VoiceCapabilitiesResult

Represents the result type for the rep capabilities for Voice.

Constructor

new VoiceCapabilitiesResult(param)

Functions Where Used

Parameters

Field Details
param
Type
object
Description
Parameters associated with the Voice capabilities result.
param.hasBlindTransfer
Type
boolean
Description
Indicates whether the vendor supports blind transfer. The default value is false.
param.hasConsult
Type
boolean
Description
Indicates whether a rep can make consult calls (true) or not (false). The default is false.
param.hasMerge
Type
boolean
Description
Indicates whether merge is supported.
param.hasMute
Type
boolean
Description
Indicates whether mute is supported.
param.hasPhoneBook
Type
boolean
Description
Indicates whether rep-to-rep and rep-to-queue calls are enabled in the Omni-Channel widget. The default value is false.
param.hasRecord
Type
boolean
Description
Indicates whether recording is supported.
param.hasSupervisorBargeIn
Type
boolean
Description
Indicates whether the supervisor can barge in. The default value is false.
param.hasSupervisorListenIn
Type
boolean
Description
Indicates whether the supervisor can listen in.
param.hasSwap
Type
boolean
Description
Indicates whether swap is supported.
param.signedRecordingDuration
Type
string
Description
The signed recording duration.
param.signedRecordingUrl
Type
string
Description
The signed recording URL.
param.supportsMos
Type
boolean
Description
Indicates whether the vendor supports MOS scores.
param.isDialPadDisabled
Type
boolean
Description
Indicates whether the dial pad in the softphone is disabled (true) or enabled (false) when the rep is online and there are no active calls. By default, this value is false, meaning the dial pad remains enabled in the softphone when the rep is online and there are no active calls. If true, the dial pad is disabled in the softphone when the rep is online and there are no active calls.
param.isPhoneBookDisabled
Type
boolean
Description
Indicates whether the phone book in the softphone is disabled (true) or enabled (false) when the rep is online and there are no active calls. By default, this value is false, meaning the phone book remains enabled when the rep is online and there are no active calls. If true, the phone book is disabled in the softphone when the rep is online and there are no active calls.
param.isHidSupported
Type
boolean
Description
Indicates whether the Human Interface Device (HID) headset controls are enabled (true) or disabled (false). By default, this value is false, meaning the headset controls are disabled. If true, headset controls are enabled.

Example

new VoiceCapabilitiesResult({
    hasMute: true,
    hasMerge: true,
    hasRecord: true,
    hasSwap:  true,
    hasSignedRecordingUrl: false,
    isDialPadDisabled: false,
    isHidSupported: false,
    isPhoneBookDisabled: false, 
    supportsMos: true,
    hasSupervisorListenIn: true,
    hasSupervisorBargeIn: false,
    hasBlindTransfer: true,
    signedRecordingUrl: null,
    signedRecordingDuration: null
});