Skip to content

Twilio - Conversations API

by twilio.com

HTTP BasicHTTPSPhone
Open documentation ↗

Overview

This is the public Twilio REST API.

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

At a glance

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

Make a first request

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

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

Endpoints

MethodPathWhat it does
GET/v1/ConfigurationFetch the global configuration of conversations on your account
POST/v1/ConfigurationUpdate the global configuration of conversations on your account
GET/v1/Configuration/AddressesRetrieve a list of address configurations for an account
POST/v1/Configuration/AddressesCreate a new address configuration
GET/v1/Configuration/Addresses/{Sid}Fetch an address configuration
POST/v1/Configuration/Addresses/{Sid}Update an existing address configuration
DELETE/v1/Configuration/Addresses/{Sid}Remove an existing address configuration
GET/v1/Configuration/WebhooksFetchConfigurationWebhook
POST/v1/Configuration/WebhooksUpdateConfigurationWebhook
GET/v1/ConversationsRetrieve a list of conversations in your account's default service
POST/v1/ConversationsCreate a new conversation in your account's default service
GET/v1/Conversations/{ConversationSid}/MessagesRetrieve a list of all messages in the conversation
POST/v1/Conversations/{ConversationSid}/MessagesAdd a new message to the conversation
GET/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/ReceiptsRetrieve a list of all delivery and read receipts of the conversation message
GET/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}Fetch the delivery and read receipts of the conversation message
GET/v1/Conversations/{ConversationSid}/Messages/{Sid}Fetch a message from the conversation
POST/v1/Conversations/{ConversationSid}/Messages/{Sid}Update an existing message in the conversation
DELETE/v1/Conversations/{ConversationSid}/Messages/{Sid}Remove a message from the conversation
GET/v1/Conversations/{ConversationSid}/ParticipantsRetrieve a list of all participants of the conversation
POST/v1/Conversations/{ConversationSid}/ParticipantsAdd a new participant to the conversation
GET/v1/Conversations/{ConversationSid}/Participants/{Sid}Fetch a participant of the conversation
POST/v1/Conversations/{ConversationSid}/Participants/{Sid}Update an existing participant in the conversation
DELETE/v1/Conversations/{ConversationSid}/Participants/{Sid}Remove a participant from the conversation
GET/v1/Conversations/{ConversationSid}/WebhooksRetrieve a list of all webhooks scoped to the conversation
POST/v1/Conversations/{ConversationSid}/WebhooksCreate a new webhook scoped to the conversation
GET/v1/Conversations/{ConversationSid}/Webhooks/{Sid}Fetch the configuration of a conversation-scoped webhook
POST/v1/Conversations/{ConversationSid}/Webhooks/{Sid}Update an existing conversation-scoped webhook
DELETE/v1/Conversations/{ConversationSid}/Webhooks/{Sid}Remove an existing webhook scoped to the conversation
GET/v1/Conversations/{Sid}Fetch a conversation from your account's default service
POST/v1/Conversations/{Sid}Update an existing conversation in your account's default service
DELETE/v1/Conversations/{Sid}Remove a conversation from your account's default service
GET/v1/CredentialsRetrieve a list of all push notification credentials on your account
POST/v1/CredentialsAdd a new push notification credential to your account
GET/v1/Credentials/{Sid}Fetch a push notification credential from your account
POST/v1/Credentials/{Sid}Update an existing push notification credential on your account
DELETE/v1/Credentials/{Sid}Remove a push notification credential from your account
GET/v1/ParticipantConversationsRetrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.
GET/v1/RolesRetrieve a list of all user roles in your account's default service
POST/v1/RolesCreate a new user role in your account's default service
GET/v1/Roles/{Sid}Fetch a user role from your account's default service
POST/v1/Roles/{Sid}Update an existing user role in your account's default service
DELETE/v1/Roles/{Sid}Remove a user role from your account's default service
GET/v1/ServicesRetrieve a list of all conversation services on your account
POST/v1/ServicesCreate a new conversation service on your account
GET/v1/Services/{ChatServiceSid}/BindingsRetrieve a list of all push notification bindings in the conversation service
GET/v1/Services/{ChatServiceSid}/Bindings/{Sid}Fetch a push notification binding from the conversation service
DELETE/v1/Services/{ChatServiceSid}/Bindings/{Sid}Remove a push notification binding from the conversation service
GET/v1/Services/{ChatServiceSid}/ConfigurationFetch the configuration of a conversation service
POST/v1/Services/{ChatServiceSid}/ConfigurationUpdate configuration settings of a conversation service
GET/v1/Services/{ChatServiceSid}/Configuration/NotificationsFetch push notification service settings
POST/v1/Services/{ChatServiceSid}/Configuration/NotificationsUpdate push notification service settings
GET/v1/Services/{ChatServiceSid}/Configuration/WebhooksFetch a specific service webhook configuration.
POST/v1/Services/{ChatServiceSid}/Configuration/WebhooksUpdate a specific Webhook.
GET/v1/Services/{ChatServiceSid}/ConversationsRetrieve a list of conversations in your service
POST/v1/Services/{ChatServiceSid}/ConversationsCreate a new conversation in your service
GET/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/MessagesRetrieve a list of all messages in the conversation
POST/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/MessagesAdd a new message to the conversation in a specific service
GET/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/ReceiptsRetrieve a list of all delivery and read receipts of the conversation message
GET/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}Fetch the delivery and read receipts of the conversation message
GET/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}Fetch a message from the conversation
POST/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}Update an existing message in the conversation
DELETE/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}Remove a message from the conversation
GET/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/ParticipantsRetrieve a list of all participants of the conversation
POST/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/ParticipantsAdd a new participant to the conversation in a specific service
GET/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}Fetch a participant of the conversation
POST/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}Update an existing participant in the conversation
DELETE/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}Remove a participant from the conversation
GET/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/WebhooksRetrieve a list of all webhooks scoped to the conversation
POST/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/WebhooksCreate a new webhook scoped to the conversation in a specific service
GET/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}Fetch the configuration of a conversation-scoped webhook
POST/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}Update an existing conversation-scoped webhook
DELETE/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}Remove an existing webhook scoped to the conversation
GET/v1/Services/{ChatServiceSid}/Conversations/{Sid}Fetch a conversation from your service
POST/v1/Services/{ChatServiceSid}/Conversations/{Sid}Update an existing conversation in your service
DELETE/v1/Services/{ChatServiceSid}/Conversations/{Sid}Remove a conversation from your service
GET/v1/Services/{ChatServiceSid}/ParticipantConversationsRetrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.
GET/v1/Services/{ChatServiceSid}/RolesRetrieve a list of all user roles in your service
POST/v1/Services/{ChatServiceSid}/RolesCreate a new user role in your service
GET/v1/Services/{ChatServiceSid}/Roles/{Sid}Fetch a user role from your service
POST/v1/Services/{ChatServiceSid}/Roles/{Sid}Update an existing user role in your service
DELETE/v1/Services/{ChatServiceSid}/Roles/{Sid}Remove a user role from your service
GET/v1/Services/{ChatServiceSid}/UsersRetrieve a list of all conversation users in your service
POST/v1/Services/{ChatServiceSid}/UsersAdd a new conversation user to your service
GET/v1/Services/{ChatServiceSid}/Users/{Sid}Fetch a conversation user from your service
POST/v1/Services/{ChatServiceSid}/Users/{Sid}Update an existing conversation user in your service
DELETE/v1/Services/{ChatServiceSid}/Users/{Sid}Remove a conversation user from your service
GET/v1/Services/{ChatServiceSid}/Users/{UserSid}/ConversationsRetrieve a list of all User Conversations for the User.
GET/v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}Fetch a specific User Conversation.
POST/v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}Update a specific User Conversation.
DELETE/v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}Delete a specific User Conversation.
GET/v1/Services/{Sid}Fetch a conversation service from your account
DELETE/v1/Services/{Sid}Remove a conversation service with all its nested resources from your account
GET/v1/UsersRetrieve a list of all conversation users in your account's default service
POST/v1/UsersAdd a new conversation user to your account's default service
GET/v1/Users/{Sid}Fetch a conversation user from your account's default service
POST/v1/Users/{Sid}Update an existing conversation user in your account's default service
DELETE/v1/Users/{Sid}Remove a conversation user from your account's default service
GET/v1/Users/{UserSid}/ConversationsRetrieve a list of all User Conversations for the User.
GET/v1/Users/{UserSid}/Conversations/{ConversationSid}Fetch a specific User Conversation.
POST/v1/Users/{UserSid}/Conversations/{ConversationSid}Update a specific User Conversation.

Showing the first 100 of 101 endpoints; the full list is in the documentation.

Questions

Does the Twilio - Conversations API need an API key?

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

Does the Twilio - Conversations API support HTTPS?

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

How many endpoints does the Twilio - Conversations API have?

Its OpenAPI description lists 101 endpoints in version 1.42.0. The first 100 are shown on this page.

What are alternatives to the Twilio - Conversations 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).