{"note":"OpenAPI conversion -- returning structured metadata","name":"twilio-conversations","description":"Twilio - Conversations","version":"1.0.0","base_url":"https://conversations.twilio.com","endpoints":103,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Twilio - Conversations\n@base https://conversations.twilio.com\n@version 1.0.0\n@auth Bearer basic\n@endpoints 103\n@hint download_for_search\n@toc Configuration(9), Conversations(22), ConversationWithParticipants(1), Credentials(5), ParticipantConversations(1), Roles(5), Services(51), Users(9)\n\n@group Configuration\n@endpoint GET /v1/Configuration\n@desc Fetch the global configuration of conversations on your account\n@returns(200) {account_sid: str?, default_chat_service_sid: str?, default_messaging_service_sid: str?, default_inactive_timer: str?, default_closed_timer: str?, url: str(uri)?, links: map?} # OK\n\n@endpoint POST /v1/Configuration\n@desc Update the global configuration of conversations on your account\n@returns(200) {account_sid: str?, default_chat_service_sid: str?, default_messaging_service_sid: str?, default_inactive_timer: str?, default_closed_timer: str?, url: str(uri)?, links: map?} # OK\n\n@endpoint GET /v1/Configuration/Addresses\n@desc Retrieve a list of address configurations for an account\n@optional {Type: str # Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`., PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 50., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {address_configurations: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Configuration/Addresses\n@desc Create a new address configuration\n@returns(201) {sid: str?, account_sid: str?, type: str?, address: str?, friendly_name: str?, auto_creation: any?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, address_country: str?} # Created\n\n@endpoint GET /v1/Configuration/Addresses/{Sid}\n@desc Fetch an address configuration\n@required {Sid: str # The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration}\n@returns(200) {sid: str?, account_sid: str?, type: str?, address: str?, friendly_name: str?, auto_creation: any?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, address_country: str?} # OK\n\n@endpoint POST /v1/Configuration/Addresses/{Sid}\n@desc Update an existing address configuration\n@required {Sid: str # The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration}\n@returns(200) {sid: str?, account_sid: str?, type: str?, address: str?, friendly_name: str?, auto_creation: any?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, address_country: str?} # OK\n\n@endpoint DELETE /v1/Configuration/Addresses/{Sid}\n@desc Remove an existing address configuration\n@required {Sid: str # The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Configuration/Webhooks\n@returns(200) {account_sid: str?, method: str, filters: [str]?, pre_webhook_url: str?, post_webhook_url: str?, target: str, url: str(uri)?} # OK\n\n@endpoint POST /v1/Configuration/Webhooks\n@returns(200) {account_sid: str?, method: str, filters: [str]?, pre_webhook_url: str?, post_webhook_url: str?, target: str, url: str(uri)?} # OK\n\n@endgroup\n\n@group Conversations\n@endpoint POST /v1/Conversations\n@desc Create a new conversation in your account's default service\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(201) {account_sid: str?, chat_service_sid: str?, messaging_service_sid: str?, sid: str?, friendly_name: str?, unique_name: str?, attributes: str?, state: str, date_created: str(date-time)?, date_updated: str(date-time)?, timers: any?, url: str(uri)?, links: map?, bindings: any?} # Created\n\n@endpoint GET /v1/Conversations\n@desc Retrieve a list of conversations in your account's default service\n@optional {StartDate: str # Specifies the beginning of the date range for filtering Conversations based on their creation date. Conversations that were created on or after this date will be included in the results. The date must be in ISO8601 format, specifically starting at the beginning of the specified date (YYYY-MM-DDT00:00:00Z), for precise filtering. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order., EndDate: str # Defines the end of the date range for filtering conversations by their creation date. Only conversations that were created on or before this date will appear in the results.  The date must be in ISO8601 format, specifically capturing up to the end of the specified date (YYYY-MM-DDT23:59:59Z), to ensure that conversations from the entire end day are included. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order., State: str # State for sorting and filtering list of Conversations. Can be `active`, `inactive` or `closed`, PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 100., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {conversations: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Conversations/{Sid}\n@desc Update an existing conversation in your account's default service\n@required {Sid: str # A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(200) {account_sid: str?, chat_service_sid: str?, messaging_service_sid: str?, sid: str?, friendly_name: str?, unique_name: str?, attributes: str?, state: str, date_created: str(date-time)?, date_updated: str(date-time)?, timers: any?, url: str(uri)?, links: map?, bindings: any?} # OK\n\n@endpoint DELETE /v1/Conversations/{Sid}\n@desc Remove a conversation from your account's default service\n@required {Sid: str # A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Conversations/{Sid}\n@desc Fetch a conversation from your account's default service\n@required {Sid: str # A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.}\n@returns(200) {account_sid: str?, chat_service_sid: str?, messaging_service_sid: str?, sid: str?, friendly_name: str?, unique_name: str?, attributes: str?, state: str, date_created: str(date-time)?, date_updated: str(date-time)?, timers: any?, url: str(uri)?, links: map?, bindings: any?} # OK\n\n@endpoint POST /v1/Conversations/{ConversationSid}/Messages\n@desc Add a new message to the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(201) {account_sid: str?, conversation_sid: str?, sid: str?, index: int, author: str?, body: str?, media: [any]?, attributes: str?, participant_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, delivery: any?, links: map?, content_sid: str?} # Created\n\n@endpoint GET /v1/Conversations/{ConversationSid}/Messages\n@desc Retrieve a list of all messages in the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for messages.}\n@optional {Order: str # The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending), with `asc` as the default., PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 100., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {messages: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Conversations/{ConversationSid}/Messages/{Sid}\n@desc Update an existing message in the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message., Sid: str # A 34 character string that uniquely identifies this resource.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(200) {account_sid: str?, conversation_sid: str?, sid: str?, index: int, author: str?, body: str?, media: [any]?, attributes: str?, participant_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, delivery: any?, links: map?, content_sid: str?} # OK\n\n@endpoint DELETE /v1/Conversations/{ConversationSid}/Messages/{Sid}\n@desc Remove a message from the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message., Sid: str # A 34 character string that uniquely identifies this resource.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Conversations/{ConversationSid}/Messages/{Sid}\n@desc Fetch a message from the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message., Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {account_sid: str?, conversation_sid: str?, sid: str?, index: int, author: str?, body: str?, media: [any]?, attributes: str?, participant_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, delivery: any?, links: map?, content_sid: str?} # OK\n\n@endpoint GET /v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}\n@desc Fetch the delivery and read receipts of the conversation message\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message., MessageSid: str # The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to., Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {account_sid: str?, conversation_sid: str?, sid: str?, message_sid: str?, channel_message_sid: str?, participant_sid: str?, status: str, error_code: int, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endpoint GET /v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts\n@desc Retrieve a list of all delivery and read receipts of the conversation message\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message., MessageSid: str # The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.}\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 50., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {delivery_receipts: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Conversations/{ConversationSid}/Participants\n@desc Add a new participant to the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(201) {account_sid: str?, conversation_sid: str?, sid: str?, identity: str?, attributes: str?, messaging_binding: any?, role_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, last_read_message_index: int?, last_read_timestamp: str?} # Created\n\n@endpoint GET /v1/Conversations/{ConversationSid}/Participants\n@desc Retrieve a list of all participants of the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for participants.}\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 100., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {participants: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Conversations/{ConversationSid}/Participants/{Sid}\n@desc Update an existing participant in the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant., Sid: str # A 34 character string that uniquely identifies this resource.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(200) {account_sid: str?, conversation_sid: str?, sid: str?, identity: str?, attributes: str?, messaging_binding: any?, role_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, last_read_message_index: int?, last_read_timestamp: str?} # OK\n\n@endpoint DELETE /v1/Conversations/{ConversationSid}/Participants/{Sid}\n@desc Remove a participant from the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant., Sid: str # A 34 character string that uniquely identifies this resource.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Conversations/{ConversationSid}/Participants/{Sid}\n@desc Fetch a participant of the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant., Sid: str # A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's `identity` rather than the SID.}\n@returns(200) {account_sid: str?, conversation_sid: str?, sid: str?, identity: str?, attributes: str?, messaging_binding: any?, role_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, last_read_message_index: int?, last_read_timestamp: str?} # OK\n\n@endpoint GET /v1/Conversations/{ConversationSid}/Webhooks\n@desc Retrieve a list of all webhooks scoped to the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.}\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 5, and the maximum is 5., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {webhooks: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Conversations/{ConversationSid}/Webhooks\n@desc Create a new webhook scoped to the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.}\n@returns(201) {sid: str?, account_sid: str?, conversation_sid: str?, target: str?, url: str(uri)?, configuration: any?, date_created: str(date-time)?, date_updated: str(date-time)?} # Created\n\n@endpoint GET /v1/Conversations/{ConversationSid}/Webhooks/{Sid}\n@desc Fetch the configuration of a conversation-scoped webhook\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook., Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {sid: str?, account_sid: str?, conversation_sid: str?, target: str?, url: str(uri)?, configuration: any?, date_created: str(date-time)?, date_updated: str(date-time)?} # OK\n\n@endpoint POST /v1/Conversations/{ConversationSid}/Webhooks/{Sid}\n@desc Update an existing conversation-scoped webhook\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook., Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {sid: str?, account_sid: str?, conversation_sid: str?, target: str?, url: str(uri)?, configuration: any?, date_created: str(date-time)?, date_updated: str(date-time)?} # OK\n\n@endpoint DELETE /v1/Conversations/{ConversationSid}/Webhooks/{Sid}\n@desc Remove an existing webhook scoped to the conversation\n@required {ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook., Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(204) The resource was deleted successfully.\n\n@endgroup\n\n@group ConversationWithParticipants\n@endpoint POST /v1/ConversationWithParticipants\n@desc Create a new conversation with the list of participants in your account's default service\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(201) {account_sid: str?, chat_service_sid: str?, messaging_service_sid: str?, sid: str?, friendly_name: str?, unique_name: str?, attributes: str?, state: str, date_created: str(date-time)?, date_updated: str(date-time)?, timers: any?, links: map?, bindings: any?, url: str(uri)?} # Created\n@returns(202) {account_sid: str?, chat_service_sid: str?, messaging_service_sid: str?, sid: str?, friendly_name: str?, unique_name: str?, attributes: str?, state: str, date_created: str(date-time)?, date_updated: str(date-time)?, timers: any?, links: map?, bindings: any?, url: str(uri)?} # Accepted\n\n@endgroup\n\n@group Credentials\n@endpoint POST /v1/Credentials\n@desc Add a new push notification credential to your account\n@returns(201) {sid: str?, account_sid: str?, friendly_name: str?, type: str, sandbox: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # Created\n\n@endpoint GET /v1/Credentials\n@desc Retrieve a list of all push notification credentials on your account\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 100., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {credentials: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Credentials/{Sid}\n@desc Update an existing push notification credential on your account\n@required {Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {sid: str?, account_sid: str?, friendly_name: str?, type: str, sandbox: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endpoint DELETE /v1/Credentials/{Sid}\n@desc Remove a push notification credential from your account\n@required {Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Credentials/{Sid}\n@desc Fetch a push notification credential from your account\n@required {Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {sid: str?, account_sid: str?, friendly_name: str?, type: str, sandbox: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endgroup\n\n@group ParticipantConversations\n@endpoint GET /v1/ParticipantConversations\n@desc Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.\n@optional {Identity: str # 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: str # 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: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 50., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {conversations: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endgroup\n\n@group Roles\n@endpoint POST /v1/Roles\n@desc Create a new user role in your account's default service\n@returns(201) {sid: str?, account_sid: str?, chat_service_sid: str?, friendly_name: str?, type: str, permissions: [str]?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # Created\n\n@endpoint GET /v1/Roles\n@desc Retrieve a list of all user roles in your account's default service\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 50., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {roles: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Roles/{Sid}\n@desc Update an existing user role in your account's default service\n@required {Sid: str # The SID of the Role resource to update.}\n@returns(200) {sid: str?, account_sid: str?, chat_service_sid: str?, friendly_name: str?, type: str, permissions: [str]?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endpoint DELETE /v1/Roles/{Sid}\n@desc Remove a user role from your account's default service\n@required {Sid: str # The SID of the Role resource to delete.}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Roles/{Sid}\n@desc Fetch a user role from your account's default service\n@required {Sid: str # The SID of the Role resource to fetch.}\n@returns(200) {sid: str?, account_sid: str?, chat_service_sid: str?, friendly_name: str?, type: str, permissions: [str]?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endgroup\n\n@group Services\n@endpoint POST /v1/Services\n@desc Create a new conversation service on your account\n@returns(201) {account_sid: str?, sid: str?, friendly_name: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, links: map?} # Created\n\n@endpoint GET /v1/Services\n@desc Retrieve a list of all conversation services on your account\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 100., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {services: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint DELETE /v1/Services/{Sid}\n@desc Remove a conversation service with all its nested resources from your account\n@required {Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Services/{Sid}\n@desc Fetch a conversation service from your account\n@required {Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {account_sid: str?, sid: str?, friendly_name: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, links: map?} # OK\n\n@endpoint DELETE /v1/Services/{ChatServiceSid}/Bindings/{Sid}\n@desc Remove a push notification binding from the conversation service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the Binding resource from., Sid: str # The SID of the Binding resource to delete.}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Bindings/{Sid}\n@desc Fetch a push notification binding from the conversation service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with., Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {sid: str?, account_sid: str?, chat_service_sid: str?, credential_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, endpoint: str?, identity: str?, binding_type: str, message_types: [str]?, url: str(uri)?} # OK\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Bindings\n@desc Retrieve a list of all push notification bindings in the conversation service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with.}\n@optional {BindingType: [str] # The push technology used by the Binding resources to read.  Can be: `apn`, `gcm`, `fcm`, or `twilsock`.  See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info., Identity: [str] # 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: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 100., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {bindings: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Configuration\n@desc Fetch the configuration of a conversation service\n@required {ChatServiceSid: str # The SID of the Service configuration resource to fetch.}\n@returns(200) {chat_service_sid: str?, default_conversation_creator_role_sid: str?, default_conversation_role_sid: str?, default_chat_service_role_sid: str?, url: str(uri)?, links: map?, reachability_enabled: bool?} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Configuration\n@desc Update configuration settings of a conversation service\n@required {ChatServiceSid: str # The SID of the Service configuration resource to update.}\n@returns(200) {chat_service_sid: str?, default_conversation_creator_role_sid: str?, default_conversation_role_sid: str?, default_chat_service_role_sid: str?, url: str(uri)?, links: map?, reachability_enabled: bool?} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Conversations\n@desc Create a new conversation in your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(201) {account_sid: str?, chat_service_sid: str?, messaging_service_sid: str?, sid: str?, friendly_name: str?, unique_name: str?, attributes: str?, state: str, date_created: str(date-time)?, date_updated: str(date-time)?, timers: any?, url: str(uri)?, links: map?, bindings: any?} # Created\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Conversations\n@desc Retrieve a list of conversations in your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.}\n@optional {StartDate: str # Specifies the beginning of the date range for filtering Conversations based on their creation date. Conversations that were created on or after this date will be included in the results. The date must be in ISO8601 format, specifically starting at the beginning of the specified date (YYYY-MM-DDT00:00:00Z), for precise filtering. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order., EndDate: str # Defines the end of the date range for filtering conversations by their creation date. Only conversations that were created on or before this date will appear in the results.  The date must be in ISO8601 format, specifically capturing up to the end of the specified date (YYYY-MM-DDT23:59:59Z), to ensure that conversations from the entire end day are included. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order., State: str # State for sorting and filtering list of Conversations. Can be `active`, `inactive` or `closed`, PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 100., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {conversations: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Conversations/{Sid}\n@desc Update an existing conversation in your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with., Sid: str # A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(200) {account_sid: str?, chat_service_sid: str?, messaging_service_sid: str?, sid: str?, friendly_name: str?, unique_name: str?, attributes: str?, state: str, date_created: str(date-time)?, date_updated: str(date-time)?, timers: any?, url: str(uri)?, links: map?, bindings: any?} # OK\n\n@endpoint DELETE /v1/Services/{ChatServiceSid}/Conversations/{Sid}\n@desc Remove a conversation from your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with., Sid: str # A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Conversations/{Sid}\n@desc Fetch a conversation from your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with., Sid: str # A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.}\n@returns(200) {account_sid: str?, chat_service_sid: str?, messaging_service_sid: str?, sid: str?, friendly_name: str?, unique_name: str?, attributes: str?, state: str, date_created: str(date-time)?, date_updated: str(date-time)?, timers: any?, url: str(uri)?, links: map?, bindings: any?} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages\n@desc Add a new message to the conversation in a specific service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(201) {account_sid: str?, chat_service_sid: str?, conversation_sid: str?, sid: str?, index: int, author: str?, body: str?, media: [any]?, attributes: str?, participant_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, delivery: any?, url: str(uri)?, links: map?, content_sid: str?} # Created\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages\n@desc Retrieve a list of all messages in the conversation\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for messages.}\n@optional {Order: str # The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending), with `asc` as the default., PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 100., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {messages: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}\n@desc Update an existing message in the conversation\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message., Sid: str # A 34 character string that uniquely identifies this resource.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(200) {account_sid: str?, chat_service_sid: str?, conversation_sid: str?, sid: str?, index: int, author: str?, body: str?, media: [any]?, attributes: str?, participant_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, delivery: any?, url: str(uri)?, links: map?, content_sid: str?} # OK\n\n@endpoint DELETE /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}\n@desc Remove a message from the conversation\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message., Sid: str # A 34 character string that uniquely identifies this resource.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}\n@desc Fetch a message from the conversation\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message., Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {account_sid: str?, chat_service_sid: str?, conversation_sid: str?, sid: str?, index: int, author: str?, body: str?, media: [any]?, attributes: str?, participant_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, delivery: any?, url: str(uri)?, links: map?, content_sid: str?} # OK\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}\n@desc Fetch the delivery and read receipts of the conversation message\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message., MessageSid: str # The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to., Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {account_sid: str?, chat_service_sid: str?, conversation_sid: str?, message_sid: str?, sid: str?, channel_message_sid: str?, participant_sid: str?, status: str, error_code: int, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts\n@desc Retrieve a list of all delivery and read receipts of the conversation message\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message., MessageSid: str # The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.}\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 50., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {delivery_receipts: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants\n@desc Add a new participant to the conversation in a specific service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(201) {account_sid: str?, chat_service_sid: str?, conversation_sid: str?, sid: str?, identity: str?, attributes: str?, messaging_binding: any?, role_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, last_read_message_index: int?, last_read_timestamp: str?} # Created\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants\n@desc Retrieve a list of all participants of the conversation\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for participants.}\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 100., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {participants: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}\n@desc Update an existing participant in the conversation\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant., Sid: str # A 34 character string that uniquely identifies this resource.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(200) {account_sid: str?, chat_service_sid: str?, conversation_sid: str?, sid: str?, identity: str?, attributes: str?, messaging_binding: any?, role_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, last_read_message_index: int?, last_read_timestamp: str?} # OK\n\n@endpoint DELETE /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}\n@desc Remove a participant from the conversation\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant., Sid: str # A 34 character string that uniquely identifies this resource.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}\n@desc Fetch a participant of the conversation\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant., Sid: str # A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's `identity` rather than the SID.}\n@returns(200) {account_sid: str?, chat_service_sid: str?, conversation_sid: str?, sid: str?, identity: str?, attributes: str?, messaging_binding: any?, role_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, last_read_message_index: int?, last_read_timestamp: str?} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks\n@desc Create a new webhook scoped to the conversation in a specific service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.}\n@returns(201) {sid: str?, account_sid: str?, chat_service_sid: str?, conversation_sid: str?, target: str?, url: str(uri)?, configuration: any?, date_created: str(date-time)?, date_updated: str(date-time)?} # Created\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks\n@desc Retrieve a list of all webhooks scoped to the conversation\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.}\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 5, and the maximum is 5., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {webhooks: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}\n@desc Update an existing conversation-scoped webhook\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook., Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {sid: str?, account_sid: str?, chat_service_sid: str?, conversation_sid: str?, target: str?, url: str(uri)?, configuration: any?, date_created: str(date-time)?, date_updated: str(date-time)?} # OK\n\n@endpoint DELETE /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}\n@desc Remove an existing webhook scoped to the conversation\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook., Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}\n@desc Fetch the configuration of a conversation-scoped webhook\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with., ConversationSid: str # The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook., Sid: str # A 34 character string that uniquely identifies this resource.}\n@returns(200) {sid: str?, account_sid: str?, chat_service_sid: str?, conversation_sid: str?, target: str?, url: str(uri)?, configuration: any?, date_created: str(date-time)?, date_updated: str(date-time)?} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/ConversationWithParticipants\n@desc Create a new conversation with the list of participants in your account's default service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(201) {account_sid: str?, chat_service_sid: str?, messaging_service_sid: str?, sid: str?, friendly_name: str?, unique_name: str?, attributes: str?, state: str, date_created: str(date-time)?, date_updated: str(date-time)?, timers: any?, links: map?, bindings: any?, url: str(uri)?} # Created\n@returns(202) {account_sid: str?, chat_service_sid: str?, messaging_service_sid: str?, sid: str?, friendly_name: str?, unique_name: str?, attributes: str?, state: str, date_created: str(date-time)?, date_updated: str(date-time)?, timers: any?, links: map?, bindings: any?, url: str(uri)?} # Accepted\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Configuration/Notifications\n@desc Update push notification service settings\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.}\n@returns(200) {account_sid: str?, chat_service_sid: str?, new_message: any?, added_to_conversation: any?, removed_from_conversation: any?, log_enabled: bool?, url: str(uri)?} # OK\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Configuration/Notifications\n@desc Fetch push notification service settings\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.}\n@returns(200) {account_sid: str?, chat_service_sid: str?, new_message: any?, added_to_conversation: any?, removed_from_conversation: any?, log_enabled: bool?, url: str(uri)?} # OK\n\n@endpoint GET /v1/Services/{ChatServiceSid}/ParticipantConversations\n@desc Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant Conversations resource is associated with.}\n@optional {Identity: str # 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: str # 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: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 50., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {conversations: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Roles\n@desc Create a new user role in your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to create the Role resource under.}\n@returns(201) {sid: str?, account_sid: str?, chat_service_sid: str?, friendly_name: str?, type: str, permissions: [str]?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # Created\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Roles\n@desc Retrieve a list of all user roles in your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the Role resources from.}\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 50., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {roles: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Roles/{Sid}\n@desc Update an existing user role in your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to update the Role resource in., Sid: str # The SID of the Role resource to update.}\n@returns(200) {sid: str?, account_sid: str?, chat_service_sid: str?, friendly_name: str?, type: str, permissions: [str]?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endpoint DELETE /v1/Services/{ChatServiceSid}/Roles/{Sid}\n@desc Remove a user role from your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the Role resource from., Sid: str # The SID of the Role resource to delete.}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Roles/{Sid}\n@desc Fetch a user role from your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the Role resource from., Sid: str # The SID of the Role resource to fetch.}\n@returns(200) {sid: str?, account_sid: str?, chat_service_sid: str?, friendly_name: str?, type: str, permissions: [str]?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Users\n@desc Add a new conversation user to your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(201) {sid: str?, account_sid: str?, chat_service_sid: str?, role_sid: str?, identity: str?, friendly_name: str?, attributes: str?, is_online: bool?, is_notifiable: bool?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, links: map?} # Created\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Users\n@desc Retrieve a list of all conversation users in your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the User resources from.}\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 50., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {users: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Users/{Sid}\n@desc Update an existing conversation user in your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with., Sid: str # The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(200) {sid: str?, account_sid: str?, chat_service_sid: str?, role_sid: str?, identity: str?, friendly_name: str?, attributes: str?, is_online: bool?, is_notifiable: bool?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, links: map?} # OK\n\n@endpoint DELETE /v1/Services/{ChatServiceSid}/Users/{Sid}\n@desc Remove a conversation user from your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the User resource from., Sid: str # The SID of the User resource to delete. This value can be either the `sid` or the `identity` of the User resource to delete.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Users/{Sid}\n@desc Fetch a conversation user from your service\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the User resource from., Sid: str # The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch.}\n@returns(200) {sid: str?, account_sid: str?, chat_service_sid: str?, role_sid: str?, identity: str?, friendly_name: str?, attributes: str?, is_online: bool?, is_notifiable: bool?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, links: map?} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}\n@desc Update a specific User Conversation.\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with., UserSid: str # 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: str # 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).}\n@returns(200) {account_sid: str?, chat_service_sid: str?, conversation_sid: str?, unread_messages_count: int?, last_read_message_index: int?, participant_sid: str?, user_sid: str?, friendly_name: str?, conversation_state: str, timers: any?, attributes: str?, date_created: str(date-time)?, date_updated: str(date-time)?, created_by: str?, notification_level: str, unique_name: str?, url: str(uri)?, links: map?} # OK\n\n@endpoint DELETE /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}\n@desc Delete a specific User Conversation.\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with., UserSid: str # 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: str # 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).}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}\n@desc Fetch a specific User Conversation.\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with., UserSid: str # 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: str # 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).}\n@returns(200) {account_sid: str?, chat_service_sid: str?, conversation_sid: str?, unread_messages_count: int?, last_read_message_index: int?, participant_sid: str?, user_sid: str?, friendly_name: str?, conversation_state: str, timers: any?, attributes: str?, date_created: str(date-time)?, date_updated: str(date-time)?, created_by: str?, notification_level: str, unique_name: str?, url: str(uri)?, links: map?} # OK\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations\n@desc Retrieve a list of all User Conversations for the User.\n@required {ChatServiceSid: str # The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with., UserSid: str # 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.}\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 50., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {conversations: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Services/{ChatServiceSid}/Configuration/Webhooks\n@desc Update a specific Webhook.\n@required {ChatServiceSid: str # The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.}\n@returns(200) {account_sid: str?, chat_service_sid: str?, pre_webhook_url: str(uri)?, post_webhook_url: str(uri)?, filters: [str]?, method: str, url: str(uri)?} # OK\n\n@endpoint GET /v1/Services/{ChatServiceSid}/Configuration/Webhooks\n@desc Fetch a specific service webhook configuration.\n@required {ChatServiceSid: str # The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.}\n@returns(200) {account_sid: str?, chat_service_sid: str?, pre_webhook_url: str(uri)?, post_webhook_url: str(uri)?, filters: [str]?, method: str, url: str(uri)?} # OK\n\n@endgroup\n\n@group Users\n@endpoint POST /v1/Users\n@desc Add a new conversation user to your account's default service\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(201) {sid: str?, account_sid: str?, chat_service_sid: str?, role_sid: str?, identity: str?, friendly_name: str?, attributes: str?, is_online: bool?, is_notifiable: bool?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, links: map?} # Created\n\n@endpoint GET /v1/Users\n@desc Retrieve a list of all conversation users in your account's default service\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 50., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {users: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endpoint POST /v1/Users/{Sid}\n@desc Update an existing conversation user in your account's default service\n@required {Sid: str # The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(200) {sid: str?, account_sid: str?, chat_service_sid: str?, role_sid: str?, identity: str?, friendly_name: str?, attributes: str?, is_online: bool?, is_notifiable: bool?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, links: map?} # OK\n\n@endpoint DELETE /v1/Users/{Sid}\n@desc Remove a conversation user from your account's default service\n@required {Sid: str # The SID of the User resource to delete. This value can be either the `sid` or the `identity` of the User resource to delete.}\n@optional {X-Twilio-Webhook-Enabled: str # The X-Twilio-Webhook-Enabled HTTP request header}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Users/{Sid}\n@desc Fetch a conversation user from your account's default service\n@required {Sid: str # The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch.}\n@returns(200) {sid: str?, account_sid: str?, chat_service_sid: str?, role_sid: str?, identity: str?, friendly_name: str?, attributes: str?, is_online: bool?, is_notifiable: bool?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, links: map?} # OK\n\n@endpoint POST /v1/Users/{UserSid}/Conversations/{ConversationSid}\n@desc Update a specific User Conversation.\n@required {UserSid: str # 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: str # 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).}\n@returns(200) {account_sid: str?, chat_service_sid: str?, conversation_sid: str?, unread_messages_count: int?, last_read_message_index: int?, participant_sid: str?, user_sid: str?, friendly_name: str?, conversation_state: str, timers: any?, attributes: str?, date_created: str(date-time)?, date_updated: str(date-time)?, created_by: str?, notification_level: str, unique_name: str?, url: str(uri)?, links: map?} # OK\n\n@endpoint DELETE /v1/Users/{UserSid}/Conversations/{ConversationSid}\n@desc Delete a specific User Conversation.\n@required {UserSid: str # 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: str # 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).}\n@returns(204) The resource was deleted successfully.\n\n@endpoint GET /v1/Users/{UserSid}/Conversations/{ConversationSid}\n@desc Fetch a specific User Conversation.\n@required {UserSid: str # 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: str # 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).}\n@returns(200) {account_sid: str?, chat_service_sid: str?, conversation_sid: str?, unread_messages_count: int?, last_read_message_index: int?, participant_sid: str?, user_sid: str?, friendly_name: str?, conversation_state: str, timers: any?, attributes: str?, date_created: str(date-time)?, date_updated: str(date-time)?, created_by: str?, notification_level: str, unique_name: str?, url: str(uri)?, links: map?} # OK\n\n@endpoint GET /v1/Users/{UserSid}/Conversations\n@desc Retrieve a list of all User Conversations for the User.\n@required {UserSid: str # 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.}\n@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 50., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}\n@returns(200) {conversations: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK\n\n@endgroup\n\n@end\n"}