Send Digits on an Active Call
Send DTMF digits to an active call for automated IVR navigation and call control.
This endpoint lets you send DTMF digits on an active call. DTMF (Dual-Tone Multi-Frequency) tones are the sounds generated when pressing keys on a phone keypad. You can use this to automate interactions with IVR systems, enter access codes, or control phone systems programmatically.
Note: The call must be in an active state for DTMF digits to be sent successfully. Invalid digits or calls that have ended will result in an error.
HTTP Request
https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/DTMF/Path Parameters
auth_idstringRequiredYour Vobiz authentication ID
call_uuidstringRequiredUnique identifier of the active call
Request Parameters
Request Parameters
| Name | Type | Description |
|---|---|---|
digitsRequired | string | The DTMF digits to send (0-9, *, #). |
leg | string | Which leg to send digits on. Values: "aleg", "bleg". Default: "aleg" |
Parameter Tips:
- •Only digits 0-9, *, and # are valid DTMF characters
- •The
alegrefers to the caller (A-leg),blegrefers to the callee (B-leg) - •DTMF tones are sent in the order specified in the digits string
Response
Returns an acknowledgement that the DTMF digits were sent.
{
"api_id": "uuid-here",
"message": "digits sent"
}Response Fields
api_id - Unique identifier for this API requestmessage - Confirmation message that digits were sent successfullyExample Request
Send DTMF Digits
{
"digits": "1234#",
"leg": "aleg"
}cURL Example
curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/DTMF/ \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"digits": "1234#",
"leg": "aleg"
}'Common Use Cases
- •Automatically navigate through IVR menu options
- •Enter PIN codes or access numbers for conference calls
- •Submit automated responses to phone surveys
- •Control phone systems that accept DTMF commands
- •Enter account numbers or verification codes
Tip: When automating IVR navigation, add appropriate delays between DTMF sends to allow the system time to process each input and respond with the next prompt.