Skip to main content
POST
/
call
/
{uuid}
/
collect
Collect DTMF input
curl --request POST \
  --url 'https://api.wavix.com/v1/call/{uuid}/collect?appid=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "min_digits": 1,
  "max_digits": 5,
  "timeout": 10,
  "termination_character": "#",
  "audio": {
    "url": "https://examples.com/prompt.wav",
    "stop_on_keypress": true
  },
  "callback_url": "https://examples.com/dtmf-callback"
}
'
{
  "success": true
}

Authorizations

​
appid
string
query
required

An API key to authorize your request

Path Parameters

​
uuid
string<uuid>
required

Call ID.

Body

application/json

DTMF collection parameters

​
min_digits
integer

Specifies the minimum number of digits to collect

Required range: 1 <= x <= 20
Example:

1

​
max_digits
integer

Specifies the maximum number of digits to collect

Required range: 1 <= x <= 20
Example:

5

​
timeout
integer

Timeout for digit collection, in seconds

Required range: 1 <= x <= 60
Example:

10

​
termination_character
string

Character that ends digit collection

Example:

"#"

​
audio
object
​
callback_url
string

URL to receive digit collection results

Example:

"https://examples.com/dtmf-callback"

Response

DTMF collection successfully started.

​
success
boolean
Example:

true