voice

Place an outbound call

post/calls

Request

  • Base URL: https://api.saperly.com
  • URL: https://api.saperly.com/calls
  • Auth: none required

Request body

fromNumberIdstring required

The Saperly number id to place the call from.

tostring required

The destination in E.164 format, e.g. "+15555550123".

connectionIdstring nullable

Optional. Use this connection for the call instead of the number's bound one.

instructionsstring nullable

A per-call system prompt that overrides the connection's saved instructions for this call only. Omit to run the call on the line's saved config. (Voice/model/language are not per-call overridable via the API — set them on the connection.)

Response

Success

idstring required
numberIdstring required
direction'inbound' | 'outbound' required
tostring required
fromstring required
statusstring required

Lifecycle status. initiated (placed or ringing, not yet finalized), completed (connected and hung up; billed by duration), no_answer (the callee never picked up; zero cost), failed (the carrier could not connect it, or it was expired unfinalized; zero cost), rejected (refused before answer — insufficient balance; zero cost). Only completed bills.

rateCentsPerMinnumber nullable required
durationSecnumber nullable required
costCentsnumber nullable required
hasRecordingboolean required
hasTranscriptboolean required
createdAtstring required

Changes

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