Twilio

Twilio Conversations 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 103

ConversationsV1AddressConfiguration

  • GETRetrieve a list of address configurations for an account/v1/Configuration/Addresses?Type=sms&PageSize=1&Page=0&PageToken=stringRetrieve a list of address configurations for an account
  • POSTCreate a new address configuration/v1/Configuration/AddressesCreate a new address configuration
  • GETFetch an address configuration /v1/Configuration/Addresses/:SidFetch an address configuration
  • POSTUpdate an existing address configuration/v1/Configuration/Addresses/:SidUpdate an existing address configuration
  • DELETERemove an existing address configuration/v1/Configuration/Addresses/:SidRemove an existing address configuration

ConversationsV1Binding

  • GETFetch a push notification binding from the conversation service/v1/Services/:ChatServiceSid/Bindings/:SidFetch a push notification binding from the conversation service
  • DELETERemove a push notification binding from the conversation service/v1/Services/:ChatServiceSid/Bindings/:SidRemove a push notification binding from the conversation service
  • GETRetrieve a list of all push notification bindings in the conversation service/v1/Services/:ChatServiceSid/Bindings?BindingType=apn&Identity=string&PageSize=1&Page=0&PageToken=stringRetrieve a list of all push notification bindings in the conversation service

ConversationsV1Configuration

  • GETFetch the global configuration of conversations on your account/v1/ConfigurationFetch the global configuration of conversations on your account
  • POSTUpdate the global configuration of conversations on your account/v1/ConfigurationUpdate the global configuration of conversations on your account
  • GETFetch the configuration of a conversation service/v1/Services/:ChatServiceSid/ConfigurationFetch the configuration of a conversation service
  • POSTUpdate configuration settings of a conversation service/v1/Services/:ChatServiceSid/ConfigurationUpdate configuration settings of a conversation service

ConversationsV1Conversation

  • GETRetrieve a list of conversations in your account's default service/v1/Conversations?StartDate=string&EndDate=string&State=initializing&PageSize=1&Page=0&PageToken=stringRetrieve a list of conversations in your account's default service
  • POSTCreate a new conversation in your account's default service/v1/ConversationsCreate a new conversation in your account's default service
  • GETFetch a conversation from your account's default service/v1/Conversations/:SidFetch a conversation from your account's default service
  • POSTUpdate an existing conversation in your account's default service/v1/Conversations/:SidUpdate an existing conversation in your account's default service
  • DELETERemove a conversation from your account's default service/v1/Conversations/:SidRemove a conversation from your account's default service
  • GETRetrieve a list of conversations in your service/v1/Services/:ChatServiceSid/Conversations?StartDate=string&EndDate=string&State=inactive&PageSize=1&Page=0&PageToken=stringRetrieve a list of conversations in your service
  • POSTCreate a new conversation in your service/v1/Services/:ChatServiceSid/ConversationsCreate a new conversation in your service
  • GETFetch a conversation from your service/v1/Services/:ChatServiceSid/Conversations/:SidFetch a conversation from your service
  • POSTUpdate an existing conversation in your service/v1/Services/:ChatServiceSid/Conversations/:SidUpdate an existing conversation in your service
  • DELETERemove a conversation from your service/v1/Services/:ChatServiceSid/Conversations/:SidRemove a conversation from your service

ConversationsV1ConversationWithParticipants

  • POSTCreate a new conversation with the list of participants in your account's default service/v1/ConversationWithParticipantsCreate a new conversation with the list of participants in your account's default service
  • POSTCreate a new conversation with the list of participants in your account's default service/v1/Services/:ChatServiceSid/ConversationWithParticipantsCreate a new conversation with the list of participants in your account's default service

ConversationsV1Credential

  • GETRetrieve a list of all push notification credentials on your account/v1/Credentials?PageSize=1&Page=0&PageToken=stringRetrieve a list of all push notification credentials on your account
  • POSTAdd a new push notification credential to your account/v1/CredentialsAdd a new push notification credential to your account
  • GETFetch a push notification credential from your account/v1/Credentials/:SidFetch a push notification credential from your account
  • POSTUpdate an existing push notification credential on your account/v1/Credentials/:SidUpdate an existing push notification credential on your account
  • DELETERemove a push notification credential from your account/v1/Credentials/:SidRemove a push notification credential from your account

