---
title: "IVR Response From Client"
method: GET
path: "/callback-url"
tags: ["IVR (Inbound)"]
---

# IVR Response From Client

`GET /callback-url`

This endpoint receives IVR responses from the client system during an active IVR session.

<strong>HTTP Request</strong>

    GET https://your-server.com/callback-url

<p class="alert-primary"><i class="las la-info-circle" style="font-size:24px"></i>This is a webhook endpoint that receives IVR interaction data. The parameters are sent as query parameters in the GET request.</p>

<strong>Expected Response Format:</strong>
Your server should respond with a JSON object containing an "actions" object where each key represents an action to be executed.

<strong>Available Actions:</strong>
- <strong>playback</strong>: 🎵 Plays an audio file to the caller
- <strong>get_digits</strong>: 🔢 Plays audio and captures DTMF input
- <strong>background</strong>: 🔊 Plays background audio and collects single digit
- <strong>dial</strong>: ☎ Plays audio then dials a number or agent
- <strong>hangup</strong>: 🔚 Immediately ends the call
- <strong>record</strong>: 🔴 Records audio input from caller

## Query parameters

- `CallerId` string
- `Extension` string
- `SequenceID` integer
- `IsStarting` boolean
- `DTMF` integer
- `Timestamp` string
- `action` string
- `context` string
- `recordingUrl` string

## Response `200`

Success - Return IVR Actions

- IVRResponseActions — unresolved $ref

---

[API](https://skmtc.dev/mnotify/apis/bms-documentation.md) · [All operations](https://skmtc.dev/mnotify/apis/bms-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mnotify/bms-documentation/revisions/c06855f2ed03/schema)
