WAwavix
Call control

Collect DTMF input

Changed on

Collects DTMF keypad input from the caller on the active call identified by id.

post/v1/calls/{id}/collect

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/calls/{id}/collect
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The uuid of the call.

Request body

max_digitsinteger

Maximum number of digits to collect.

timeoutinteger

Timeout for digit collection in seconds.

termination_characterstring

DTMF character that ends input collection.

max_attemptsinteger

Maximum number of attempts.

Example request

{
  "max_digits": 5,
  "timeout": 10,
  "termination_character": "#",
  "max_attempts": 3,
  "prompt": {
    "play": "https://examples.com/prompt.wav",
    "say": {
      "text": "Press 1 for sales, press 2 for support, or press 3 to repeat this menu."
    }
  }
}

Response

Returns a success confirmation. DTMF collection starts.

successboolean required

Indicates whether the request was successful.

Example response

{
  "success": true
}

Changes