latestOpenAPI 3.1.1Proprietary – Contact us for usage terms2026-08-20173183551.4 KB

9da73dd2f99e

callbacks

ivrs

Initiate a callback through an IVR

Triggers a callback through a specific IVR (Interactive Voice Response) queue. The specified phone number will be called, and when the recipient picks up, they are routed through the IVR flow associated with the given ivrId. This is typically used to offer a "call me back" feature to customers waiting in a queue.

IVR Callbacks are only available on the Business and Advanced plans. Standard telephony charges apply based on the destination number.

Permission: Calls Write required.

Monitoring: Not required for this route. Any valid API key with Calls Write permission can initiate an IVR callback regardless of the Monitoring flag.

post/ivrs/{ivrId}/callback

Path parameters

ivrIdinteger required

The IVR identifier

Request body

from_numberinteger

The IVR Number to display

clirboolean

Calling line identification restriction: The CLIR service blocks calling party address information from being presented to the called user.

to_numberinteger

timeoutinteger

Number of seconds before the call is aborted if the communication isn't etablished.

Example request

{
  "from_number": 33744332211,
  "to_number": 33611223344,
  "timeout": 45,
  "integrations": {
    "salesforce": {
      "object": "Opportunity",
      "object_id": "SF_ID"
    }
  }
}

Response

Successful operation — the IVR callback has been initiated.

call_idinteger

channel_idinteger

Example response

{
  "call_id": 1234567890987654400,
  "channel_id": 12345678909876543000
}