Skip to main content
Version: v8.2

Initiate a call

POST

/org/{tenant_code}/v2/calls

Platform support: MT and CC

Initiates an outbound call from an extension to the specified destination number.

The request is held open until the call is established, at which point 200 OK is returned with the resulting uid and linked_id. If the call cannot be established within the server's deadline, 504 Gateway Timeout is returned; note that the call may still proceed on the PBX even after a timeout response (the operation is not cancelled).

Authentication modes:

  • User token: The calling extension is automatically resolved from the authenticated user identity. The extension field must not be included in the request body.
  • API key: The extension field in the request body is required to identify which extension initiates the call.

Call modes:

  • Direct call: When from_number is omitted, the call originates directly from the extension's device(s) to the destination number.
  • Callback: When from_number is provided, the system first calls from_number, and upon answer, connects to the destination number. The extension's caller ID is presented to the remote party. from_number requires device: gsm and must be a GSM number assigned to the extension.

Auto-answer behavior:

When auto_answer is true, auto-answer is enabled only if the specified device resolves to exactly one SIP contact. If multiple SIP contacts match, auto-answer is not applied (ambiguous which device would answer). When auto_answer is false or omitted, auto-answer is never applied.

Request​

Responses​

Call established