Initiate Outbound Call

POSThttps://api.trillet.ai/v1/api/call

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Request Body

tostringrequired

The phone number to which the call will be made.

call_agent_idstringrequired

The ID of the agent assigned to make the call.

callback_urlstring

A URL to receive webhook events about the call. If provided, this URL will be used for notifications.

dynamic_variablesobject

Dynamic variables that can be used to customize call scripts. Each key represents a variable that can be inserted into the call script dynamically. For example:

metadataobject

Any fields passed here will be sent to the call agent and directly passed to the webhook triggered by the agent under its 'metadata' header, but they will not be included in the call agent's context.

Response Fields

statusstring

The status of the request, indicating the success or failure of the call initiation.

call_idstring

A unique identifier assigned to the initiated call. This ID can be used to track the call's progress or retrieve its details later.

messagestring

A message providing feedback about the call initiation process, typically confirming successful initiation or describing an error.

{
  "status": "success",
  "call_id": "123456789",
  "message": "Call initiated successfully"
}