Twilio

Twilio Flex v1

This is the public Twilio REST API.

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the public Twilio REST API.

Endpoints 73

FlexV1Assessments

  • GETGet assessments done for a conversation by logged in user/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=1&Page=0&PageToken=stringGet assessments done for a conversation by logged in user
  • POSTAdd 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 question./v1/Insights/QualityManagement/AssessmentsAdd assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for each and…
  • POSTUpdate a specific Assessment assessed earlier/v1/Insights/QualityManagement/Assessments/:AssessmentSidUpdate a specific Assessment assessed earlier

FlexV1Channel

  • GETListChannel/v1/Channels?PageSize=1&Page=0&PageToken=string
  • POSTCreateChannel/v1/Channels
  • GETFetchChannel/v1/Channels/:Sid
  • DELETEDeleteChannel/v1/Channels/:Sid

FlexV1Configuration

  • GETFetchConfiguration/v1/Configuration?UiVersion=string
  • POSTUpdateConfiguration/v1/Configuration

FlexV1ConfiguredPlugin

  • GETListConfiguredPlugin/v1/PluginService/Configurations/:ConfigurationSid/Plugins?PageSize=1&Page=0&PageToken=string
  • GETFetchConfiguredPlugin/v1/PluginService/Configurations/:ConfigurationSid/Plugins/:PluginSid

FlexV1FlexFlow

  • GETListFlexFlow/v1/FlexFlows?FriendlyName=string&PageSize=1&Page=0&PageToken=string
  • POSTCreateFlexFlow/v1/FlexFlows
  • GETFetchFlexFlow/v1/FlexFlows/:Sid
  • POSTUpdateFlexFlow/v1/FlexFlows/:Sid
  • DELETEDeleteFlexFlow/v1/FlexFlows/:Sid

FlexV1InsightsAssessmentsComment

  • GETTo create a comment assessment for a conversation/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&AgentId=5d80ee80-7608-55df-b2b2-5ab5608b9831&PageSize=1&Page=0&PageToken=stringTo create a comment assessment for a conversation
  • POSTTo create a comment assessment for a conversation/v1/Insights/QualityManagement/Assessments/CommentsTo create a comment assessment for a conversation

FlexV1InsightsConversations

  • GETTo get conversation with segment id/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=1&Page=0&PageToken=stringTo get conversation with segment id

FlexV1InsightsQuestionnaires

  • GETTo get all questionnaires with questions/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=true&PageSize=1&Page=0&PageToken=stringTo get all questionnaires with questions
  • POSTTo create a Questionnaire/v1/Insights/QualityManagement/QuestionnairesTo create a Questionnaire
  • GETTo get the Questionnaire Detail/v1/Insights/QualityManagement/Questionnaires/:QuestionnaireSidTo get the Questionnaire Detail
  • POSTTo update the questionnaire/v1/Insights/QualityManagement/Questionnaires/:QuestionnaireSidTo update the questionnaire
  • DELETETo delete the questionnaire/v1/Insights/QualityManagement/Questionnaires/:QuestionnaireSidTo delete the questionnaire

FlexV1InsightsQuestionnairesCategory

  • GETTo get all the categories/v1/Insights/QualityManagement/Categories?PageSize=1&Page=0&PageToken=stringTo get all the categories
  • POSTTo create a category for Questions/v1/Insights/QualityManagement/CategoriesTo create a category for Questions
  • POSTTo update the category for Questions/v1/Insights/QualityManagement/Categories/:CategorySidTo update the category for Questions
  • DELETEDeleteInsightsQuestionnairesCategory/v1/Insights/QualityManagement/Categories/:CategorySid

FlexV1InsightsQuestionnairesQuestion

  • GETTo get all the question for the given categories/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=1&Page=0&PageToken=stringTo get all the question for the given categories
  • POSTTo create a question for a Category/v1/Insights/QualityManagement/QuestionsTo create a question for a Category
  • POSTTo update the question/v1/Insights/QualityManagement/Questions/:QuestionSidTo update the question
  • DELETEDeleteInsightsQuestionnairesQuestion/v1/Insights/QualityManagement/Questions/:QuestionSid

FlexV1InsightsSegments

  • GETTo get segments for given reservation Ids/v1/Insights/Segments?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a5&ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=1&Page=0&PageToken=stringTo get segments for given reservation Ids

FlexV1InsightsSession

  • POSTTo obtain session details for fetching reports and dashboards/v1/Insights/SessionTo obtain session details for fetching reports and dashboards

FlexV1InsightsSettingsAnswerSets

  • GETTo get the Answer Set Settings for an Account/v1/Insights/QualityManagement/Settings/AnswerSetsTo get the Answer Set Settings for an Account

FlexV1InsightsSettingsComment

  • GETTo get the Comment Settings for an Account/v1/Insights/QualityManagement/Settings/CommentTagsTo get the Comment Settings for an Account

FlexV1InsightsUserRoles

  • GETThis is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user/v1/Insights/UserRolesThis is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user

FlexV1Interaction

  • GETFetchInteraction/v1/Interactions/:Sid
  • POSTUpdates an interaction./v1/Interactions/:SidUpdates an interaction.
  • POSTCreate a new Interaction./v1/InteractionsCreate a new Interaction.

FlexV1InteractionChannel

  • GETFetch a Channel for an Interaction./v1/Interactions/:InteractionSid/Channels/:SidFetch a Channel for an Interaction.
  • POSTUpdate an existing Interaction Channel./v1/Interactions/:InteractionSid/Channels/:SidUpdate an existing Interaction Channel.
  • GETList all Channels for an Interaction./v1/Interactions/:InteractionSid/Channels?PageSize=1&Page=0&PageToken=stringList all Channels for an Interaction.

