Skip to main content
The config verb allows developers to change the default speech settings during a session or to collect speech or DTMF input in the background while other verbs run. This verb is non-blocking, so the specified settings are changed immediately and the application proceeds with the next verb.
{
  "verb": "config",
  "synthesizer": {
    "vendor": "microsoft",
    "language": "de-DE",
    "voice": "de-DE-KillianNeural"
  },
  "recognizer": {
    "vendor": "google",
    "language": "de-DE"
  },
  "bargeIn": {
    "enable": true,
    "input": [
      "speech"
    ],
    "actionHook": "/userInput"
  }
}

Configuration

The full set of configuration parameters:
ParameterDescriptionRequired
amdEnable the Answering Machine Detection (/voice-gateway/references/verbs/amd).No
bargeinA background gather verb.No
bargeIn.enableIf true, begins listening for speech or DTMF input while the session executes other verbs. If false, stops any background listening task in progress.No
bargeIn.stickyIf both bargeIn.enable and bargeIn.sticky are true, another background gather will automatically initiate after detecting speech or DTMF.No
bargeIn.actionHookA webhook to call if the user input is collected from the background gather. Default is voiceNo
bargeIn.inputAn array specifying the allowed types of input: ['digits'], ['speech'], or ['digits', 'speech'].Yes
bargeIn.finishOnKeyThe DTMF key that signals the end of DTMF input.No
bargeIn.numDigitsThe exact number of DTMF digits expected to gather.No
bargeIn.minDigitsThe minimum number of DTMF digits expected to gather. The default value is 1.No
bargeIn.maxDigitsThe maximum number of DTMF digits expected to gather.No
bargeIn.interDigitTimeoutThe amount of time to wait between digits after minDigits have been entered.No
boostAudioSignalA string or integer value specifying the number of decibels to increase or decrease the outgoing audio signal level, for example, -6 dB.
Note that this parameter applies only to the main audio track, not to any additional (/voice-gateway/references/verbs/dub) audio tracks.
The default value is 0.
No
listenA nested listen verb.No
notifyEventsA boolean parameter. Enables event notifications over WebSocket connections. verbs sent over WebSocket must contain an id property to use this feature.No
onHoldMusicThe URL to a remote music source to use when a call is placed on hold.No
recognizerChange the session-level default speech recognition settings. See the transcribe verb for details on the recognizer property.No
resetA string or array. Resets either recognizer or synthesizer to the default application settings.No
recordOptions to manage call recording using SIPREC.No
record.actionOn of the following actions can be used: startCallRecording, stopCallRecording, pauseCallRecording, or resumeCallRecording.Yes
record.siprecServerURLThe SIP URI for the SIPREC server.Required if action is startCallRecording
record.recordingIDThe user-supplied string to identify the recording.No
sipRequestWithinDialogHookAn object or string. A webhook to call when a SIP request is received within the dialog. For example: INFO, NOTIFY, or REFER.No
synthesizerChange the session-level default text-to-speech settings. See the say verb for details on the synthesizer property.No

More Information

I