API reference

Ping

Confirms your API key is valid and shows what the API knows about the caller.

Any valid API key · 20 requests per minute

List countries

Full country catalog with ISO code, calling code and MCC.

Any valid API key · 60 requests per minute

Get a country

One country by its ISO 3166-1 alpha-2 code.

Any valid API key · 60 requests per minute

Single number lookup

Country, line type, current carrier and area of a phone number.

Any valid API key · 60 requests per minute

Batch lookup

Resolve many numbers in a single request, inline or as an asynchronous job.

Any valid API key · 10 requests per minute

Batch job status

State of an asynchronous job and the download URL of its result.

Any valid API key · 60 requests per minute

Create a short link

Publish a short link with a generated code or your own alias. Charged on creation, unless your plan includes it.

API key with the urlshortener service enabled and the urlshortener.write capability granted · 35 requests per second

Create short links in bulk

Up to 1,000 links in one request, with one result per link and a single charge for what was created.

API key with the urlshortener service enabled and the urlshortener.write capability granted · 35 requests per second

List short links

Your links, paginated, with search, filters, sorting and their visit counters.

API key with the urlshortener service enabled · 30 requests per minute

List available domains

Domains your organization can publish links on, with the default first.

API key with the urlshortener service enabled · 30 requests per minute

Get a short link

One of your links by domain and code.

API key with the urlshortener service enabled · 60 requests per minute

Update a short link

Change the destination, the status or the expiry. Domain and code do not change.

API key with the urlshortener service enabled and the urlshortener.write capability granted · 35 requests per second

Delete a short link

The link stops redirecting and disappears from the API. Its code stays taken, and you can restore it for 90 days.

API key with the urlshortener service enabled and the urlshortener.write capability granted · 35 requests per second

Restore a deleted link

Brings back a link of yours that you deleted, with the same code and no new charge.

API key with the urlshortener service enabled and the urlshortener.write capability granted · 35 requests per second

Link statistics

Range totals, a daily or hourly series and breakdowns by country, device, OS, browser or source.

API key with the urlshortener service enabled · 120 requests per minute

Organization overview

Inventory, range activity against the previous period, trends, top links and breakdowns for your whole organization.

API key with the urlshortener service enabled · 120 requests per minute

Current pricing

What creating a link and each visit cost your organization, and whether its plan includes it.

API key with the urlshortener service enabled · 60 requests per minute

Synthesize text to speech

Turns a text into audio and returns its reference. Synchronous.

API key with the tts service enabled · 60 requests per minute

Synthesis status

Metadata of a synthesis request by its id.

API key with the tts service enabled · 120 requests per minute

List available voices

Filterable catalog of synthesis voices.

API key with the tts service enabled · 120 requests per minute

Call with generated voice

Sends a call that plays a text-to-speech audio.

API key with the callblasting service enabled · 60 requests per minute

Call 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

Call status

Call status and the history of all its attempts.

API key with the callblasting service enabled · 120 requests per minute

Upload 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

List pre-recorded audios

Your organization audios with their id, duration and size.

API key with the callblasting service enabled · 60 requests per minute

List available voices

Filterable catalog of voices for call synthesis.

API key with the callblasting service enabled · 120 requests per minute

Billing summary

Mode, currency and available balance or remaining credit for the organization.

API key with the account capability granted · 20 requests per minute

Usage 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

Payments history

Prepaid top-ups and postpaid invoice payments, from a single source.

API key with the account capability granted · 30 requests per minute

Balance adjustments

Manual balance adjustments applied to the account.

API key with the account capability granted · 30 requests per minute

Spending limits

Active spending limits for the account, by scope. Read-only.

API key with the account capability granted · 30 requests per minute

Organization

Profile of the organization that owns the API key.

API key with the directory capability granted · 60 requests per minute

Cost centers

Cost centers of the organization, with the default one flagged.

API key with the directory capability granted · 60 requests per minute

Users

Organization members, with role, cost center and status.

API key with the directory capability granted · 30 requests per minute

Service status

Operational status of the services, compact enough for your monitoring.

Any valid API key · 60 requests per minute

Service catalog

Live platform services and whether this account has access to each one.

Any valid API key · 60 requests per minute