The Gather verb is used to collect digits for some period of time.
| Attribute | Description |
|---|---|
| requestUrl | (required) Relative or absolute URL to send events to and request new BXML (only supports GET HTTP method) |
| requestUrlTimeout | (optional) Integer time in milliseconds to wait for requestUrl response (Default value is 30000). |
| terminatingDigits | (optional) Digits to stop gather (Default value is “#”). |
| maxDigits | (optional) Quantity of digits to collect (Default value is 128). |
| interDigitTimeout | (optional) Integer time indicating the timeout between digits (Default value is 5 seconds). |
| bargeable | (optional) Boolean to indicate if audio playback should be stopped when digit is pressed (Default value is ‘true’). |
In case no digit is provided the Gather verb fails and the next verb is executed, if it completes successfully the entered digits are sent via requestUrl attribute.
These verbs might also be nested inside <Gather>:
| Verb | Description |
|---|---|
| SpeakSentence | (optional) Using the SpeakSentence inside the Gather verb will speak the text to the callee. |
| PlayAudio | (optional) Using the PlayAudio inside the Gather verb will play the media to the callee. |
| Event | Can reply with more BXML |
|---|---|
| Gather | Yes |
This example shows how to use the Gather verb to speak a sentence and collect digits input from the phone.
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Gather requestUrl="https://gather.url/nextBXML" requestUrlTimeout="10000"
terminatingDigits="#">
<SpeakSentence gender="female" locale="en_US" voice="susan">Please, press a digit.</SpeakSentence>
</Gather>
</Response>