Twilio - Flex API

by twilio.com

HTTP BasicHTTPSPhone

Overview

This is the public Twilio REST API.

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

At a glance

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

JavaScript

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

Endpoints

Method	Path	What it does
GET	`/v1/Channels`	ListChannel
POST	`/v1/Channels`	CreateChannel
GET	`/v1/Channels/{Sid}`	FetchChannel
DELETE	`/v1/Channels/{Sid}`	DeleteChannel
GET	`/v1/Configuration`	FetchConfiguration
GET	`/v1/FlexFlows`	ListFlexFlow
POST	`/v1/FlexFlows`	CreateFlexFlow
GET	`/v1/FlexFlows/{Sid}`	FetchFlexFlow
POST	`/v1/FlexFlows/{Sid}`	UpdateFlexFlow
DELETE	`/v1/FlexFlows/{Sid}`	DeleteFlexFlow
GET	`/v1/Insights/Conversations`	To get conversation with segment id
GET	`/v1/Insights/QM/Assessments`	Get assessments done for a conversation by logged in user
POST	`/v1/Insights/QM/Assessments`	Add assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for each and every
GET	`/v1/Insights/QM/Assessments/Comments`	To create a comment assessment for a conversation
POST	`/v1/Insights/QM/Assessments/Comments`	To create a comment assessment for a conversation
POST	`/v1/Insights/QM/Assessments/{AssessmentId}`	Update a specific Assessment assessed earlier
GET	`/v1/Insights/QM/Categories`	To get all the categories
POST	`/v1/Insights/QM/Categories`	To create a category for Questions
POST	`/v1/Insights/QM/Categories/{CategoryId}`	To update the category for Questions
DELETE	`/v1/Insights/QM/Categories/{CategoryId}`	DeleteInsightsQuestionnairesCategory
GET	`/v1/Insights/QM/Questionnaires`	To get all questionnaires with questions
POST	`/v1/Insights/QM/Questionnaires`	To create a Questionnaire
GET	`/v1/Insights/QM/Questionnaires/{Id}`	To get the Questionnaire Detail
POST	`/v1/Insights/QM/Questionnaires/{Id}`	To update the questionnaire
DELETE	`/v1/Insights/QM/Questionnaires/{Id}`	To delete the questionnaire
GET	`/v1/Insights/QM/Questions`	To get all the question for the given categories
POST	`/v1/Insights/QM/Questions`	To create a question for a Category
POST	`/v1/Insights/QM/Questions/{QuestionId}`	To update the question
DELETE	`/v1/Insights/QM/Questions/{QuestionId}`	DeleteInsightsQuestionnairesQuestion
GET	`/v1/Insights/QM/Settings/AnswerSets`	To get the Answer Set Settings for an Account
GET	`/v1/Insights/QM/Settings/CommentTags`	To get the Comment Settings for an Account
GET	`/v1/Insights/Segments`	To get segments for given reservation Ids
GET	`/v1/Insights/Segments/{SegmentId}`	To get the Segments of an Account
POST	`/v1/Insights/Session`	To obtain session details for fetching reports and dashboards
GET	`/v1/Insights/UserRoles`	This is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user
POST	`/v1/Interactions`	Create a new Interaction.
GET	`/v1/Interactions/{InteractionSid}/Channels`	List all Channels for an Interaction.
GET	`/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites`	List all Invites for a Channel.
POST	`/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites`	Invite an Agent or a TaskQueue to a Channel.
GET	`/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants`	List all Participants for a Channel.
POST	`/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants`	Add a Participant to a Channel.
POST	`/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}`	Update an existing Channel Participant.
GET	`/v1/Interactions/{InteractionSid}/Channels/{Sid}`	Fetch a Channel for an Interaction.
POST	`/v1/Interactions/{InteractionSid}/Channels/{Sid}`	Update an existing Interaction Channel.
GET	`/v1/Interactions/{Sid}`	FetchInteraction
GET	`/v1/WebChannels`	ListWebChannel
POST	`/v1/WebChannels`	CreateWebChannel
GET	`/v1/WebChannels/{Sid}`	FetchWebChannel
POST	`/v1/WebChannels/{Sid}`	UpdateWebChannel
DELETE	`/v1/WebChannels/{Sid}`	DeleteWebChannel
POST	`/v2/WebChats`	CreateWebChannel

Questions

Does the Twilio - Flex API need an API key?

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

Does the Twilio - Flex API support HTTPS?

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

How many endpoints does the Twilio - Flex API have?

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

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