Send digits on an active call

POST

api

Account

{auth_id}

Call

{call_uuid}

DTMF

Send DTMF tones

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/DTMF/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "digits": "1234"
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/DTMF/"

payload = { "digits": "1234" }
headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<api-key>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({digits: '1234'})
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/DTMF/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/DTMF/

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. Use this to automate interactions with IVR systems, enter access codes, or control phone systems programmatically.

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.

Path parameters

Parameter	Type	Required	Description
`auth_id`	string	Yes	Your Vobiz authentication ID
`call_uuid`	string	Yes	Unique identifier of the active call

Request parameters

Field	Type	Required	Description
`digits`	string	Yes	The DTMF digits to send. Valid characters: `0`–`9`, `*`, `#`. Insert `w` for a 0.5s pause and `W` for a 1s pause between tones (e.g. `1w2W3`).
`leg`	string	No	Which call leg receives the digits. Values: `aleg`, `bleg`, `both`. Default: `aleg`

aleg refers to the caller (A-leg); bleg refers to the callee (B-leg); both sends the tones to every leg. DTMF tones are sent in the order specified in the digits string. Use w/W pauses to wait for an IVR prompt before sending the next digit.

Error responses

Status	Meaning	How to handle
`400 Bad Request`	`digits` is missing or contains invalid characters.	Send only `0`–`9`, `*`, `#`, `w`, `W`.
`401 Unauthorized`	Missing/incorrect auth headers or a lowercase path.	Use both auth headers and the PascalCase path.
`404 Not Found`	The `call_uuid` is not an active call.	The call must be in-progress; confirm with Retrieve a Live Call.

Example request

{
  "digits": "1234#",
  "leg": "aleg"
}

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"
  }'

Response

202 Accepted

{
  "api_id": "uuid-here",
  "message": "digits sent"
}

Field	Description
`api_id`	Unique identifier for this API request
`message`	Confirmation that digits were sent successfully

When automating IVR navigation, add appropriate delays between DTMF sends to allow the system time to process each input before the next prompt plays.

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

call_uuid

string

required

Body

application/json

digits

string

required

Example:

"1w2W3"

leg

enum<string>

default:aleg

Available options:

aleg,

bleg,

both

Response

200

DTMF sent

⌘I

Send DTMF tones

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/DTMF/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "digits": "1234"
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/DTMF/"

payload = { "digits": "1234" }
headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<api-key>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({digits: '1234'})
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/DTMF/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​Path parameters

​Request parameters

​Error responses

​Example request

​Response

Authorizations

Path Parameters

Body

Response

Path parameters

Request parameters

Error responses

Example request

Response