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

# Collect DTMF input

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

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.
      - `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).
      - `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
- `404` — Request failed. An object with the specified ID is not found.

---

[API](https://skmtc.net/wavix/apis/wavix-apis.md) · [All operations](https://skmtc.net/wavix/apis/wavix-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wavix/wavix-apis/revisions/b22f170488b6/schema)