Saperly
Saperly is the phone carrier for AI agents — phone numbers, voice, SMS, and compliance in one API.
30 actionsAPI key
What your bot can do in Saperly
Looks up
- Check ConsentCheck whether a contact currently has active TCPA consent for one of your Saperly numbers, given numberId (your number) and peerNumber…
- Get CallFetch a single call by its id, returning its status, per-minute rate, final duration (durationSec) and cost (costCents), and the…
- 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.
- Get Phone NumberFetch a single phone number by its id, returning its E.164 phoneNumber, bound connectionId, webhookUrl, country, numberType, pricing and…
- Get Usage & BalanceReturn the workspace usage summary and prepaid balance.
- 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…
Show 5 more
- List LanguagesReturn the spoken languages Saperly supports for voice connections, each as a {code, name} pair (about 42 entries, e.g.
- 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.164), the connectionId…
- List VoicesList the text-to-speech voices available for Saperly connections.
- Quote Number PriceREAD-ONLY and FREE.
Takes action
- 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…
- Create ConnectionCreate a connection.
- 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.
- Place CallPAID / METERED — places a REAL outbound voice call that RINGS A REAL PHONE and BILLS PER MINUTE (~26¢/min).
- Provision Phone NumberPAID / METERED.
- 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.
Show 5 more
- Set Number Caller ID NameSet the outbound caller ID name / CNAM (1-15 characters.
- Set Number SMS Sender IDSet the alphanumeric SMS sender id (1-11 alphanumeric chars, e.g.
- 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.164 number like +15551230000, or a sip.
- Update ConnectionPartially update a connection (the AI answering brain bound to a number).
