Twilio

Conversation Orchestrator

Manage configurations, conversations, participants, and communications. Create configurations to define capture rules and channel settings, then use…

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

Manage configurations, conversations, participants, and communications. Create configurations to define capture rules and channel settings, then use conversations to group related communications.

Endpoints 22

ConversationsV2Configuration

  • GETList Configurations/v2/ControlPlane/Configurations?pageSize=50&pageToken=eyJwYWdlIjoyLCJxdWVyeSI6ImJvb2tzIn0=&memoryStoreId=mem_store_01k1etk2y5f1y9fpe2epfdtvv2Retrieve a list of Configurations.
  • POSTCreate a Configuration/v2/ControlPlane/ConfigurationsCreate a new Configuration
  • GETFetch Configuration/v2/ControlPlane/Configurations/:idRetrieve a Configuration.
  • PUTUpdate Configuration/v2/ControlPlane/Configurations/:idUpdate an existing Configuration
  • DELETEDelete Configuration/v2/ControlPlane/Configurations/:idDelete a Configuration
  • PATCHPatch Configuration/v2/ControlPlane/Configurations/:idPartially update a Configuration. Only fields present in the request body are changed; omitted fields are left untouched. For channelSettings, an omitted…

ConversationsV2Conversation

  • GETList Conversations/v2/Conversations?status=ACTIVE&channelId=string&pageSize=50&pageToken=eyJwYWdlIjoyLCJxdWVyeSI6ImJvb2tzIn0=Retrieve a list of Conversations.
  • POSTCreate a new Conversation/v2/ConversationsCreate a new conversation
  • GETFetch Conversation/v2/Conversations/:idRetrieve a Conversation.
  • PUTUpdate a Conversation/v2/Conversations/:idUpdate an existing conversation
  • DELETEDelete a Conversation (async)/v2/Conversations/:idAsynchronously delete a conversation and all associated data. Returns 202 Accepted with an Operation-Id for status tracking via GET…
  • PATCHPartially Update a Conversation/v2/Conversations/:idPartially update the details of an existing Conversation.

ConversationsV2Participant

  • GETList Participants/v2/Conversations/:ConversationId/Participants?pageSize=50&pageToken=stringRetrieve a list of Participants in a Conversation.
  • POSTCreate Participant/v2/Conversations/:ConversationId/ParticipantsCreate a Participant.
  • GETFetch Participant/v2/Conversations/:ConversationId/Participants/:idRetrieve a Participant.
  • PUTUpdate a Participant/v2/Conversations/:ConversationId/Participants/:idUpdate an existing Participant

ConversationsV2Communication

  • GETList Communications/v2/Conversations/:ConversationId/Communications?channelId=string&pageSize=50&pageToken=stringRetrieve a list of Communications in a Conversation.
  • POSTCreate Communication/v2/Conversations/:ConversationId/CommunicationsCreate a Communication.
  • GETFetch Communication/v2/Conversations/:ConversationId/Communications/:idRetrieve a Communication.

ConversationsV2Action

  • POSTCreate an Action/v2/Conversations/:ConversationId/ActionsCreates an Action within a Conversation. Currently supports SEND_MESSAGE, which sends a message to recipients via the configured channel. Returns 202 Accepted…
  • GETGet Action Status/v2/Conversations/:ConversationId/Actions/:ActionIdRetrieve the current status of an Action.

ConversationsV2Operation

  • GETGet Operation Status/v2/ControlPlane/Operations/:idRetrieve the current status of a long-running operation. Operations progress through: PENDING -> RUNNING -> COMPLETED or FAILED.

API details

Base URL
https://conversations.twilio.com
Authentication
HTTP Basic authentication (username and password)
Operations
22 operations on 11 pathsGET 10POST 5PUT 3PATCH 2DELETE 2
Main resources
ConversationsV2Configuration 6ConversationsV2Conversation 6ConversationsV2Participant 4ConversationsV2Communication 3ConversationsV2Action 2ConversationsV2Operation 1
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 2.0.0

How to test the Conversation Orchestrator 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 Conversation Orchestrator 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 “List Configurations” (GET /v2/ControlPlane/Configurations?pageSize=50&pageToken=eyJwYWdlIjoyLCJxdWVyeSI6ImJvb2tzIn0=&memoryStoreId=mem_store_01k1etk2y5f1y9fpe2epfdtvv2), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Conversation Orchestrator?

Manage configurations, conversations, participants, and communications. Create configurations to define capture rules and channel settings, then use… It is listed under Communication and has 22 endpoints.

Who publishes the Conversation Orchestrator?

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 Conversation Orchestrator?

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

How do I authenticate with the Conversation Orchestrator?

With HTTP Basic authentication (username and password).

How many endpoints does the Conversation Orchestrator have?

22 operations on 11 paths (10 GET, 5 POST, 3 PUT, 2 PATCH, 2 DELETE). The largest groups are ConversationsV2Configuration, ConversationsV2Conversation, ConversationsV2Participant, ConversationsV2Communication.

Is forking the Conversation Orchestrator 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.