# ivr

> Visual IVR menus, versions, simulation and activation.

Visual IVR menus, versions, simulation and activation.

| Method | Path | Operation | Scope | Test mode |
|---|---|---|---|---|
| GET | `/v1/ivr-menus` | `ivr_list`: List IVR menus | `calls:read` | - |
| POST | `/v1/ivr-menus` | `ivr_create`: Create an IVR menu | `calls:write` | - |
| DELETE | `/v1/ivr-menus/{ivr_id}` | `ivr_delete`: Delete an IVR menu | `calls:write` | - |
| GET | `/v1/ivr-menus/{ivr_id}` | `ivr_get`: Get an IVR menu | `calls:read` | - |
| PATCH | `/v1/ivr-menus/{ivr_id}` | `ivr_update`: Edit menu metadata | `calls:write` | - |
| POST | `/v1/ivr-menus/{ivr_id}/activate` | `ivr_activate`: Publish and bind to numbers | `calls:write` | - |
| POST | `/v1/ivr-menus/{ivr_id}/deactivate` | `ivr_deactivate`: Unbind from numbers | `calls:write` | - |
| POST | `/v1/ivr-menus/{ivr_id}/simulate` | `ivr_simulate`: Simulate a DTMF path without a call | `calls:read` | - |
| GET | `/v1/ivr-menus/{ivr_id}/stats` | `ivr_stats`: Path usage, drop-offs, forwards | `analytics:read` | - |
| GET | `/v1/ivr-menus/{ivr_id}/versions` | `ivr_versions_list`: List saved versions | `calls:read` | - |
| POST | `/v1/ivr-menus/{ivr_id}/versions` | `ivr_versions_create`: Save a version (graph is validated) | `calls:write` | - |
| GET | `/v1/ivr-menus/node-kinds` | `ivr_node_kinds_list`: The kinds of step a call menu can have | `calls:read` | - |
| POST | `/v1/voice/calls/{call_id}/ivr` | `ivr_advance`: Advance a live call through its IVR | `calls:write` | - |
| GET | `/v1/voice/ivr` | `voice_ivr_get`: Active IVR menu for a number | `calls:read` | - |
| PUT | `/v1/voice/ivr` | `voice_ivr_put`: Bind or unbind the IVR of a number | `calls:write` | - |

Request and response schemas: the interactive reference at `https://api.wapitick.com/docs`, or `docs/api/openapi.json`.
