Bind Connection to NumberAttach a connection (the AI persona / answering brain from SAPERLY_CREATE_CONNECTION) to a phone number, so inbound calls and SMS to that number — and outbound calls placed from it — are handled by that connection.
Check ConsentCheck whether a contact currently has active TCPA consent for one of your Saperly numbers, given numberId (your number) and peerNumber (the contact's E.
Create ConnectionCreate a connection: the AI 'brain' that answers calls and (optionally) SMS on a Saperly phone number.
Delete ConnectionPERMANENTLY AND IRREVERSIBLY delete a connection (the AI answering brain / persona that handles calls and SMS) by its id.
End CallEnd an in-progress call by its id, hanging up and settling the metered cost.
Get CallFetch a single call by its id, returning its status, per-minute rate, final duration (durationSec) and cost (costCents), and the hasRecording / hasTranscript flags.
Get Call RecordingGet the audio recording for a call and return it as a downloadable file.
Get Call TranscriptFetch the transcript (conversation turns/segments) of a completed call by its id.
Get ConnectionFetch a single connection (the AI answering brain / persona that handles calls and SMS) by its id, returning its full config: name, mode, backend, instructions, tts voice, language, compliance/disclosure settings, recordingEnabled, and manual webhook URL.
Get Phone NumberFetch a single phone number by its id, returning its E.
Get Usage & BalanceReturn the workspace usage summary and prepaid balance: calls {count, totalCostCents, totalDurationSec}, messages {count}, and balanceCents (the prepaid balance, in cents).
List CallsReturn the full voice-call history (inbound + outbound) for the connected Saperly workspace.
List ConnectionsReturn every connection (the AI persona / answering 'brain' that handles calls and SMS) in the connected Saperly workspace.
List Consent RecordsReturn every TCPA consent record in the connected Saperly workspace, with each record's id, numberId (the Saperly number contact is authorized FROM), peerNumber (the contact's E.
List LanguagesReturn the spoken languages Saperly supports for voice connections, each as a {code, name} pair (about 42 entries, e.
List MessagesReturn SMS messages in the connected Saperly workspace (both inbound and outbound).
List Phone NumbersReturn every phone number provisioned in the connected Saperly workspace, with each number's id, phoneNumber (E.
List VoicesList the text-to-speech voices available for Saperly connections.
Place CallPAID / METERED — places a REAL outbound voice call that RINGS A REAL PHONE and BILLS PER MINUTE (~26¢/min); it keeps billing until hung up — end it with SAPERLY_END_CALL to stop the meter.
Provision Phone NumberPAID / METERED: provision (buy) a new phone number in a country.
Quote Number PriceREAD-ONLY and FREE: quote the price to provision a phone number in a country/type, returning { customerMonthlyCents, customerUpfrontCents }.
Record ConsentRecord TCPA consent for a contact so outbound SMS (SAPERLY_SEND_SMS) and calls (SAPERLY_PLACE_CALL) from your number are permitted.
Release Phone NumberPERMANENTLY AND IRREVERSIBLY release a phone number back to the carrier.
Revoke ConsentRevoke a contact's TCPA consent for a given Saperly number, blocking further outbound contact to them.
Send SMSPAID / METERED: send a single SMS from one of your Saperly numbers to an E.
Set Number Caller ID NameSet the outbound caller ID name / CNAM (1-15 characters: letters, digits, spaces) presented to recipients on outbound calls from a Saperly phone number, or pass callerIdName=null to CLEAR it.
Set Number SMS Sender IDSet the alphanumeric SMS sender id (1-11 alphanumeric chars, e.
Set Number WebhookSet the HTTPS webhook URL that Saperly POSTs this number's events (inbound SMS/calls, status) to.
Transfer CallPAID / METERED — BLIND-transfers a LIVE, in-progress voice call to another destination `to` (an E.
Update ConnectionPartially update a connection (the AI answering brain bound to a number).
