---
title: "Collect DTMF input"
method: POST
path: "/v1/calls/{id}/collect"
tags: ["Call control"]
---

# Collect DTMF input

`POST /v1/calls/{id}/collect`

## Request

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

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

## Path parameters

- `id` string, uuid, required

## Request body

- CallDtmfCollectRequest
  - `max_digits` integer: Maximum number of digits to collect.
  - `timeout` integer: Timeout for digit collection in seconds.
  - `termination_character` string: DTMF character that ends input collection.
  - `max_attempts` integer: Maximum number of attempts.
  - `prompt` object: Prompt to play before collecting digits. Play a prerecorded audio file or use Wavix Text-To-Speech.
    - `play` string: Audio file URL.
    - `say` object: Text to speak and voice to use. Pick `voice` from the language family matching `language` (for example, a German voice such as `Hans` for `ge`, a Spanish voice such as `Conchita` for `sp`) — Wavix does not validate the pairing itself.
      - `text` string, required: Text to speak.
      - `language` 'ru' | 'en' | 'sp' | 'ge': Language used for text-to-speech synthesis. One of `ru` (Russian), `en` (English), `sp` (Spanish), or `ge` (German). `sp` and `ge` are Wavix-specific codes, not the standard ISO 639-1 codes for Spanish (`es`) and German (`de`).
      - `voice` 'Ivy' | 'Joanna' | 'Kendra' | 'Kimberly' | 'Salli' | 'Joey' | 'Justin' | 'Matthew' | 'Conchita' | 'Lucia' | 'Enrique' | 'Marlene' | 'Vicki' | 'Hans' | 'Tatyana' | 'Maxim', required: Named text-to-speech voice used to read the message. Each value selects a distinct synthesized voice. One of `Ivy`, `Joanna`, `Kendra`, `Kimberly`, `Salli`, `Joey`, `Justin`, or `Matthew` (English voices); `Conchita`, `Lucia`, or `Enrique` (Spanish voices); `Marlene`, `Vicki`, or `Hans` (German voices); or `Tatyana` or `Maxim` (Russian voices).

## Response `200`

Returns a success confirmation. DTMF collection starts.

- SuccessResponse
  - `success` boolean, required: Indicates whether the request was successful.

## Other responses

- `400`: Returns a validation error when a request parameter is invalid.
- `401`: Unauthorized
- `403`: Request failed. The feature is disabled for your account.
- `404`: Request failed. An object with the specified ID is not found.

## Changes

- **2026-09-08** `6a89c962481c`: 1 info
  - added the non-success response with the status `403`

[Operation history](https://skmtc.dev/wavix/apis/wavix-apis/changes/v1/calls/:id/collect/post.md)

---

[API](https://skmtc.dev/wavix/apis/wavix-apis.md) - [All operations](https://skmtc.dev/wavix/apis/wavix-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/wavix/apis/wavix-apis/revisions/f2dde79f05ab?raw)