ConversationsV1DeliveryReceipt

  • GETFetch the delivery and read receipts of the conversation message/v1/Conversations/:ConversationSid/Messages/:MessageSid/Receipts/:SidFetch the delivery and read receipts of the conversation message
  • GETRetrieve a list of all delivery and read receipts of the conversation message/v1/Conversations/:ConversationSid/Messages/:MessageSid/Receipts?PageSize=1&Page=0&PageToken=stringRetrieve a list of all delivery and read receipts of the conversation message
  • GETFetch the delivery and read receipts of the conversation message/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Messages/:MessageSid/Receipts/:SidFetch the delivery and read receipts of the conversation message
  • GETRetrieve a list of all delivery and read receipts of the conversation message/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Messages/:MessageSid/Receipts?PageSize=1&Page=0&PageToken=stringRetrieve a list of all delivery and read receipts of the conversation message

ConversationsV1Message

  • GETRetrieve a list of all messages in the conversation/v1/Conversations/:ConversationSid/Messages?Order=desc&PageSize=1&Page=0&PageToken=stringRetrieve a list of all messages in the conversation
  • POSTAdd a new message to the conversation/v1/Conversations/:ConversationSid/MessagesAdd a new message to the conversation
  • GETFetch a message from the conversation/v1/Conversations/:ConversationSid/Messages/:SidFetch a message from the conversation
  • POSTUpdate an existing message in the conversation/v1/Conversations/:ConversationSid/Messages/:SidUpdate an existing message in the conversation
  • DELETERemove a message from the conversation/v1/Conversations/:ConversationSid/Messages/:SidRemove a message from the conversation
  • GETRetrieve a list of all messages in the conversation/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Messages?Order=desc&PageSize=1&Page=0&PageToken=stringRetrieve a list of all messages in the conversation
  • POSTAdd a new message to the conversation in a specific service/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/MessagesAdd a new message to the conversation in a specific service
  • GETFetch a message from the conversation/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Messages/:SidFetch a message from the conversation
  • POSTUpdate an existing message in the conversation/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Messages/:SidUpdate an existing message in the conversation
  • DELETERemove a message from the conversation/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Messages/:SidRemove a message from the conversation

ConversationsV1Notification

  • GETFetch push notification service settings/v1/Services/:ChatServiceSid/Configuration/NotificationsFetch push notification service settings
  • POSTUpdate push notification service settings/v1/Services/:ChatServiceSid/Configuration/NotificationsUpdate push notification service settings

ConversationsV1Participant

  • GETRetrieve a list of all participants of the conversation/v1/Conversations/:ConversationSid/Participants?PageSize=1&Page=0&PageToken=stringRetrieve a list of all participants of the conversation
  • POSTAdd a new participant to the conversation/v1/Conversations/:ConversationSid/ParticipantsAdd a new participant to the conversation
  • GETFetch a participant of the conversation/v1/Conversations/:ConversationSid/Participants/:SidFetch a participant of the conversation
  • POSTUpdate an existing participant in the conversation/v1/Conversations/:ConversationSid/Participants/:SidUpdate an existing participant in the conversation
  • DELETERemove a participant from the conversation/v1/Conversations/:ConversationSid/Participants/:SidRemove a participant from the conversation
  • GETRetrieve a list of all participants of the conversation/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Participants?PageSize=1&Page=0&PageToken=stringRetrieve a list of all participants of the conversation
  • POSTAdd a new participant to the conversation in a specific service/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/ParticipantsAdd a new participant to the conversation in a specific service
  • GETFetch a participant of the conversation/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Participants/:SidFetch a participant of the conversation
  • POSTUpdate an existing participant in the conversation/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Participants/:SidUpdate an existing participant in the conversation
  • DELETERemove a participant from the conversation/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Participants/:SidRemove a participant from the conversation

