Trigger a Single Call — POST /api/v1/calls/trigger

Use this endpoint to trigger an immediate, single outbound call through the Scalysis AI calling engine. You supply the script you want the agent to follow, the customer’s phone number, and any optional context — such as an order number or notes — that the agent should have during the conversation. The call begins as soon as the request is accepted. Endpoint

POST https://app.scalysis.com/api/v1/calls/trigger

Authentication Include your API key in the request using either the Authorization header as a Bearer token or the X-API-Key header.

Authorization: Bearer <your_api_key>

X-API-Key: <your_api_key>

Request Body

number

required

The numeric ID of the AI agent script you want to use for this call. You can find script IDs in your Scalysis dashboard under Scripts.

string

required

The customer’s phone number to dial. Include the country code (e.g. +14155550123).

string

Your brand name, required when the selected script references it. If you receive a 400 error with the message Missing required script variables: brand_name, add this field to your request.

string

The customer’s full name. When provided, the agent can address the customer by name during the call.

string

Your internal order or reference number. Passed to the agent as context and stored on the resulting order record.

string

Free-text notes about the order or customer that the agent should be aware of during the call.

string

An optional label to associate this call with a named campaign for reporting purposes.

Example Request

curl --request POST \
  --url https://app.scalysis.com/api/v1/calls/trigger \
  --header 'Authorization: Bearer <your_api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "scriptId": 2207,
    "customerPhone": "+14155550123",
    "brand_name": "Acme Store",
    "customerName": "Jane Smith",
    "orderNumber": "demo-order-001",
    "orderNotes": "Customer requested a callback about delivery",
    "campaignName": "spring-outreach"
  }'

Response Fields

boolean

true when the call was successfully initiated.

string

The action that was performed. Always "trigger_call" for this endpoint.

number

The unique identifier assigned to this call record. Use this value with the Get Outcome endpoint to retrieve results after the call completes.

number

The ID of the script used for this call, echoed back from your request.

string

The current status of the call. Returns "in_progress" immediately after triggering.

string

A human-readable status message. Returns "Call started" on success.

Example Success Response

{
  "success": true,
  "action": "trigger_call",
  "order_id": 1368642,
  "script_id": 2207,
  "call_status": "in_progress",
  "message": "Call started"
}

Error Reference

400 Bad Request — A required field is missing or invalid. Check that scriptId and customerPhone are present. If the error message reads Missing required script variables: brand_name, add the brand_name field to your request body.

401 Unauthorized — Your API key is missing or invalid. Verify that your Authorization or X-API-Key header is correctly set.

Calls

Orders

Campaigns

Trigger a Single Call — POST /api/v1/calls/trigger

Request Body

Example Request

Response Fields

Example Success Response

Error Reference

​Request Body

​Example Request

​Response Fields

​Example Success Response

​Error Reference

Request Body

Example Request

Response Fields

Example Success Response

Error Reference