API reference
32 endpoints, each with its scope, its limits, the errors it can return and a Try-It panel to run it with your own API key.
Utilities
Diagnostic endpoints, available to any API key. Use them to verify your credentials are wired correctly.
Tools
General-purpose catalogs you can consume from your app. Available to any API key.
Number Insight
Resolves a phone number: country, line type, current carrier (porting-aware in Colombia) and area. One by one or in batches.
/api/v6/numberinsight/{number}Single number lookup
Country, line type, current carrier and area of a phone number.
Any valid API key · 60 requests per minute
/api/v6/numberinsight/batchBatch lookup
Resolve many numbers in a single request, inline or as an asynchronous job.
Any valid API key · 10 requests per minute
/api/v6/numberinsight/batch/{jobId}Batch job status
State of an asynchronous job and the download URL of its result.
Any valid API key · 60 requests per minute
URL Shortener
Create and manage short links on your domains, and read their click analytics.
/api/v6/urlshortener/linksCreate a short link
Publish a short link on one of your domains, with a generated code or your own alias.
API key with the urlshortener service enabled · 35 requests per second
/api/v6/urlshortener/linksList short links
Your links, newest first, with their click counters. Paginated.
API key with the urlshortener service enabled · 30 requests per minute
/api/v6/urlshortener/domainsList available domains
Domains your account can publish links on, with the default first.
API key with the urlshortener service enabled · 30 requests per minute
/api/v6/urlshortener/links/{domain}/{code}Get a short link
One of your links by domain and code.
API key with the urlshortener service enabled · 60 requests per minute
/api/v6/urlshortener/links/{domain}/{code}Update a short link
Change the state, the expiry or the destination. The code is immutable.
API key with the urlshortener service enabled · 35 requests per second
/api/v6/urlshortener/links/{domain}/{code}Delete a short link
Deletes the link and its analytics. The operation cannot be undone.
API key with the urlshortener service enabled · 35 requests per second
/api/v6/urlshortener/links/{domain}/{code}/statsLink statistics
Totals, time series and breakdowns by country, device or referrer.
API key with the urlshortener service enabled · 120 requests per minute
Text-to-Speech
Turn text into audio with natural voices, automatically reuse an identical audio already generated, and check the state of each request.
/api/v6/tts/synthesizeSynthesize text to speech
Turns a text into audio and returns its reference. Synchronous.
API key with the tts service enabled · 60 requests per minute
/api/v6/tts/synthesis/{id}Synthesis status
Metadata of a synthesis request by its id.
API key with the tts service enabled · 120 requests per minute
/api/v6/tts/voicesList available voices
Filterable catalog of synthesis voices.
API key with the tts service enabled · 120 requests per minute
Call Blasting
Outbound voice calls with pre-recorded audio or text-to-speech, with configurable retries and per-attempt status.
/api/v6/callblasting/callsCall with generated voice
Sends a call that plays a text-to-speech audio.
API key with the callblasting service enabled · 60 requests per minute
/api/v6/callblasting/calls/audioCall with pre-recorded audio
Sends a call that plays a pre-recorded audio, already uploaded or in the same step.
API key with the callblasting service enabled · 60 requests per minute
/api/v6/callblasting/calls/{id}Call status
Call status and the history of all its attempts.
API key with the callblasting service enabled · 120 requests per minute
/api/v6/callblasting/audiosUpload a pre-recorded audio
Puts an audio in your catalog to reuse across as many calls as you want.
API key with the callblasting service enabled · 30 requests per minute
/api/v6/callblasting/audiosList pre-recorded audios
Your organization audios with their id, duration and size.
API key with the callblasting service enabled · 60 requests per minute
/api/v6/callblasting/voicesList available voices
Filterable catalog of voices for call synthesis.
API key with the callblasting service enabled · 120 requests per minute
Account
Billing summary for the organization: balance or credit, spending limits and movements. Sensitive financial data.
/api/v6/account/billingBilling summary
Mode, currency and available balance or remaining credit for the organization.
API key with the account capability granted · 20 requests per minute
/api/v6/account/usageUsage by scope
Period usage broken down by organization, cost center, user, key and service.
API key with the account capability granted · 20 requests per minute
/api/v6/account/paymentsPayments history
Prepaid top-ups and postpaid invoice payments, from a single source.
API key with the account capability granted · 30 requests per minute
/api/v6/account/adjustmentsBalance adjustments
Manual balance adjustments applied to the account.
API key with the account capability granted · 30 requests per minute
/api/v6/account/limitsSpending limits
Active spending limits for the account, by scope. Read-only.
API key with the account capability granted · 30 requests per minute
Organization
Organization profile, cost centers and users. Includes personal data.
/api/v6/account/organizationOrganization
Profile of the organization that owns the API key.
API key with the directory capability granted · 60 requests per minute
/api/v6/account/cost-centersCost centers
Cost centers of the organization, with the default one flagged.
API key with the directory capability granted · 60 requests per minute
/api/v6/account/usersUsers
Organization members, with role, cost center and status.
API key with the directory capability granted · 30 requests per minute
Platform
Operational status of the services and a catalog of what your account has enabled.