Gather Input

IMPORTANT!

If you hadn't yet read the intro part of this section, please click here to read it first.

Description

This module provides the developer access to the Cloudonix Gather Verb. Activating this module will instruct your currently running voice application to initiate an input gathering function. Depending on the case, input can be a keypad key press, a voice input or both.

Workflow

This module may be executed at any point of a scenario - however, pay attention to where the output is used in your CXML response.

Module Example

Parameters

Parameter	Description
Connection	The Voice Application Connection to be used for the query.
Gather Input Type	How the caller is expected to provide input (DTMF, Speech or both).
Transcription Engine and Language	What transcription engine and language will be used to transcribe the speech input. Be advised, depending on your language, each engine performs differently - we recommend that you experiment in order to get optimal results.
Speech Input Timeout	How long to wait without speech input, before activating the Next Action.
Next Action	See Below.
Action	The voice application to execute. Available for Attached or Detached Voice Applications.
Endpoint	The voice application remote HTTP endpoint. Available for Custom Voice Application Endpoint only.
Additional Data	An array of key=value pairs, to be passed to the new Voice Application as part of the request data.
Nested Voice Modules	See Below

Next Action Targets

This Voice Application

Voice application control is returned to the current voice application, with potential additional data.

Attached or Detached Voice Application

Voice application control is passed to the voice application that was previously built with Make.com.

Custom Voice Application Endpoint

Voice application control is passed to the URL designated in the Endpoint parameter.

Nested Voice Modules

As described above, the gather module activates the Cloudonix CXML Gather Verb, which is an asynchronous verb. In Cloudonix, asynchronous verbs (<Record> and <GATHER>) enable the developer to nest other verbs, to be executed while the recording is performed. The voice modules that can be nested are: Say Something, Pause and Play.

Nested voice modules are executed, in parallel to the input gathering, in the order they appear in the Nested Voice Modules parameter.

Example

Let us examine the following scenario diagram:

As you can see, our scenario consists of a Say Something modules and a Gather module. The Gather module includes the following nested voice modules parameter:

The resulting CXML of this scenario will look similar to this:

<Response>
  <Gather action="https://example.com/gatherScript" method="POST">
    <Say>Welcome to acme corporation, please state your name to continue</Say>
  </Gather>
</Response>

The above CXML document, generated from the scenario, will instruct Cloudonix to start a speech based input gathering and playback the announcement. If the platform identifies that the remote party started talking, it will stop the announcement playback and wait for the recording to complete.

Advanced Mode

Parameter	Description
Timeout	How long to wait for input overall. If no input is provided, this timer expires.
Always execute next action	Execute the Next Action on no input. (Default: false)