ConversationsV1ParticipantConversation

  • GETRetrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified./v1/ParticipantConversations?Identity=identity&Address=+375255555555&PageSize=1&Page=0&PageToken=stringRetrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.
  • GETRetrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified./v1/Services/:ChatServiceSid/ParticipantConversations?Identity=identity&Address=+375255555555&PageSize=1&Page=0&PageToken=stringRetrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.

ConversationsV1Role

  • GETRetrieve a list of all user roles in your account's default service/v1/Roles?PageSize=1&Page=0&PageToken=stringRetrieve a list of all user roles in your account's default service
  • POSTCreate a new user role in your account's default service/v1/RolesCreate a new user role in your account's default service
  • GETFetch a user role from your account's default service/v1/Roles/:SidFetch a user role from your account's default service
  • POSTUpdate an existing user role in your account's default service/v1/Roles/:SidUpdate an existing user role in your account's default service
  • DELETERemove a user role from your account's default service/v1/Roles/:SidRemove a user role from your account's default service
  • GETRetrieve a list of all user roles in your service/v1/Services/:ChatServiceSid/Roles?PageSize=1&Page=0&PageToken=stringRetrieve a list of all user roles in your service
  • POSTCreate a new user role in your service/v1/Services/:ChatServiceSid/RolesCreate a new user role in your service
  • GETFetch a user role from your service/v1/Services/:ChatServiceSid/Roles/:SidFetch a user role from your service
  • POSTUpdate an existing user role in your service/v1/Services/:ChatServiceSid/Roles/:SidUpdate an existing user role in your service
  • DELETERemove a user role from your service/v1/Services/:ChatServiceSid/Roles/:SidRemove a user role from your service

ConversationsV1Service

  • GETRetrieve a list of all conversation services on your account/v1/Services?PageSize=1&Page=0&PageToken=stringRetrieve a list of all conversation services on your account
  • POSTCreate a new conversation service on your account/v1/ServicesCreate a new conversation service on your account
  • GETFetch a conversation service from your account/v1/Services/:SidFetch a conversation service from your account
  • DELETERemove a conversation service with all its nested resources from your account/v1/Services/:SidRemove a conversation service with all its nested resources from your account

ConversationsV1User

  • GETRetrieve a list of all conversation users in your service/v1/Services/:ChatServiceSid/Users?PageSize=1&Page=0&PageToken=stringRetrieve a list of all conversation users in your service
  • POSTAdd a new conversation user to your service/v1/Services/:ChatServiceSid/UsersAdd a new conversation user to your service
  • GETFetch a conversation user from your service/v1/Services/:ChatServiceSid/Users/:SidFetch a conversation user from your service
  • POSTUpdate an existing conversation user in your service/v1/Services/:ChatServiceSid/Users/:SidUpdate an existing conversation user in your service
  • DELETERemove a conversation user from your service/v1/Services/:ChatServiceSid/Users/:SidRemove a conversation user from your service
  • GETRetrieve a list of all conversation users in your account's default service/v1/Users?PageSize=1&Page=0&PageToken=stringRetrieve a list of all conversation users in your account's default service
  • POSTAdd a new conversation user to your account's default service/v1/UsersAdd a new conversation user to your account's default service
  • GETFetch a conversation user from your account's default service/v1/Users/:SidFetch a conversation user from your account's default service
  • POSTUpdate an existing conversation user in your account's default service/v1/Users/:SidUpdate an existing conversation user in your account's default service
  • DELETERemove a conversation user from your account's default service/v1/Users/:SidRemove a conversation user from your account's default service

