$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.

Method	Description
getAudioToken	Get a token for downloading call recordings.
getBotSpeech	Receive data on bot phrase playback.
getCaller	Get the client phone number.
getCallRecordingFullUrl	Get a URL for downloading the call recording.
getCallRecordingPath	Get the path to the call recording.
getTransferStatus	Get the status of the call transfer to an agent.
hangUp	End the call.
isIncomingCall	Is the current phone call inbound or outbound.
setNoInputTimeout	Change 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.

Method	Description
getAbonentTimezone	Get the client time zone.
getCallNotConnectedReason	Get the reason for an unsuccessful call attempt.
getCampaignSchedule	Get the call campaign schedule.
getCampaignToken	Get the call campaign API token.
getDialHistory	Get the history of call attempts for the phone number.
getDialSchedule	Get the phone number dial schedule.
getPayload	Get the data specified for the phone number.
getRetryIntervals	Get the duration of pauses between call attempts.
redial	Schedule a new series of call attempts for the phone number.
reportData	Record data to the call campaign report.
setCallResult	Set the call result.

Barge-in control methods

This group of methods allows controlling barge-in.

Method	Description
bargeInInterrupt	Trigger conditional barge-in.
bargeInResponse	Enable barge-in and configure its settings.
getBargeInIntentStatus	Get conditional barge-in data.
getBargeInLabel	Get the current barge-in label.
getBargeInTransition	Get the path to the current state for barge-in processing.
isBargeInInterrupted	Get barge-in status.

ASR and TTS control methods

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

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