---
title: "Create an IVR"
method: POST
path: "/v1/ivr"
---

# Create an IVR

`POST /v1/ivr`

## Request

- Base URL: `https://api.servetel.in`
- URL: `https://api.servetel.in/v1/ivr`
- Auth: none required

This API allows you to create a new IVR.

## Headers

- `Authorization` string, required

## Request body

- object
  - `name` string, required: Name of the IVR.
  - `description` string, required: Description of the IVR.
  - `recording` string, required: Unique ID of the recording.
  - `timeout` string, required: Time to wait for user input after recording ends.
  - `option` string[], required: IVR Options.
  - `destination` string[], required: Where the call should land corresponding to IVR option.eg: extension||eid, agent's eid eg: 050160000
  - `incorrect_count` string, required: Number of retries allowed after invalid inputs.
  - `timeout_recording` string, required: Unique ID of the recording that needs to be played when timeout expires.
  - `invalid_recording` string, required: Unique ID of the recording that needs to be played when an invalid option is pressed.
  - `invalid_destination` string, required: Destination where the call should land when invalid option is selected. eg: extension||eid, agent's eid eg: 050160000
  - `timeout_retry_recording` string, required: Unique ID of the recording that needs to be played when timeout on retry occurs.
  - `timeout_destination` string, required: Destination where the call needs to land when timeout occurs. eg: extension||eid, agent's eid eg: 050160000
  - `sms_template` string[]: Unique ID of SMS Template to be associated with IVR Option, only applicable if SMS Template setting is enabled for user account.
  - `timeout_tries` string, required: The number of times Timeout Retry is allowed

## Response `200`

200

- object

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/servetel/apis/servetel-base-api-config.md) - [All operations](https://skmtc.dev/servetel/apis/servetel-base-api-config/llms.txt) - [OpenAPI document](https://skmtc.dev/servetel/apis/servetel-base-api-config/revisions/d1cb31356d25?raw)
