Initiate an outbound call

const url = 'https://saperly.com/api/v1/calls';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"line_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6","to_number":"+15551234567"}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "call": {
    "id": "7b9c9f1e-8d3a-4f2b-9a1e-2d4f5c6b7e8f",
    "line_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "direction": "outbound",
    "from_number": "+15557654321",
    "to_number": "+15551234567",
    "status": "initiated",
    "duration_sec": 0,
    "started_at": "2024-04-20T14:00:00Z",
    "ended_at": "2024-04-20T14:00:00Z",
    "recording_url": "https://recordings.saperly.com/calls/7b9c9f1e-8d3a-4f2b-9a1e-2d4f5c6b7e8f/recording.mp3",
    "transcript": [
      {}
    ],
    "system_prompt": "Welcome to Saperly outbound call service.",
    "begin_message": "Connecting your call now.",
    "created_at": "2024-04-20T13:59:55Z"
  }
}

Places an outbound call from the specified line. Runs a compliance pre-call check (balance, consent, disclosure) before initiating. Reserves one minute at the applicable voice rate (Zone A webhook: 13¢; Zone A hosted: 26¢; ×2/×3 for Zone B/C — see voice-zones guide for full rates). The line’s status_callback_url receives a call_outgoing event with a WebSocket relay URL for audio streaming.

Places an outbound call from the specified line. Runs a compliance pre-call check (balance, consent, disclosure) before initiating. Reserves one minute at the applicable voice rate (Zone A webhook: 13¢; Zone A hosted: 26¢; ×2/×3 for Zone B/C — see voice-zones guide for full rates). The line's status_callback_url receives a `call_outgoing` event with a WebSocket relay URL for audio streaming.

Authentication

AuthorizationBearer

Send as Authorization: Bearer <your-key>. Obtain keys from the portal — prefix sk_live_ for production, sk_test_ for sandbox.

Request

This endpoint expects an object.

line_idstringRequiredformat: "uuid"

ID of the line to call from

to_numberstringRequired

Destination phone number in E.164 format

Response

Call initiated

callobject

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

502

Bad Gateway Error