Twilio - Studio API

by twilio.com

HTTP BasicHTTPSPhone

Overview

This is the public Twilio REST API.

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

At a glance

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

JavaScript

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

Endpoints

Method	Path	What it does
GET	`/v1/Flows`	Retrieve a list of all Flows.
GET	`/v1/Flows/{FlowSid}/Engagements`	Retrieve a list of all Engagements for the Flow.
POST	`/v1/Flows/{FlowSid}/Engagements`	Triggers a new Engagement for the Flow
GET	`/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context`	Retrieve the most recent context for an Engagement.
GET	`/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps`	Retrieve a list of all Steps for an Engagement.
GET	`/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid}`	Retrieve a Step.
GET	`/v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{StepSid}/Context`	Retrieve the context for an Engagement Step.
GET	`/v1/Flows/{FlowSid}/Engagements/{Sid}`	Retrieve an Engagement
DELETE	`/v1/Flows/{FlowSid}/Engagements/{Sid}`	Delete this Engagement and all Steps relating to it.
GET	`/v1/Flows/{FlowSid}/Executions`	Retrieve a list of all Executions for the Flow.
POST	`/v1/Flows/{FlowSid}/Executions`	Triggers a new Execution for the Flow
GET	`/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Context`	Retrieve the most recent context for an Execution.
GET	`/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps`	Retrieve a list of all Steps for an Execution.
GET	`/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}`	Retrieve a Step.
GET	`/v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context`	Retrieve the context for an Execution Step.
GET	`/v1/Flows/{FlowSid}/Executions/{Sid}`	Retrieve an Execution
POST	`/v1/Flows/{FlowSid}/Executions/{Sid}`	Update the status of an Execution to `ended`.
DELETE	`/v1/Flows/{FlowSid}/Executions/{Sid}`	Delete the Execution and all Steps relating to it.
GET	`/v1/Flows/{Sid}`	Retrieve a specific Flow.
DELETE	`/v1/Flows/{Sid}`	Delete a specific Flow.
GET	`/v2/Flows`	Retrieve a list of all Flows.
POST	`/v2/Flows`	Create a Flow.
POST	`/v2/Flows/Validate`	Validate flow JSON definition
GET	`/v2/Flows/{FlowSid}/Executions`	Retrieve a list of all Executions for the Flow.
POST	`/v2/Flows/{FlowSid}/Executions`	Triggers a new Execution for the Flow
GET	`/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Context`	Retrieve the most recent context for an Execution.
GET	`/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps`	Retrieve a list of all Steps for an Execution.
GET	`/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}`	Retrieve a Step.
GET	`/v2/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context`	Retrieve the context for an Execution Step.
GET	`/v2/Flows/{FlowSid}/Executions/{Sid}`	Retrieve an Execution
POST	`/v2/Flows/{FlowSid}/Executions/{Sid}`	Update the status of an Execution to `ended`.
DELETE	`/v2/Flows/{FlowSid}/Executions/{Sid}`	Delete the Execution and all Steps relating to it.
GET	`/v2/Flows/{Sid}`	Retrieve a specific Flow.
POST	`/v2/Flows/{Sid}`	Update a Flow.
DELETE	`/v2/Flows/{Sid}`	Delete a specific Flow.
GET	`/v2/Flows/{Sid}/Revisions`	Retrieve a list of all Flows revisions.
GET	`/v2/Flows/{Sid}/Revisions/{Revision}`	Retrieve a specific Flow revision.
GET	`/v2/Flows/{Sid}/TestUsers`	Fetch flow test users
POST	`/v2/Flows/{Sid}/TestUsers`	Update flow test users

Questions

Does the Twilio - Studio API need an API key?

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

Does the Twilio - Studio API support HTTPS?

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

How many endpoints does the Twilio - Studio API have?

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

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