Sign in
IVR (Inbound)

IVR Response From Client

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
get/callback-url

Query parameters

CallerIdstring

The phone number or identifier of the caller

Extensionstring

The extension or phone number dialed by the caller

SequenceIDinteger

A unique identifier representing the IVR interaction sequence

IsStartingboolean

Indicates if this is beginning of the IVR session

DTMFinteger

The DTMF tone pressed by the user

Timestampstring

Date and time of the request

actionstring

Action that was executed

contextstring

Used to determine whether call being made is inbound or outbound

recordingUrlstring

URL of recorded audio

Response

Success - Return IVR Actions

IVRResponseActions required— unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.