Gather using audio
Changed onPlay an audio file on the call until the required DTMF signals are gathered to build interactive menus.
You can pass a list of valid digits along with an 'invalid_audio_url', which will be played back at the beginning of each prompt. Playback will be interrupted when a DTMF signal is received. The Answer command must be issued before the gather_using_audio` command.
Expected Webhooks:
- call.playback.started
- call.playback.ended
- call.dtmf.received (you may receive many of these webhooks)
- call.gather.ended
Request
- Base URLhttps://api.telnyx.com/v2
- AuthHTTP bearer
Path parameters
Unique identifier and token for controlling the call
Request body
Example request
{
"audio_url": "http://example.com/message.wav",
"invalid_audio_url": "http://example.com/message.wav",
"minimum_digits": 1,
"maximum_digits": 10,
"timeout_millis": 10000,
"terminating_digit": "#",
"valid_digits": "123",
"inter_digit_timeout_millis": 10000,
"client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
"command_id": "891510ac-f3e4-11e8-af5b-de00688a4901"
}Response
Successful response upon making a call control command.
Example response
{
"data": {
"result": "ok"
}
}Changes
- breaking
the response's body type changed from
objectto no type for status - breaking
the
/response's property type changed fromobjectto no type for status - breaking
the
//response's property type changed fromintegertostring, and format fromint32tointegerfor status
- breaking
- breaking
the response's body type changed from no type to
objectfor status - breaking
the
/response's property type changed from no type toobjectfor status - breaking
the
//response's property type changed fromstringtointeger, and format fromintegertoint32for status - breaking
the
///response's property format changed fromjson-pointerto no format for status
- breaking