Send DTMF digits
send_dtmfSends keypad tones on a live call to navigate remote IVRs or enter digits, supporting 0-9, *, #, and pause characters. Use when an active call must receive DTMF input.
Instructions
Send keypad tones on a LIVE call (POST /Account/{auth_id}/Call/{call_uuid}/DTMF/), as if the user pressed the keys: digits 0-9, *, #; w = 0.5 s pause, W = 1 s pause. Use it only when the user asked to press keys on an active call (e.g. navigating a remote IVR). To collect keys FROM the other party use gather_dtmf instead. The tones are sent once and cannot be recalled; a call that is not live fails with call_not_active.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| legs | No | Which call leg hears the tones: aleg (the call's first leg, default), bleg (the party bridged by <Dial>) or both. | |
| digits | Yes | Key sequence to send, 1-64 characters of 0-9 * # w W, e.g. 1w2# (press 1, wait half a second, press 2, then #). | |
| call_uuid | Yes | UUID of the live call: the request_uuid from make_call, or a UUID from list_live_calls. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`. | |
| sent | No | True once Vobiz accepted the digits for sending. | |
| call_uuid | No | The call UUID the request was about, echoed back. | |
| http_status | No | HTTP status Vobiz answered with. | |
| backend_message | No | Vobiz's own confirmation text, or null when it sent none. |