Skip to main content

Gather using speak

POST 
/calls/:call_control_id/actions/gather_using_speak

Convert text to speech and play it 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_payload', which will be played back at the beginning of each prompt. Speech will be interrupted when a DTMF signal is received. The Answer command must be issued before the gather_using_speak command.

Expected Webhooks (see callback schema below):

  • call.dtmf.received (you may receive many of these webhooks)
  • call.gather.ended

Request

Responses

200:

Successful response upon making a call control command.

default:

Unexpected error