Skip to main content

$dialer

The $dialer built-in service allows controlling telephony features from the script.

Methods

Common methods

The methods below work for bot inbound and outbound telephony.

MethodDescription
getAudioTokenGet a token for downloading call recordings.
getBotSpeechReceive data on bot phrase playback.
getCallerGet the client phone number.
getCallRecordingFullUrlGet a URL for downloading the call recording.
getCallRecordingPathGet the path to the call recording.
getTransferStatusGet the status of the call transfer to an agent.
hangUpEnd the call.
isIncomingCallIs the current phone call inbound or outbound.
setNoInputTimeoutChange the time the bot waits for a response from the client.

Outbound telephony methods

These methods are intended to be called from call campaign scripts only.

MethodDescription
getAbonentTimezoneGet the client time zone.
getCallNotConnectedReasonGet the reason for an unsuccessful call attempt.
getCampaignScheduleGet the call campaign schedule.
getCampaignTokenGet the call campaign API token.
getDialHistoryGet the history of call attempts for the phone number.
getDialScheduleGet the phone number dial schedule.
getPayloadGet the data specified for the phone number.
redialSchedule a new series of call attempts for the phone number.
reportDataRecord data to the call campaign report.
setCallResultSet the call result.

Barge-in control methods

This group of methods allows controlling barge-in.

MethodDescription
bargeInInterruptTrigger conditional barge-in.
bargeInResponseEnable barge-in and configure its settings.
getBargeInIntentStatusGet conditional barge-in data.
getBargeInLabelGet the current barge-in label.
getBargeInTransitionGet the path to the current state for barge-in processing.
isBargeInInterruptedGet barge-in status.

ASR and TTS control methods

This group of methods allows controlling the settings of speech recognition (ASR) and synthesis (TTS).

MethodDescription
getAsrProvider
getTtsProvider
Get the ASR/TTS provider name.
getAsrConfig
getTtsConfig
Get the current ASR/TTS settings.
setAsrConfig
setTtsConfig
Override the ASR/TTS settings.