---
title: "Call with User input"
method: POST
path: "/voice/v1/call"
---

# Call with User input

`POST /voice/v1/call`

This API endpoint allows users to initiate a voice call to a mobile number, during which a voice message will be played. Users can specify the voice message using either the Text-to-Speech (TTS) or the audio file URL. Additionally, the API enables DTMF  input collection, allowing the call recipient to press a key on their handset to provide input.

## Headers

- `Authorization` string
- `Content-Type` string

## Request body

- object
  - `to` string, required — The mobile number in numbering plan format E.164 that you want to send the call to
  - `sayText` string, required — The voice message that you want to play during the call
  - `callerVoice` string — TTS Voices https://docs.aws.amazon.com/polly/latest/dg/voicelist.html
  - `neuralLang` boolean — Neural TTS that can produce even higher quality voices than its standard voices
  - `audiofile` string — The URL of the audio file to be played during the call.
  - `repetition` integer — The number of repeats that you would like to make during the call for the sayText field
  - `ringingDuration` integer — Timeout seconds number to wait for the channel to be answered before giving up
  - `enabledtmf` boolean — If you want to collect back input from the user handset "i.e. press 1 to do something .." , in this case we suppose the field dtmfCallbackEndpoint to be refer for your own callback endpoint
  - `dtmfCallbackEndpoint` string — Http Get callback endpiont for the collected user input during the call "overall"
  - `statusCallbackEndpoint` string — Register this call back to receive update for each call status once the call start
  - `metadata` string, json — Meta-Data is a special purpose field for some integrations
  - `speed` number, float — Controls the playback speed of the voice. Accepts one of the following discrete values, ordered from slowest to fastest: 0.5, 0.75, 1.0, 1.25, 1.5. The default speed is 1.0 (normal speed).
  - `isRecorded` boolean — Enables call recording. When set to true, recording begins the moment the call is answered by the callee (not while ringing). Defaults to false (no recording).
  - `recordCallbackURL` string — The HTTPS endpoint where the call recording will be delivered once it's ready. After the call ends and the recording is processed, the system sends a callback (webhook) to this URL containing the recording URL. Required when isRecorded is true; ignored otherwise.

## Response `200`

200

- object
  - `callId` string

## Other responses

- `401` — 401
- `403` — 403
- `404` — 404

---

[API](https://skmtc.dev/cequens/apis/authentication.md) · [All operations](https://skmtc.dev/cequens/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cequens/authentication/revisions/deadb0661f19/schema)