FlexV1InteractionChannelInvite

  • GETList all Invites for a Channel./v1/Interactions/:InteractionSid/Channels/:ChannelSid/Invites?PageSize=1&Page=0&PageToken=stringList all Invites for a Channel.
  • POSTInvite an Agent or a TaskQueue to a Channel./v1/Interactions/:InteractionSid/Channels/:ChannelSid/InvitesInvite an Agent or a TaskQueue to a Channel.

FlexV1InteractionChannelParticipant

  • GETList all Participants for a Channel./v1/Interactions/:InteractionSid/Channels/:ChannelSid/Participants?PageSize=1&Page=0&PageToken=stringList all Participants for a Channel.
  • POSTAdd a Participant to a Channel./v1/Interactions/:InteractionSid/Channels/:ChannelSid/ParticipantsAdd a Participant to a Channel.
  • POSTUpdate an existing Channel Participant./v1/Interactions/:InteractionSid/Channels/:ChannelSid/Participants/:SidUpdate an existing Channel Participant.

FlexV1InteractionTransfer

  • POSTCreate a new Transfer./v1/Interactions/:InteractionSid/Channels/:ChannelSid/TransfersCreate a new Transfer.
  • GETFetch a specific Transfer by SID./v1/Interactions/:InteractionSid/Channels/:ChannelSid/Transfers/:SidFetch a specific Transfer by SID.
  • POSTUpdate an existing Transfer./v1/Interactions/:InteractionSid/Channels/:ChannelSid/Transfers/:SidUpdate an existing Transfer.

FlexV1Plugin

  • GETListPlugin/v1/PluginService/Plugins?PageSize=1&Page=0&PageToken=string
  • POSTCreatePlugin/v1/PluginService/Plugins
  • GETFetchPlugin/v1/PluginService/Plugins/:Sid
  • POSTUpdatePlugin/v1/PluginService/Plugins/:Sid

FlexV1PluginArchive

  • POSTUpdatePluginArchive/v1/PluginService/Plugins/:Sid/Archive

FlexV1PluginConfiguration

  • GETListPluginConfiguration/v1/PluginService/Configurations?PageSize=1&Page=0&PageToken=string
  • POSTCreatePluginConfiguration/v1/PluginService/Configurations
  • GETFetchPluginConfiguration/v1/PluginService/Configurations/:Sid

FlexV1PluginConfigurationArchive

  • POSTUpdatePluginConfigurationArchive/v1/PluginService/Configurations/:Sid/Archive

FlexV1PluginRelease

  • GETListPluginRelease/v1/PluginService/Releases?PageSize=1&Page=0&PageToken=string
  • POSTCreatePluginRelease/v1/PluginService/Releases
  • GETFetchPluginRelease/v1/PluginService/Releases/:Sid

FlexV1PluginVersionArchive

  • POSTUpdatePluginVersionArchive/v1/PluginService/Plugins/:PluginSid/Versions/:Sid/Archive

FlexV1PluginVersions

  • GETListPluginVersion/v1/PluginService/Plugins/:PluginSid/Versions?PageSize=1&Page=0&PageToken=string
  • POSTCreatePluginVersion/v1/PluginService/Plugins/:PluginSid/Versions
  • GETFetchPluginVersion/v1/PluginService/Plugins/:PluginSid/Versions/:Sid

FlexV1ProvisioningStatus

  • GETFetchProvisioningStatus/v1/account/provision/status

FlexV1WebChannel

  • GETListWebChannel/v1/WebChannels?PageSize=1&Page=0&PageToken=string
  • POSTCreateWebChannel/v1/WebChannels
  • GETFetchWebChannel/v1/WebChannels/:Sid
  • POSTUpdateWebChannel/v1/WebChannels/:Sid
  • DELETEDeleteWebChannel/v1/WebChannels/:Sid

API details

Base URL
https://flex-api.twilio.com
Authentication
HTTP Basic authentication (username and password)
A bearer token in the Authorization header
Operations
73 operations on 45 pathsGET 35POST 32DELETE 6
Main resources
FlexV1FlexFlow 5FlexV1InsightsQuestionnaires 5FlexV1WebChannel 5FlexV1Channel 4FlexV1InsightsQuestionnairesCategory 4FlexV1InsightsQuestionnairesQuestion 4FlexV1Plugin 4FlexV1Assessments 3FlexV1Interaction 3FlexV1InteractionChannel 3
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.0.0

How to test the Twilio Flex v1 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio Flex v1 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get assessments done for a conversation by logged in user” (GET /v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=1&Page=0&PageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio Flex v1?

This is the public Twilio REST API. It is listed under Communication and has 73 endpoints.

Who publishes the Twilio Flex v1?

It is listed from Twilio's public API description (an OpenAPI document), not published by Twilio on Swastik Codes. Anyone who controls twilio.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Twilio Flex v1?

Requests go to https://flex-api.twilio.com. Endpoint paths are added to this base URL.

How do I authenticate with the Twilio Flex v1?

It accepts 2 methods: HTTP Basic authentication (username and password); A bearer token in the Authorization header.

How many endpoints does the Twilio Flex v1 have?

73 operations on 45 paths (35 GET, 32 POST, 6 DELETE). The largest groups are FlexV1FlexFlow, FlexV1InsightsQuestionnaires, FlexV1WebChannel, FlexV1Channel.

Is forking the Twilio Flex v1 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.