Skip to content

Twilio - Numbers API

by twilio.com

HTTP BasicHTTPSPhone
Open documentation ↗

Overview

This is the public Twilio REST API.

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

At a glance

Authentication
HTTP Basic
HTTPS
Yes
CORS
Unknown
Category
Phone
Base URL
https://numbers.twilio.com
Version
1.42.0
Endpoints
31
Spec updated
2023-04-20

Make a first request

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

cURL
curl -X GET "https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles" \
  -H "Accept: application/json" \
  -H "Authorization: Basic BASE64_USER_PASSWORD"
JavaScript
const response = await fetch("https://numbers.twilio.com/v2/RegulatoryCompliance/Bundles", {
  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://numbers.twilio.com/v2/RegulatoryCompliance/Bundles",
    headers={
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v2/RegulatoryCompliance/BundlesRetrieve a list of all Bundles for an account.
POST/v2/RegulatoryCompliance/BundlesCreate a new Bundle.
GET/v2/RegulatoryCompliance/Bundles/{BundleSid}/CopiesRetrieve a list of all Bundles Copies for a Bundle.
POST/v2/RegulatoryCompliance/Bundles/{BundleSid}/CopiesCreates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle
GET/v2/RegulatoryCompliance/Bundles/{BundleSid}/EvaluationsRetrieve a list of Evaluations associated to the Bundle resource.
POST/v2/RegulatoryCompliance/Bundles/{BundleSid}/EvaluationsCreates an evaluation for a bundle
GET/v2/RegulatoryCompliance/Bundles/{BundleSid}/Evaluations/{Sid}Fetch specific Evaluation Instance.
GET/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignmentsRetrieve a list of all Assigned Items for an account.
POST/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignmentsCreate a new Assigned Item.
GET/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}Fetch specific Assigned Item Instance.
DELETE/v2/RegulatoryCompliance/Bundles/{BundleSid}/ItemAssignments/{Sid}Remove an Assignment Item Instance.
POST/v2/RegulatoryCompliance/Bundles/{BundleSid}/ReplaceItemsReplaces all bundle items in the target bundle (specified in the path) with all the bundle items of the source bundle (specified by the from_bundle_sid body par
GET/v2/RegulatoryCompliance/Bundles/{Sid}Fetch a specific Bundle instance.
POST/v2/RegulatoryCompliance/Bundles/{Sid}Updates a Bundle in an account.
DELETE/v2/RegulatoryCompliance/Bundles/{Sid}Delete a specific Bundle.
GET/v2/RegulatoryCompliance/EndUserTypesRetrieve a list of all End-User Types.
GET/v2/RegulatoryCompliance/EndUserTypes/{Sid}Fetch a specific End-User Type Instance.
GET/v2/RegulatoryCompliance/EndUsersRetrieve a list of all End User for an account.
POST/v2/RegulatoryCompliance/EndUsersCreate a new End User.
GET/v2/RegulatoryCompliance/EndUsers/{Sid}Fetch specific End User Instance.
POST/v2/RegulatoryCompliance/EndUsers/{Sid}Update an existing End User.
DELETE/v2/RegulatoryCompliance/EndUsers/{Sid}Delete a specific End User.
GET/v2/RegulatoryCompliance/RegulationsRetrieve a list of all Regulations.
GET/v2/RegulatoryCompliance/Regulations/{Sid}Fetch specific Regulation Instance.
GET/v2/RegulatoryCompliance/SupportingDocumentTypesRetrieve a list of all Supporting Document Types.
GET/v2/RegulatoryCompliance/SupportingDocumentTypes/{Sid}Fetch a specific Supporting Document Type Instance.
GET/v2/RegulatoryCompliance/SupportingDocumentsRetrieve a list of all Supporting Document for an account.
POST/v2/RegulatoryCompliance/SupportingDocumentsCreate a new Supporting Document.
GET/v2/RegulatoryCompliance/SupportingDocuments/{Sid}Fetch specific Supporting Document Instance.
POST/v2/RegulatoryCompliance/SupportingDocuments/{Sid}Update an existing Supporting Document.
DELETE/v2/RegulatoryCompliance/SupportingDocuments/{Sid}Delete a specific Supporting Document.

Questions

Does the Twilio - Numbers API need an API key?

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

Does the Twilio - Numbers API support HTTPS?

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

How many endpoints does the Twilio - Numbers API have?

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

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

Listed from APIs.guru (CC0).