Voice / Calls

Initiate a call

Place an outbound call. Teler dials to_number from from_number, and once the call connects it fetches your flow_url to drive the conversation. Status updates are delivered to status_callback_url for the lifetime of the call.

The call is accepted asynchronously: a 202 means Teler has queued the call, not that the callee has answered. Track progress via webhooks or by polling Retrieve a call.

post/api/v1/voice/calls/initiate

Request

Base URL: https://api.frejun.ai
URL: https://api.frejun.ai/api/v1/voice/calls/initiate
Auth: API key in header x-api-key

Request body

from_numberstring required

The number to place the call from, in E.164 format. Must be a number you own.

to_numberstring required

The destination number to dial, in E.164 format.

flow_urlstring uri required

HTTPS URL Teler fetches when the call connects to obtain the call flow that drives the call.

status_callback_urlstring uri required

HTTPS URL that receives status webhooks for the lifetime of the call.

recordboolean

Whether to record the call. Defaults to true.

Example request

{
  "flow_url": "https://example.com/flows/123",
  "from_number": "+14155552671",
  "record": true,
  "status_callback_url": "https://yourapp.com/callback",
  "to_number": "+14155559876"
}

Response

The call was accepted and is being placed.

messagestring required

Human-readable confirmation message.

Example response

{
  "data": {
    "from_number": "+14155552671",
    "id": "cs_01JQ8Z9K7M3N2P4R5S6T7V8W9X",
    "record": true,
    "status_callback_url": "https://yourapp.com/callback",
    "to_number": "+14155559876"
  },
  "message": "Call initiated successfully"
}

Changes

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