ConversationsV1UserConversation

  • GETFetch a specific User Conversation./v1/Services/:ChatServiceSid/Users/:UserSid/Conversations/:ConversationSidFetch a specific User Conversation.
  • POSTUpdate a specific User Conversation./v1/Services/:ChatServiceSid/Users/:UserSid/Conversations/:ConversationSidUpdate a specific User Conversation.
  • DELETEDelete a specific User Conversation./v1/Services/:ChatServiceSid/Users/:UserSid/Conversations/:ConversationSidDelete a specific User Conversation.
  • GETRetrieve a list of all User Conversations for the User./v1/Services/:ChatServiceSid/Users/:UserSid/Conversations?PageSize=1&Page=0&PageToken=stringRetrieve a list of all User Conversations for the User.
  • GETFetch a specific User Conversation./v1/Users/:UserSid/Conversations/:ConversationSidFetch a specific User Conversation.
  • POSTUpdate a specific User Conversation./v1/Users/:UserSid/Conversations/:ConversationSidUpdate a specific User Conversation.
  • DELETEDelete a specific User Conversation./v1/Users/:UserSid/Conversations/:ConversationSidDelete a specific User Conversation.
  • GETRetrieve a list of all User Conversations for the User./v1/Users/:UserSid/Conversations?PageSize=1&Page=0&PageToken=stringRetrieve a list of all User Conversations for the User.

ConversationsV1Webhook

  • GETFetchConfigurationWebhook/v1/Configuration/Webhooks
  • POSTUpdateConfigurationWebhook/v1/Configuration/Webhooks
  • GETRetrieve a list of all webhooks scoped to the conversation/v1/Conversations/:ConversationSid/Webhooks?PageSize=1&Page=0&PageToken=stringRetrieve a list of all webhooks scoped to the conversation
  • POSTCreate a new webhook scoped to the conversation/v1/Conversations/:ConversationSid/WebhooksCreate a new webhook scoped to the conversation
  • GETFetch the configuration of a conversation-scoped webhook/v1/Conversations/:ConversationSid/Webhooks/:SidFetch the configuration of a conversation-scoped webhook
  • POSTUpdate an existing conversation-scoped webhook/v1/Conversations/:ConversationSid/Webhooks/:SidUpdate an existing conversation-scoped webhook
  • DELETERemove an existing webhook scoped to the conversation/v1/Conversations/:ConversationSid/Webhooks/:SidRemove an existing webhook scoped to the conversation
  • GETRetrieve a list of all webhooks scoped to the conversation/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Webhooks?PageSize=1&Page=0&PageToken=stringRetrieve a list of all webhooks scoped to the conversation
  • POSTCreate a new webhook scoped to the conversation in a specific service/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/WebhooksCreate a new webhook scoped to the conversation in a specific service
  • GETFetch the configuration of a conversation-scoped webhook/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Webhooks/:SidFetch the configuration of a conversation-scoped webhook
  • POSTUpdate an existing conversation-scoped webhook/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Webhooks/:SidUpdate an existing conversation-scoped webhook
  • DELETERemove an existing webhook scoped to the conversation/v1/Services/:ChatServiceSid/Conversations/:ConversationSid/Webhooks/:SidRemove an existing webhook scoped to the conversation
  • GETFetch a specific service webhook configuration./v1/Services/:ChatServiceSid/Configuration/WebhooksFetch a specific service webhook configuration.
  • POSTUpdate a specific Webhook./v1/Services/:ChatServiceSid/Configuration/WebhooksUpdate a specific Webhook.

API details

Base URL
https://conversations.twilio.com
Authentication
HTTP Basic authentication (username and password)
Operations
103 operations on 49 pathsGET 47POST 38DELETE 18
Main resources
ConversationsV1Webhook 14ConversationsV1Conversation 10ConversationsV1Message 10ConversationsV1Participant 10ConversationsV1Role 10ConversationsV1User 10ConversationsV1UserConversation 8ConversationsV1AddressConfiguration 5ConversationsV1Credential 5ConversationsV1Configuration 4
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.0.0

How to test the Twilio Conversations 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 Conversations 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 “Retrieve a list of address configurations for an account” (GET /v1/Configuration/Addresses?Type=sms&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 Conversations v1?

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

Who publishes the Twilio Conversations 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 Conversations v1?

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

How do I authenticate with the Twilio Conversations v1?

With HTTP Basic authentication (username and password).

How many endpoints does the Twilio Conversations v1 have?

103 operations on 49 paths (47 GET, 38 POST, 18 DELETE). The largest groups are ConversationsV1Webhook, ConversationsV1Conversation, ConversationsV1Message, ConversationsV1Participant.

Is forking the Twilio Conversations 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.