The Twilio Conversations REST API provides programmatic access to manage the entire conversations service, including global configuration, address setups, users, conversations, messages, participants, webhooks, push notification credentials, and role definitions.
Fetch the global configuration of conversations on your account
POST
/v1/Configuration
Update the global configuration of conversations on your account
POST
/v1/Users
Add a new conversation user to your account's default service
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v1/Configuration/Addresses
Retrieve a list of address configurations for an account
Type(query) — Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v1/Configuration/Addresses
Create a new address configuration
DELETE
/v1/Configuration/Addresses/{Sid}
Remove an existing address configuration
Sid(path, required) — The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration
GET
/v1/Configuration/Addresses/{Sid}
Fetch an address configuration
Sid(path, required) — The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration
POST
/v1/Configuration/Addresses/{Sid}
Update an existing address configuration
Sid(path, required) — The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration
GET
/v1/Configuration/Webhooks
POST
/v1/Configuration/Webhooks
GET
/v1/Conversations
Retrieve a list of conversations in your account's default service
StartDate(query) — Start date or time in ISO8601 format for filtering list of Conversations. If a date is provided, the start time of the date is used (YYYY-MM-DDT00:00:00Z). Can be combined with other filters.
EndDate(query) — End date or time in ISO8601 format for filtering list of Conversations. If a date is provided, the end time of the date is used (YYYY-MM-DDT23:59:59Z). Can be combined with other filters.
State(query) — State for sorting and filtering list of Conversations. Can be `active`, `inactive` or `closed`
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v1/Conversations
Create a new conversation in your account's default service
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v1/Conversations/{ConversationSid}/Messages
Retrieve a list of all messages in the conversation
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for messages.
Order(query) — The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending), with `asc` as the default.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v1/Conversations/{ConversationSid}/Messages
Add a new message to the conversation
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
Retrieve a list of all delivery and read receipts of the conversation message
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
MessageSid(path, required) — The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
Fetch the delivery and read receipts of the conversation message
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
MessageSid(path, required) — The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v1/Conversations/{ConversationSid}/Participants
Retrieve a list of all participants of the conversation
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for participants.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v1/Conversations/{ConversationSid}/Participants
Add a new participant to the conversation
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
Update an existing participant in the conversation
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v1/Conversations/{ConversationSid}/Webhooks
Retrieve a list of all webhooks scoped to the conversation
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v1/Conversations/{ConversationSid}/Webhooks
Create a new webhook scoped to the conversation
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
Remove an existing webhook scoped to the conversation
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
Fetch the configuration of a conversation-scoped webhook
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
DELETE
/v1/Conversations/{Sid}
Remove a conversation from your account's default service
Sid(path, required) — A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v1/Conversations/{Sid}
Fetch a conversation from your account's default service
Sid(path, required) — A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.
POST
/v1/Conversations/{Sid}
Update an existing conversation in your account's default service
Sid(path, required) — A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v1/Credentials
Retrieve a list of all push notification credentials on your account
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v1/Credentials
Add a new push notification credential to your account
DELETE
/v1/Credentials/{Sid}
Remove a push notification credential from your account
Sid(path, required) — A 34 character string that uniquely identifies this resource.
GET
/v1/Credentials/{Sid}
Fetch a push notification credential from your account
Sid(path, required) — A 34 character string that uniquely identifies this resource.
POST
/v1/Credentials/{Sid}
Update an existing push notification credential on your account
Sid(path, required) — A 34 character string that uniquely identifies this resource.
GET
/v1/ParticipantConversations
Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.
Identity(query) — A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.
Address(query) — A unique string identifier for the conversation participant who's not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
GET
/v1/Roles
Retrieve a list of all user roles in your account's default service
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v1/Roles
Create a new user role in your account's default service
DELETE
/v1/Roles/{Sid}
Remove a user role from your account's default service
Sid(path, required) — The SID of the Role resource to delete.
GET
/v1/Roles/{Sid}
Fetch a user role from your account's default service
Sid(path, required) — The SID of the Role resource to fetch.
POST
/v1/Roles/{Sid}
Update an existing user role in your account's default service
Sid(path, required) — The SID of the Role resource to update.
GET
/v1/Services
Retrieve a list of all conversation services on your account
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v1/Services
Create a new conversation service on your account
GET
/v1/Services/{ChatServiceSid}/Bindings
Retrieve a list of all push notification bindings in the conversation service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with.
BindingType(query) — The push technology used by the Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.
Identity(query) — The identity of a [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource) this binding belongs to. See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more details.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
DELETE
/v1/Services/{ChatServiceSid}/Bindings/{Sid}
Remove a push notification binding from the conversation service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the Binding resource from.
Sid(path, required) — The SID of the Binding resource to delete.
GET
/v1/Services/{ChatServiceSid}/Bindings/{Sid}
Fetch a push notification binding from the conversation service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
GET
/v1/Services/{ChatServiceSid}/Configuration
Fetch the configuration of a conversation service
ChatServiceSid(path, required) — The SID of the Service configuration resource to fetch.
POST
/v1/Services/{ChatServiceSid}/Configuration
Update configuration settings of a conversation service
ChatServiceSid(path, required) — The SID of the Service configuration resource to update.
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.
ChatServiceSid(path, required) — The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.
ChatServiceSid(path, required) — The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.
GET
/v1/Services/{ChatServiceSid}/Conversations
Retrieve a list of conversations in your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.
StartDate(query) — Start date or time in ISO8601 format for filtering list of Conversations. If a date is provided, the start time of the date is used (YYYY-MM-DDT00:00:00Z). Can be combined with other filters.
EndDate(query) — End date or time in ISO8601 format for filtering list of Conversations. If a date is provided, the end time of the date is used (YYYY-MM-DDT23:59:59Z). Can be combined with other filters.
State(query) — State for sorting and filtering list of Conversations. Can be `active`, `inactive` or `closed`
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v1/Services/{ChatServiceSid}/Conversations
Create a new conversation in your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
POST
/v1/Services/{ChatServiceSid}/Roles/{Sid}
Update an existing user role in your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to update the Role resource in.
Sid(path, required) — The SID of the Role resource to update.
Retrieve a list of all messages in the conversation
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for messages.
Order(query) — The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending), with `asc` as the default.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
Add a new message to the conversation in a specific service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
Retrieve a list of all delivery and read receipts of the conversation message
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
MessageSid(path, required) — The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
Fetch the delivery and read receipts of the conversation message
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
MessageSid(path, required) — The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
DELETE
/v1/Services/{Sid}
Remove a conversation service with all its nested resources from your account
Sid(path, required) — A 34 character string that uniquely identifies this resource.
GET
/v1/Services/{Sid}
Fetch a conversation service from your account
Sid(path, required) — A 34 character string that uniquely identifies this resource.
Retrieve a list of all participants of the conversation
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for participants.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
Add a new participant to the conversation in a specific service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
Update an existing participant in the conversation
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
Retrieve a list of all webhooks scoped to the conversation
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
Create a new webhook scoped to the conversation in a specific service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
Remove an existing webhook scoped to the conversation
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
GET
/v1/Users
Retrieve a list of all conversation users in your account's default service
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
Fetch the configuration of a conversation-scoped webhook
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
ConversationSid(path, required) — The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.
Sid(path, required) — A 34 character string that uniquely identifies this resource.
DELETE
/v1/Services/{ChatServiceSid}/Conversations/{Sid}
Remove a conversation from your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.
Sid(path, required) — A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v1/Services/{ChatServiceSid}/Conversations/{Sid}
Fetch a conversation from your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.
Sid(path, required) — A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.
POST
/v1/Services/{ChatServiceSid}/Conversations/{Sid}
Update an existing conversation in your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.
Sid(path, required) — A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant Conversations resource is associated with.
Identity(query) — A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.
Address(query) — A unique string identifier for the conversation participant who's not a Conversation User. This parameter could be found in messaging_binding.address field of Participant resource. It should be url-encoded.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
GET
/v1/Services/{ChatServiceSid}/Roles
Retrieve a list of all user roles in your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the Role resources from.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v1/Services/{ChatServiceSid}/Roles
Create a new user role in your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to create the Role resource under.
DELETE
/v1/Services/{ChatServiceSid}/Roles/{Sid}
Remove a user role from your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the Role resource from.
Sid(path, required) — The SID of the Role resource to delete.
GET
/v1/Services/{ChatServiceSid}/Roles/{Sid}
Fetch a user role from your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the Role resource from.
Sid(path, required) — The SID of the Role resource to fetch.
GET
/v1/Services/{ChatServiceSid}/Users
Retrieve a list of all conversation users in your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the User resources from.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
POST
/v1/Services/{ChatServiceSid}/Users
Add a new conversation user to your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
DELETE
/v1/Services/{ChatServiceSid}/Users/{Sid}
Remove a conversation user from your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the User resource from.
Sid(path, required) — The SID of the User resource to delete. This value can be either the `sid` or the `identity` of the User resource to delete.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v1/Services/{ChatServiceSid}/Users/{Sid}
Fetch a conversation user from your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the User resource from.
Sid(path, required) — The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch.
POST
/v1/Services/{ChatServiceSid}/Users/{Sid}
Update an existing conversation user in your service
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with.
Sid(path, required) — The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
Retrieve a list of all User Conversations for the User.
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.
UserSid(path, required) — The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.
UserSid(path, required) — The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
ConversationSid(path, required) — The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource).
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.
UserSid(path, required) — The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
ConversationSid(path, required) — The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource).
ChatServiceSid(path, required) — The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.
UserSid(path, required) — The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
ConversationSid(path, required) — The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource).
DELETE
/v1/Users/{Sid}
Remove a conversation user from your account's default service
Sid(path, required) — The SID of the User resource to delete. This value can be either the `sid` or the `identity` of the User resource to delete.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v1/Users/{Sid}
Fetch a conversation user from your account's default service
Sid(path, required) — The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch.
POST
/v1/Users/{Sid}
Update an existing conversation user in your account's default service
Sid(path, required) — The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.
X-Twilio-Webhook-Enabled(header) — The X-Twilio-Webhook-Enabled HTTP request header
GET
/v1/Users/{UserSid}/Conversations
Retrieve a list of all User Conversations for the User.
UserSid(path, required) — The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
PageSize(query, limit) — How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page(query, page) — The page index. This value is simply for client state.
PageToken(query) — The page token. This is provided by the API.
UserSid(path, required) — The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
ConversationSid(path, required) — The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource).
UserSid(path, required) — The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
ConversationSid(path, required) — The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource).
UserSid(path, required) — The unique SID identifier of the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). This value can be either the `sid` or the `identity` of the User resource.
ConversationSid(path, required) — The unique SID identifier of the Conversation. This value can be either the `sid` or the `unique_name` of the [Conversation resource](https://www.twilio.com/docs/conversations/api/conversation-resource).
101 endpoints auto-detected
Authentication
This API uses Basic authentication (a username and password).
curl -X GET \
"https://conversations.twilio.com/v1/Configuration"
