Config

Modifies one or more aspects of the current session and continues immediately with the next verb in the application.

The config verb is non-blocking.

1{
2 "verb": "config",
3 "synthesizer": {
4 "voice": "Jenny"
5 },
6 "recognizer": {
7 "vendor": "google",
8 "language": "de-DE"
9 },
10 "bargeIn": {
11 "enable": true,
12 "input" : ["speech"],
13 "actionHook: "/userInput"
14 }
15}

Parameters

amd
boolean

enable answering machine detection; see answering machine detection for details.

actionHookDelayAction
object

object, see here for details.

bargeIn
object

this object contains properties that are used to instantiate a ‘background’ gather verb.

bargeIn.enable
boolean

if true, begin listening for speech or dtmf input while the session is executing other verbs. This is known as a “background gather” and an application to capture user input outside of a gather verb. If false, stop any background listening task that is in progress.

bargeIn.sticky
boolean

If true and bargeIn.enable is true, then when the background gather completes with speech or dtmf detected, it will automatically start another background gather.

bargeIn.actionHook
string

A webhook to call if user input is collected from the background gather.

bargeIn.input
arrayRequired

Array, specifying allowed types of input: [‘digits’], [‘speech’], or [‘digits’, ‘speech’].

bargeIn.finishOnKey
string

Dtmf key that signals the end of dtmf input.

bargeIn.numDigits
number

Exact number of dtmf digits expected to gather.

bargeIn.minDigits
number

Minimum number of dtmf digits expected to gather. Defaults to 1.

bargeIn.maxDigits
number

Maximum number of dtmf digits expected to gather.

bargeIn.interDigitTimeout
number

Amount of time to wait between digits after minDigits have been entered.

boostAudioSignal
string | number

A string or integer value indicating the number of decibels to boost or reduce the strength of the outgoing audio signal to the caller/called party, e.g. “-6 dB”. Note this applies to the main track only, not to any dub tracks.

fillerNoise
object

play audio to the caller while the remote application is processing gather transcriptions. This is a session-wide setting that may be overridden at the gather verb level. See Using filler noise for more details.

fillerNoise.enable
booleanRequired

whether to enable or disable filler noise.

fillerNoise.url
stringRequired

http(s) audio to play as filler noise.

fillerNoise.startDelaySecs
number

integer value specifying number of seconds to wait for a response from the remote application before playing filler noise (default: play immediately after sending results).

listen
object

a nested listen action, which allows recording of the call from this point forward by streaming the audio to a remote server over a websocket connection.

notifyEvents
boolean

whether to enable event notifications (verb:status messages) over websocket connections. Verbs that are sent over the websocket must also contain an “id” property to activate this feature.

onHoldMusic
string

provides the URL to a remote music source to use when a call is placed on hold.

recognizer
object

change the session-level default speech recognition settings. See the transcribe verb for details on the recognizer property.

reset
string | array

resets either ‘recognizer’ and/or ‘synthesizer’ to the default application settings.

record
object

options to manage call recording using SIPREC.

record.action
stringRequired

“startCallRecording”, “stopCallRecording”, “pauseCallRecording”, or “resumeCallRecording”.

record.siprecServerURL
stringRequired

sip uri for SIPREC server (required if action is “startCallRecording”).

record.recordingID
string

user-supplied string to identify the recording.

transcribe
object

a nested transcribe action, which allows a transcription of the call to be sent in the background.

transcribe.enable
booleanRequired

if true start the transcribe, if false stop it.

transcribe.transcriptionHook
stringRequired

the webhook/websocket identifier to send transcriptions to (required if enabling transcription).

transcribe.recognizer
object

recognizer options.

sipRequestWithinDialogHook
string | object

a webhook to call when a SIP request is received within the dialog (e.g. an INFO, NOTIFY, or REFER).

synthesizer
object

change the session-level default text-to-speech settings. See the say verb for details on the synthesizer property.