Twilio - Preview API

by twilio.com

HTTP BasicHTTPSPhone

Overview

This is the public Twilio REST API.

Twilio - Preview is a phone API from twilio.com. Requests are authenticated with HTTP Basic auth. It is served over HTTPS. Its OpenAPI description documents 147 endpoints.

At a glance

Authentication: HTTP Basic
HTTPS: Yes
CORS: Unknown
Category: Phone
Base URL: https://preview.twilio.com
Version: 1.42.0
Endpoints: 147
OpenAPI: Specification ↗
Spec updated: 2023-04-20

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://preview.twilio.com/DeployedDevices/Fleets" \
  -H "Accept: application/json" \
  -H "Authorization: Basic BASE64_USER_PASSWORD"

JavaScript

const response = await fetch("https://preview.twilio.com/DeployedDevices/Fleets", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://preview.twilio.com/DeployedDevices/Fleets",
    headers={
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/DeployedDevices/Fleets`	Retrieve a list of all Fleets belonging to your account.
POST	`/DeployedDevices/Fleets`	Create a new Fleet for scoping of deployed devices within your account.
GET	`/DeployedDevices/Fleets/{FleetSid}/Certificates`	Retrieve a list of all Certificate credentials belonging to the Fleet.
POST	`/DeployedDevices/Fleets/{FleetSid}/Certificates`	Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.
GET	`/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}`	Fetch information about a specific Certificate credential in the Fleet.
POST	`/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}`	Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.
DELETE	`/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}`	Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.
GET	`/DeployedDevices/Fleets/{FleetSid}/Deployments`	Retrieve a list of all Deployments belonging to the Fleet.
POST	`/DeployedDevices/Fleets/{FleetSid}/Deployments`	Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.
GET	`/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}`	Fetch information about a specific Deployment in the Fleet.
POST	`/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}`	Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.
DELETE	`/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}`	Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.
GET	`/DeployedDevices/Fleets/{FleetSid}/Devices`	Retrieve a list of all Devices belonging to the Fleet.
POST	`/DeployedDevices/Fleets/{FleetSid}/Devices`	Create a new Device in the Fleet, optionally giving it a unique name, friendly name, and assigning to a Deployment and/or human identity.
GET	`/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}`	Fetch information about a specific Device in the Fleet.
POST	`/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}`	Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.
DELETE	`/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}`	Delete a specific Device from the Fleet, also removing it from associated Deployments.
GET	`/DeployedDevices/Fleets/{FleetSid}/Keys`	Retrieve a list of all Keys credentials belonging to the Fleet.
POST	`/DeployedDevices/Fleets/{FleetSid}/Keys`	Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.
GET	`/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}`	Fetch information about a specific Key credential in the Fleet.
POST	`/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}`	Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.
DELETE	`/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}`	Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.
GET	`/DeployedDevices/Fleets/{Sid}`	Fetch information about a specific Fleet in your account.
POST	`/DeployedDevices/Fleets/{Sid}`	Update the friendly name property of a specific Fleet in your account.
DELETE	`/DeployedDevices/Fleets/{Sid}`	Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.
GET	`/HostedNumbers/AuthorizationDocuments`	Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.
POST	`/HostedNumbers/AuthorizationDocuments`	Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.
GET	`/HostedNumbers/AuthorizationDocuments/{Sid}`	Fetch a specific AuthorizationDocument.
POST	`/HostedNumbers/AuthorizationDocuments/{Sid}`	Updates a specific AuthorizationDocument.
GET	`/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders`	Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.
GET	`/HostedNumbers/HostedNumberOrders`	Retrieve a list of HostedNumberOrders belonging to the account initiating the request.
POST	`/HostedNumbers/HostedNumberOrders`	Host a phone number's capability on Twilio's platform.
GET	`/HostedNumbers/HostedNumberOrders/{Sid}`	Fetch a specific HostedNumberOrder.
POST	`/HostedNumbers/HostedNumberOrders/{Sid}`	Updates a specific HostedNumberOrder.
DELETE	`/HostedNumbers/HostedNumberOrders/{Sid}`	Cancel the HostedNumberOrder (only available when the status is in `received`).
GET	`/Sync/Services`	ListSyncService
POST	`/Sync/Services`	CreateSyncService
GET	`/Sync/Services/{ServiceSid}/Documents`	ListSyncDocument
POST	`/Sync/Services/{ServiceSid}/Documents`	CreateSyncDocument
GET	`/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions`	Retrieve a list of all Permissions applying to a Sync Document.
GET	`/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}`	Fetch a specific Sync Document Permission.
POST	`/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}`	Update an identity's access to a specific Sync Document.
DELETE	`/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}`	Delete a specific Sync Document Permission.
GET	`/Sync/Services/{ServiceSid}/Documents/{Sid}`	FetchSyncDocument
POST	`/Sync/Services/{ServiceSid}/Documents/{Sid}`	UpdateSyncDocument
DELETE	`/Sync/Services/{ServiceSid}/Documents/{Sid}`	DeleteSyncDocument
GET	`/Sync/Services/{ServiceSid}/Lists`	ListSyncSyncList
POST	`/Sync/Services/{ServiceSid}/Lists`	CreateSyncSyncList
GET	`/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items`	ListSyncSyncListItem
POST	`/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items`	CreateSyncSyncListItem
GET	`/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}`	FetchSyncSyncListItem
POST	`/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}`	UpdateSyncSyncListItem
DELETE	`/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}`	DeleteSyncSyncListItem
GET	`/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions`	Retrieve a list of all Permissions applying to a Sync List.
GET	`/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}`	Fetch a specific Sync List Permission.
POST	`/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}`	Update an identity's access to a specific Sync List.
DELETE	`/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}`	Delete a specific Sync List Permission.
GET	`/Sync/Services/{ServiceSid}/Lists/{Sid}`	FetchSyncSyncList
DELETE	`/Sync/Services/{ServiceSid}/Lists/{Sid}`	DeleteSyncSyncList
GET	`/Sync/Services/{ServiceSid}/Maps`	ListSyncSyncMap
POST	`/Sync/Services/{ServiceSid}/Maps`	CreateSyncSyncMap
GET	`/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items`	ListSyncSyncMapItem
POST	`/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items`	CreateSyncSyncMapItem
GET	`/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}`	FetchSyncSyncMapItem
POST	`/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}`	UpdateSyncSyncMapItem
DELETE	`/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}`	DeleteSyncSyncMapItem
GET	`/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions`	Retrieve a list of all Permissions applying to a Sync Map.
GET	`/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}`	Fetch a specific Sync Map Permission.
POST	`/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}`	Update an identity's access to a specific Sync Map.
DELETE	`/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}`	Delete a specific Sync Map Permission.
GET	`/Sync/Services/{ServiceSid}/Maps/{Sid}`	FetchSyncSyncMap
DELETE	`/Sync/Services/{ServiceSid}/Maps/{Sid}`	DeleteSyncSyncMap
GET	`/Sync/Services/{Sid}`	FetchSyncService
POST	`/Sync/Services/{Sid}`	UpdateSyncService
DELETE	`/Sync/Services/{Sid}`	DeleteSyncService
GET	`/marketplace/AvailableAddOns`	Retrieve a list of Add-ons currently available to be installed.
GET	`/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions`	Retrieve a list of Extensions for the Available Add-on.
GET	`/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}`	Fetch an instance of an Extension for the Available Add-on.
GET	`/marketplace/AvailableAddOns/{Sid}`	Fetch an instance of an Add-on currently available to be installed.
GET	`/marketplace/InstalledAddOns`	Retrieve a list of Add-ons currently installed on this Account.
POST	`/marketplace/InstalledAddOns`	Install an Add-on for the Account specified.
GET	`/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions`	Retrieve a list of Extensions for the Installed Add-on.
GET	`/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}`	Fetch an instance of an Extension for the Installed Add-on.
POST	`/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}`	Update an Extension for an Add-on installation.
GET	`/marketplace/InstalledAddOns/{Sid}`	Fetch an instance of an Add-on currently installed on this Account.
POST	`/marketplace/InstalledAddOns/{Sid}`	Update an Add-on installation for the Account specified.
DELETE	`/marketplace/InstalledAddOns/{Sid}`	Remove an Add-on installation from your account
GET	`/understand/Assistants`	ListUnderstandAssistant
POST	`/understand/Assistants`	CreateUnderstandAssistant
GET	`/understand/Assistants/{AssistantSid}/Dialogues/{Sid}`	FetchUnderstandDialogue
GET	`/understand/Assistants/{AssistantSid}/FallbackActions`	FetchUnderstandAssistantFallbackActions
POST	`/understand/Assistants/{AssistantSid}/FallbackActions`	UpdateUnderstandAssistantFallbackActions
GET	`/understand/Assistants/{AssistantSid}/FieldTypes`	ListUnderstandFieldType
POST	`/understand/Assistants/{AssistantSid}/FieldTypes`	CreateUnderstandFieldType
GET	`/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues`	ListUnderstandFieldValue
POST	`/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues`	CreateUnderstandFieldValue
GET	`/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}`	FetchUnderstandFieldValue
DELETE	`/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}`	DeleteUnderstandFieldValue
GET	`/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}`	FetchUnderstandFieldType
POST	`/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}`	UpdateUnderstandFieldType

Showing the first 100 of 147 endpoints; the full list is in the documentation.

Questions

Does the Twilio - Preview API need an API key?

Yes. The Twilio - Preview API uses HTTP Basic authentication; the documentation explains how to get credentials.

Does the Twilio - Preview API support HTTPS?

Yes, the Twilio - Preview API is served over HTTPS.

How many endpoints does the Twilio - Preview API have?

Its OpenAPI description lists 147 endpoints in version 1.42.0. The first 100 are shown on this page.

What are alternatives to the Twilio - Preview API?

Other Phone APIs include Twilio - Accounts, ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, Twilio - Api, Mobility API, Telnyx API.

Compare alternatives →

Twilio - Accounts

Phone

This is the public Twilio REST API.

HTTP Basic13 endpoints

ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management

Phone

ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.

No auth16 endpoints

Twilio - Api

Phone

This is the public Twilio REST API.

HTTP Basic199 endpoints

Mobility API

Phone

Transit API can be used to obtain time-aggregated data representing moving the people between various spatial points within the Czech Republic. Having A - 'from' and B - 'to' points, the API can return count of people traveling from A to B or people that are from A and traveling to B, etc. The mobility data is based on moving mobile stations in O2 mobile network.

No auth2 endpoints