Twilio - Proxy API

by twilio.com

HTTP BasicHTTPSPhone

Overview

This is the public Twilio REST API.

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

At a glance

Authentication: HTTP Basic
HTTPS: Yes
CORS: Unknown
Category: Phone
Base URL: https://proxy.twilio.com
Version: 1.42.0
Endpoints: 30
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://proxy.twilio.com/v1/Services" \
  -H "Accept: application/json" \
  -H "Authorization: Basic BASE64_USER_PASSWORD"

JavaScript

const response = await fetch("https://proxy.twilio.com/v1/Services", {
  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://proxy.twilio.com/v1/Services",
    headers={
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/v1/Services`	Retrieve a list of all Services for Twilio Proxy. A maximum of 100 records will be returned per page.
POST	`/v1/Services`	Create a new Service for Twilio Proxy
GET	`/v1/Services/{ServiceSid}/PhoneNumbers`	Retrieve a list of all Phone Numbers in the Proxy Number Pool for a Service. A maximum of 100 records will be returned per page.
POST	`/v1/Services/{ServiceSid}/PhoneNumbers`	Add a Phone Number to a Service's Proxy Number Pool.
GET	`/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}`	Fetch a specific Phone Number.
POST	`/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}`	Update a specific Proxy Number.
DELETE	`/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}`	Delete a specific Phone Number from a Service.
GET	`/v1/Services/{ServiceSid}/Sessions`	Retrieve a list of all Sessions for the Service. A maximum of 100 records will be returned per page.
POST	`/v1/Services/{ServiceSid}/Sessions`	Create a new Session
GET	`/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions`	Retrieve a list of all Interactions for a Session. A maximum of 100 records will be returned per page.
GET	`/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid}`	Retrieve a list of Interactions for a given [Session](https://www.twilio.com/docs/proxy/api/session).
DELETE	`/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid}`	Delete a specific Interaction.
GET	`/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants`	Retrieve a list of all Participants in a Session.
POST	`/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants`	Add a new Participant to the Session
GET	`/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions`	ListMessageInteraction
POST	`/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions`	Create a new message Interaction to send directly from your system to one [Participant](https://www.twilio.com/docs/proxy/api/participant). The `inbound` prope
GET	`/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions/{Sid}`	FetchMessageInteraction
GET	`/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}`	Fetch a specific Participant.
DELETE	`/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}`	Delete a specific Participant. This is a soft-delete. The participant remains associated with the session and cannot be re-added. Participants are only permanen
GET	`/v1/Services/{ServiceSid}/Sessions/{Sid}`	Fetch a specific Session.
POST	`/v1/Services/{ServiceSid}/Sessions/{Sid}`	Update a specific Session.
DELETE	`/v1/Services/{ServiceSid}/Sessions/{Sid}`	Delete a specific Session.
GET	`/v1/Services/{ServiceSid}/ShortCodes`	Retrieve a list of all Short Codes in the Proxy Number Pool for the Service. A maximum of 100 records will be returned per page.
POST	`/v1/Services/{ServiceSid}/ShortCodes`	Add a Short Code to the Proxy Number Pool for the Service.
GET	`/v1/Services/{ServiceSid}/ShortCodes/{Sid}`	Fetch a specific Short Code.
POST	`/v1/Services/{ServiceSid}/ShortCodes/{Sid}`	Update a specific Short Code.
DELETE	`/v1/Services/{ServiceSid}/ShortCodes/{Sid}`	Delete a specific Short Code from a Service.
GET	`/v1/Services/{Sid}`	Fetch a specific Service.
POST	`/v1/Services/{Sid}`	Update a specific Service.
DELETE	`/v1/Services/{Sid}`	Delete a specific Service.

Questions

Does the Twilio - Proxy API need an API key?

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

Does the Twilio - Proxy API support HTTPS?

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

How many endpoints does the Twilio - Proxy API have?

Its OpenAPI description lists 30 endpoints in version 1.42.0. All of them are shown on this page.

What are alternatives to the Twilio - Proxy 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