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 Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/calls//actions/gather_using_speak' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
    "inter_digit_timeout_millis": 10000,
    "invalid_payload": "say this on call",
    "language": "arb",
    "maximum_digits": 10,
    "minimum_digits": 1,
    "payload": "say this on call",
    "payload_type": "text",
    "service_level": "premium",
    "terminating_digit": "#",
    "valid_digits": "123",
    "voice": "male"
}'

Response Example

200 - Example 1

{
    "data": {
        "result": "ok"
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Successful response upon making a call control command.

Body

🔴500Server Error

Modified at 2025-06-16 19:14:41

Gather using audio

Hangup call