Gather
The Gather
verb collects DTMF tones during a call. Say
can be nested within Gather
to create an interactive IVR with text-to-speech.
Attributes
ATTRIBUTE | DESCRIPTION | OPTIONS | DEFAULT |
---|---|---|---|
action | URL where TeXML will send the gathered result and message history. Same method
(GET /POST ) as set for the TexML application is used. Transfers control of the
current call to the TeXML file returned. | - | |
timeout | Time in seconds between digits before the Gather digits are sent to your action URL.
Telnyx will wait until all nested verbs have been executed before beginning the timeout period. |
| 5 |
finishOnKey | The set of digits, (0-9, *, #), that indicates the end of the gather. | # | |
numDigits | The number of digits to be gathered. | - | |
language | The language used. See RESTful API documentation for supported values. By default en-US. | en-US | |
validDigits | The set of valid digits for the gather action. | - | |
invalidDigitsAction | URL where TeXML will send the invalid gathered digits. The same method (GET/POST) as set for the TeXML application is used. Transfers control of the current call to the TeXML file returned. | - | |
minDigits | Minimum number of digits to be gathered. |
| 1 |
maxDigits | Maximum number of digits to be gathered. |
| 128 |
Child verbs/nouns
NOUN/VERB | DESCRIPTION |
---|---|
Say | |
Play |
Example
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Gather timeout="5" numDigits="1" finishOnKey="#">
<Say>Press 1 for sales, press 2 for support.</Say>
</Gather>
</Response>
Expected callbacks
action
{
"AccountSid":"cb6cfbbc-eb00-41af-a3f3-0d7b32009e4b",
"CallSid":"v2:DPNqxVjTNtQYaKdcKbU0QgRFrQ3YzuAQrVYC4Ggcuq7zTpDkUB7A4w",
"CallSidLegacy":"v2:DPNqxVjTNtQYaKdcKbU0QgRFrQ3YzuAQrVYC4Ggcuq7zTpDkUB7A4w",
"Digits":"1",
"From":"Defaultj35z6@sip.telnyx.com",
"To":"+12132045020"
}
ATTRIBUTE | DESCRIPTION |
AccountSid | A unique identifier for the account generating this call. |
CallSid | A unique identifier for this call, generated by Telnyx. |
From | The outbound caller number. |
To | The inbound callee number. |
Digits | The digits entered in the gather process by the callee. |