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

9da73dd2f99e

callbacks

Initiate a callback between two numbers

Initiates a callback: your user receives an incoming call and, once they pick up, the system automatically dials the recipient.

<strong>Caution:</strong> this feature adds call redirection fees.

Call workflow:

  1. Your user (<em>from_number</em>) receives a call showing the recipient's number (<em>to_number</em>).
  2. Your user picks up the phone.
  3. A call is automatically made to the recipient (<em>to_number</em>).

Permission: Calls Write required.

Monitoring:

  • OFF (default): You can only initiate a callback from your own number. The from_number field is ignored.
  • ON: You can use from_number to initiate the callback from any team member's number.

Parameters:

  • to_number (required) — Destination phone number in E.164 format (e.g. 33611223344).
  • device (required) — 3-character device code indicating which device to ring: APP, WEB, SIP, MOB, EXT, or ALL.
  • timeout (optional, default 20) — Seconds to wait before aborting the call if no answer. Min: 10, max: 300.
  • clir (optional, default false) — If true, the caller's number is hidden from the recipient (Calling Line Identification Restriction).
  • from_number (optional, requires Monitoring ON) — The team member's number to initiate the callback from. Ignored when Monitoring is OFF.
post/callback

Request body

from_numberinteger nullable

The team member's phone number to initiate the callback from (E.164 format, digits only). Requires Monitoring ON. When Monitoring is OFF or when omitted, the authenticated user's default number is used.

to_numberinteger required

Destination phone number in E.164 format (digits only). Required.

timeoutinteger

Number of seconds to wait before aborting the call if the communication is not established. Min: 10, max: 300, default: 20.

device'ALL' | 'APP' | 'WEB' | 'SIP' | 'MOB' | 'EXT' required

Device to ring for the callback. Required. Use a 3-character code: APP (mobile app), WEB (web app), SIP (SIP phone), MOB (mobile number), EXT (external number), ALL (all devices).

clirboolean

Calling Line Identification Restriction. When true, the caller's number is hidden from the recipient.

Example request

{
  "from_number": 33744332211,
  "to_number": 33611223344,
  "timeout": 45,
  "device": "ALL"
}

Response

Successful operation — the callback has been initiated.

call_idinteger
channel_idinteger

Example response

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