{"openapi":"3.0.1","servers":[{"url":"https://conversations.twilio.com"}],"info":{"contact":{"email":"support@twilio.com","name":"Twilio Support","url":"https://support.twilio.com"},"description":"This is the public Twilio REST API.","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"termsOfService":"https://www.twilio.com/legal/tos","title":"Twilio - Conversations","version":"1.55.0","x-apisguru-categories":["telecom","messaging"],"x-logo":{"url":"https://static1.twilio.com/marketing/bundles/marketing/img/logos/wordmark-red.svg"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_conversations_v1.json","version":"3.0"}],"x-providerName":"twilio.com","x-serviceName":"twilio_conversations_v1"},"tags":[{"name":"ConversationsV1AddressConfiguration"},{"name":"ConversationsV1Binding"},{"name":"ConversationsV1Configuration"},{"name":"ConversationsV1Conversation"},{"name":"ConversationsV1Credential"},{"name":"ConversationsV1DeliveryReceipt"},{"name":"ConversationsV1Message"},{"name":"ConversationsV1Notification"},{"name":"ConversationsV1Participant"},{"name":"ConversationsV1ParticipantConversation"},{"name":"ConversationsV1Role"},{"name":"ConversationsV1Service"},{"name":"ConversationsV1User"},{"name":"ConversationsV1UserConversation"},{"name":"ConversationsV1Webhook"}],"paths":{"/v1/Configuration":{"description":"The Configuration resource manages a set of account-level settings applicable to the Conversations API.","get":{"description":"Fetch the global configuration of conversations on your account","operationId":"FetchConfiguration","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.configuration"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Configuration"],"x-maturity":["GA"]},"post":{"description":"Update the global configuration of conversations on your account","operationId":"UpdateConfiguration","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"DefaultChatServiceSid":{"description":"The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.","maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"DefaultClosedTimer":{"description":"Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.","type":"string"},"DefaultInactiveTimer":{"description":"Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.","type":"string"},"DefaultMessagingServiceSid":{"description":"The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation.","maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},"title":"UpdateConfigurationRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.configuration"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Configuration"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["account_sid","default_chat_service_sid","default_messaging_service_sid"],"pathType":"instance"}},"/v1/Configuration/Addresses":{"description":"Address Configuration resource manages the configurations related to a unique address within Conversations","get":{"description":"Retrieve a list of address configurations for an account","operationId":"ListConfigurationAddress","parameters":[{"description":"Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.","in":"query","name":"Type","schema":{"type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"address_configurations":{"items":{"$ref":"#/components/schemas/conversations.v1.configuration_address"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListConfigurationAddressResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1AddressConfiguration"],"x-maturity":["GA"]},"post":{"description":"Create a new address configuration","operationId":"CreateConfigurationAddress","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Address":{"description":"The unique address to be configured. The address can be a whatsapp address or phone number","type":"string"},"AddressCountry":{"description":"An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.","type":"string"},"AutoCreation.ConversationServiceSid":{"description":"Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.","maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"AutoCreation.Enabled":{"description":"Enable/Disable auto-creating conversations for messages to this address","type":"boolean"},"AutoCreation.StudioFlowSid":{"description":"For type `studio`, the studio flow SID where the webhook should be sent to.","maxLength":34,"minLength":34,"pattern":"^FW[0-9a-fA-F]{32}$","type":"string"},"AutoCreation.StudioRetryCount":{"description":"For type `studio`, number of times to retry the webhook request","type":"integer"},"AutoCreation.Type":{"$ref":"#/components/schemas/configuration_address_enum_auto_creation_type","description":"Type of Auto Creation. Value can be one of `webhook`, `studio` or `default`. `default` creates a new Conversation under the default Conversation service, without a webhook or Studio integration.","type":"string"},"AutoCreation.WebhookFilters":{"description":"The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`","items":{"type":"string"},"type":"array"},"AutoCreation.WebhookMethod":{"$ref":"#/components/schemas/configuration_address_enum_method","description":"For type `webhook`, the HTTP method to be used when sending a webhook request.","type":"string"},"AutoCreation.WebhookUrl":{"description":"For type `webhook`, the url for the webhook request.","type":"string"},"FriendlyName":{"description":"The human-readable name of this configuration, limited to 256 characters. Optional.","type":"string"},"Type":{"$ref":"#/components/schemas/configuration_address_enum_type","description":"Type of Address. Value can be `whatsapp` or `sms`.","type":"string"}},"required":["Type","Address"],"title":"CreateConfigurationAddressRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.configuration_address"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1AddressConfiguration"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","type","address","friendly_name"],"mountName":"address_configurations","pathType":"list"}},"/v1/Configuration/Addresses/{Sid}":{"delete":{"description":"Remove an existing address configuration","operationId":"DeleteConfigurationAddress","parameters":[{"description":"The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1AddressConfiguration"],"x-maturity":["GA"]},"description":"Address Configuration resource manages the configurations related to a unique address within Conversations","get":{"description":"Fetch an address configuration ","operationId":"FetchConfigurationAddress","parameters":[{"description":"The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.configuration_address"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1AddressConfiguration"],"x-maturity":["GA"]},"post":{"description":"Update an existing address configuration","operationId":"UpdateConfigurationAddress","parameters":[{"description":"The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"AutoCreation.ConversationServiceSid":{"description":"Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.","maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"AutoCreation.Enabled":{"description":"Enable/Disable auto-creating conversations for messages to this address","type":"boolean"},"AutoCreation.StudioFlowSid":{"description":"For type `studio`, the studio flow SID where the webhook should be sent to.","maxLength":34,"minLength":34,"pattern":"^FW[0-9a-fA-F]{32}$","type":"string"},"AutoCreation.StudioRetryCount":{"description":"For type `studio`, number of times to retry the webhook request","type":"integer"},"AutoCreation.Type":{"$ref":"#/components/schemas/configuration_address_enum_auto_creation_type","description":"Type of Auto Creation. Value can be one of `webhook`, `studio` or `default`.","type":"string"},"AutoCreation.WebhookFilters":{"description":"The list of events, firing webhook event for this Conversation. Values can be any of the following: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationStateUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onDeliveryUpdated`","items":{"type":"string"},"type":"array"},"AutoCreation.WebhookMethod":{"$ref":"#/components/schemas/configuration_address_enum_method","description":"For type `webhook`, the HTTP method to be used when sending a webhook request.","type":"string"},"AutoCreation.WebhookUrl":{"description":"For type `webhook`, the url for the webhook request.","type":"string"},"FriendlyName":{"description":"The human-readable name of this configuration, limited to 256 characters. Optional.","type":"string"}},"title":"UpdateConfigurationAddressRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.configuration_address"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1AddressConfiguration"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","type","address","friendly_name"],"mountName":"address_configurations","pathType":"instance"}},"/v1/Configuration/Webhooks":{"description":"A Webhook resource manages a service-level set of callback URLs and their configuration for receiving all conversation events.","get":{"description":"","operationId":"FetchConfigurationWebhook","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.configuration.configuration_webhook"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"post":{"description":"","operationId":"UpdateConfigurationWebhook","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Filters":{"description":"The list of webhook event triggers that are enabled for this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`","items":{"type":"string"},"type":"array"},"Method":{"description":"The HTTP method to be used when sending a webhook request.","type":"string"},"PostWebhookUrl":{"description":"The absolute url the post-event webhook request should be sent to.","type":"string"},"PreWebhookUrl":{"description":"The absolute url the pre-event webhook request should be sent to.","type":"string"},"Target":{"$ref":"#/components/schemas/configuration_webhook_enum_target","description":"The routing target of the webhook.","type":"string"}},"title":"UpdateConfigurationWebhookRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.configuration.configuration_webhook"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["target","method","pre_webhook_url","post_webhook_url"],"parent":"/Configuration","pathType":"instance"}},"/v1/Conversations":{"description":"A Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster.","get":{"description":"Retrieve a list of conversations in your account's default service","operationId":"ListConversation","parameters":[{"description":"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.","in":"query","name":"StartDate","schema":{"type":"string"}},{"description":"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.","in":"query","name":"EndDate","schema":{"type":"string"}},{"description":"State for sorting and filtering list of Conversations. Can be `active`, `inactive` or `closed`","in":"query","name":"State","schema":{"$ref":"#/components/schemas/conversation_enum_state","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"conversations":{"items":{"$ref":"#/components/schemas/conversations.v1.conversation"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListConversationResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Conversation"],"x-maturity":["GA"]},"post":{"description":"Create a new conversation in your account's default service","operationId":"CreateConversation","parameters":[{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/conversation_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","type":"string"},"Bindings.Email.Address":{"description":"The default email address that will be used when sending outbound emails in this conversation.","type":"string"},"Bindings.Email.Name":{"description":"The default name that will be used when sending outbound emails in this conversation.","type":"string"},"DateCreated":{"description":"The date that this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date that this resource was last updated.","format":"date-time","type":"string"},"FriendlyName":{"description":"The human-readable name of this conversation, limited to 256 characters. Optional.","type":"string"},"MessagingServiceSid":{"description":"The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"},"State":{"$ref":"#/components/schemas/conversation_enum_state","description":"Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active`","type":"string"},"Timers.Closed":{"description":"ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.","type":"string"},"Timers.Inactive":{"description":"ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.","type":"string"},"UniqueName":{"description":"An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.","type":"string"}},"title":"CreateConversationRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Conversation"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","chat_service_sid","friendly_name","date_created"],"dependentProperties":{"messages":{"mapping":{"conversation_sid":"sid"},"resource_url":"/v1/Conversations/{conversation_sid}/Messages"},"participants":{"mapping":{"conversation_sid":"sid"},"resource_url":"/v1/Conversations/{conversation_sid}/Participants"},"webhooks":{"mapping":{"conversation_sid":"sid"},"resource_url":"/v1/Conversations/{conversation_sid}/Webhooks"}},"pathType":"list"}},"/v1/Conversations/{ConversationSid}/Messages":{"description":"A Message resource represents a message in a conversation.","get":{"description":"Retrieve a list of all messages in the conversation","operationId":"ListConversationMessage","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for messages.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending), with `asc` as the default.","in":"query","name":"Order","schema":{"$ref":"#/components/schemas/conversation_message_enum_order_type","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_message"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListConversationMessageResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Message"],"x-maturity":["GA"]},"post":{"description":"Add a new message to the conversation","operationId":"CreateConversationMessage","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/conversation_message_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","type":"string"},"Author":{"description":"The channel specific identifier of the message's author. Defaults to `system`.","type":"string"},"Body":{"description":"The content of the message, can be up to 1,600 characters long.","type":"string"},"ContentSid":{"description":"The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages.  **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored.","maxLength":34,"minLength":34,"pattern":"^HX[0-9a-fA-F]{32}$","type":"string"},"ContentVariables":{"description":"A structurally valid JSON string that contains values to resolve Rich Content template variables.","type":"string"},"DateCreated":{"description":"The date that this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date that this resource was last updated. `null` if the message has not been edited.","format":"date-time","type":"string"},"MediaSid":{"description":"The Media SID to be attached to the new Message.","maxLength":34,"minLength":34,"pattern":"^ME[0-9a-fA-F]{32}$","type":"string"},"Subject":{"description":"The subject of the message, can be up to 256 characters long.","type":"string"}},"title":"CreateConversationMessageRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_message"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Message"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","index","author","date_created"],"dependentProperties":{"channel_metadata":{"mapping":{"conversation_sid":"conversation_sid","message_sid":"sid"},"resource_url":"/v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata"},"delivery_receipts":{"mapping":{"conversation_sid":"conversation_sid","message_sid":"sid"},"resource_url":"/v1/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts"}},"parent":"/Conversations/{Sid}","pathType":"list"}},"/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts":{"description":"A Message Receipt resource represents a delivery/read receipt of a message in a conversation.","get":{"description":"Retrieve a list of all delivery and read receipts of the conversation message","operationId":"ListConversationMessageReceipt","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.","in":"path","name":"MessageSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"delivery_receipts":{"items":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_message.conversation_message_receipt"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListConversationMessageReceiptResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1DeliveryReceipt"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","message_sid","status","date_created"],"mountName":"delivery_receipts","parent":"/Conversations/{ConversationSid}/Messages/{Sid}","pathType":"list"}},"/v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}":{"description":"A Message Receipt resource represents a delivery/read receipt of a message in a conversation.","get":{"description":"Fetch the delivery and read receipts of the conversation message","operationId":"FetchConversationMessageReceipt","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.","in":"path","name":"MessageSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^DY[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_message.conversation_message_receipt"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1DeliveryReceipt"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","message_sid","status","date_created"],"mountName":"delivery_receipts","parent":"/Conversations/{ConversationSid}/Messages/{Sid}","pathType":"instance"}},"/v1/Conversations/{ConversationSid}/Messages/{Sid}":{"delete":{"description":"Remove a message from the conversation","operationId":"DeleteConversationMessage","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/conversation_message_enum_webhook_enabled_type","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Message"],"x-maturity":["GA"]},"description":"A Message resource represents a message in a conversation.","get":{"description":"Fetch a message from the conversation","operationId":"FetchConversationMessage","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_message"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Message"],"x-maturity":["GA"]},"post":{"description":"Update an existing message in the conversation","operationId":"UpdateConversationMessage","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/conversation_message_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","type":"string"},"Author":{"description":"The channel specific identifier of the message's author. Defaults to `system`.","type":"string"},"Body":{"description":"The content of the message, can be up to 1,600 characters long.","type":"string"},"DateCreated":{"description":"The date that this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date that this resource was last updated. `null` if the message has not been edited.","format":"date-time","type":"string"},"Subject":{"description":"The subject of the message, can be up to 256 characters long.","type":"string"}},"title":"UpdateConversationMessageRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_message"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Message"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","index","author","date_created"],"dependentProperties":{"channel_metadata":{"mapping":{"conversation_sid":"conversation_sid","message_sid":"sid"},"resource_url":"/v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata"},"delivery_receipts":{"mapping":{"conversation_sid":"conversation_sid","message_sid":"sid"},"resource_url":"/v1/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts"}},"parent":"/Conversations/{Sid}","pathType":"instance"}},"/v1/Conversations/{ConversationSid}/Participants":{"description":"A Participant resource represents a member of the conversation.","get":{"description":"Retrieve a list of all participants of the conversation","operationId":"ListConversationParticipant","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for participants.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"participants":{"items":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_participant"},"type":"array"}},"title":"ListConversationParticipantResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Participant"],"x-maturity":["GA"]},"post":{"description":"Add a new participant to the conversation","operationId":"CreateConversationParticipant","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/conversation_participant_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","type":"string"},"DateCreated":{"description":"The date that this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date that this resource was last updated.","format":"date-time","type":"string"},"Identity":{"description":"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.","type":"string"},"MessagingBinding.Address":{"description":"The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from an SDK endpoint (see the 'identity' field).","type":"string"},"MessagingBinding.ProjectedAddress":{"description":"The address of the Twilio phone number that is used in Group MMS. Communication mask for the Conversation participant with Identity.","type":"string"},"MessagingBinding.ProxyAddress":{"description":"The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the 'identity' field).","type":"string"},"RoleSid":{"description":"The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.","maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}},"title":"CreateConversationParticipantRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_participant"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Participant"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","messaging_binding"],"parent":"/Conversations/{Sid}","pathType":"list"}},"/v1/Conversations/{ConversationSid}/Participants/{Sid}":{"delete":{"description":"Remove a participant from the conversation","operationId":"DeleteConversationParticipant","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/conversation_participant_enum_webhook_enabled_type","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Participant"],"x-maturity":["GA"]},"description":"A Participant resource represents a member of the conversation.","get":{"description":"Fetch a participant of the conversation","operationId":"FetchConversationParticipant","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's `identity` rather than the SID.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_participant"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Participant"],"x-maturity":["GA"]},"post":{"description":"Update an existing participant in the conversation","operationId":"UpdateConversationParticipant","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/conversation_participant_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","type":"string"},"DateCreated":{"description":"The date that this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date that this resource was last updated.","format":"date-time","type":"string"},"Identity":{"description":"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.","type":"string"},"LastReadMessageIndex":{"description":"Index of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.","nullable":true,"type":"integer"},"LastReadTimestamp":{"description":"Timestamp of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.","type":"string"},"MessagingBinding.ProjectedAddress":{"description":"The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it.","type":"string"},"MessagingBinding.ProxyAddress":{"description":"The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it.","type":"string"},"RoleSid":{"description":"The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.","maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}},"title":"UpdateConversationParticipantRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_participant"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Participant"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","messaging_binding"],"parent":"/Conversations/{Sid}","pathType":"instance"}},"/v1/Conversations/{ConversationSid}/Webhooks":{"description":"A Scoped Webhook resource manages a set of callback URLs and their configuration for receiving events specific to one conversation.","get":{"description":"Retrieve a list of all webhooks scoped to the conversation","operationId":"ListConversationScopedWebhook","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"webhooks":{"items":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook"},"type":"array"}},"title":"ListConversationScopedWebhookResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"post":{"description":"Create a new webhook scoped to the conversation","operationId":"CreateConversationScopedWebhook","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Configuration.Filters":{"description":"The list of events, firing webhook event for this Conversation.","items":{"type":"string"},"type":"array"},"Configuration.FlowSid":{"description":"The studio flow SID, where the webhook should be sent to.","maxLength":34,"minLength":34,"pattern":"^FW[0-9a-fA-F]{32}$","type":"string"},"Configuration.Method":{"$ref":"#/components/schemas/conversation_scoped_webhook_enum_method","description":"The HTTP method to be used when sending a webhook request.","type":"string"},"Configuration.ReplayAfter":{"description":"The message index for which and it's successors the webhook will be replayed. Not set by default","type":"integer"},"Configuration.Triggers":{"description":"The list of keywords, firing webhook event for this Conversation.","items":{"type":"string"},"type":"array"},"Configuration.Url":{"description":"The absolute url the webhook request should be sent to.","type":"string"},"Target":{"$ref":"#/components/schemas/conversation_scoped_webhook_enum_target","description":"The target of this webhook: `webhook`, `studio`, `trigger`","type":"string"}},"required":["Target"],"title":"CreateConversationScopedWebhookRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","target"],"parent":"/Conversations/{Sid}","pathType":"list"}},"/v1/Conversations/{ConversationSid}/Webhooks/{Sid}":{"delete":{"description":"Remove an existing webhook scoped to the conversation","operationId":"DeleteConversationScopedWebhook","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^WH[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"description":"A Scoped Webhook resource manages a set of callback URLs and their configuration for receiving events specific to one conversation.","get":{"description":"Fetch the configuration of a conversation-scoped webhook","operationId":"FetchConversationScopedWebhook","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^WH[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"post":{"description":"Update an existing conversation-scoped webhook","operationId":"UpdateConversationScopedWebhook","parameters":[{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^WH[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Configuration.Filters":{"description":"The list of events, firing webhook event for this Conversation.","items":{"type":"string"},"type":"array"},"Configuration.FlowSid":{"description":"The studio flow SID, where the webhook should be sent to.","maxLength":34,"minLength":34,"pattern":"^FW[0-9a-fA-F]{32}$","type":"string"},"Configuration.Method":{"$ref":"#/components/schemas/conversation_scoped_webhook_enum_method","description":"The HTTP method to be used when sending a webhook request.","type":"string"},"Configuration.Triggers":{"description":"The list of keywords, firing webhook event for this Conversation.","items":{"type":"string"},"type":"array"},"Configuration.Url":{"description":"The absolute url the webhook request should be sent to.","type":"string"}},"title":"UpdateConversationScopedWebhookRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","target"],"parent":"/Conversations/{Sid}","pathType":"instance"}},"/v1/Conversations/{Sid}":{"delete":{"description":"Remove a conversation from your account's default service","operationId":"DeleteConversation","parameters":[{"description":"A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/conversation_enum_webhook_enabled_type","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Conversation"],"x-maturity":["GA"]},"description":"A Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster.","get":{"description":"Fetch a conversation from your account's default service","operationId":"FetchConversation","parameters":[{"description":"A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Conversation"],"x-maturity":["GA"]},"post":{"description":"Update an existing conversation in your account's default service","operationId":"UpdateConversation","parameters":[{"description":"A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/conversation_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","type":"string"},"Bindings.Email.Address":{"description":"The default email address that will be used when sending outbound emails in this conversation.","type":"string"},"Bindings.Email.Name":{"description":"The default name that will be used when sending outbound emails in this conversation.","type":"string"},"DateCreated":{"description":"The date that this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date that this resource was last updated.","format":"date-time","type":"string"},"FriendlyName":{"description":"The human-readable name of this conversation, limited to 256 characters. Optional.","type":"string"},"MessagingServiceSid":{"description":"The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"},"State":{"$ref":"#/components/schemas/conversation_enum_state","description":"Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active`","type":"string"},"Timers.Closed":{"description":"ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.","type":"string"},"Timers.Inactive":{"description":"ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.","type":"string"},"UniqueName":{"description":"An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.","type":"string"}},"title":"UpdateConversationRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.conversation"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Conversation"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","chat_service_sid","friendly_name","date_created"],"dependentProperties":{"messages":{"mapping":{"conversation_sid":"sid"},"resource_url":"/v1/Conversations/{conversation_sid}/Messages"},"participants":{"mapping":{"conversation_sid":"sid"},"resource_url":"/v1/Conversations/{conversation_sid}/Participants"},"webhooks":{"mapping":{"conversation_sid":"sid"},"resource_url":"/v1/Conversations/{conversation_sid}/Webhooks"}},"pathType":"instance"}},"/v1/Credentials":{"description":"A Credential resource represents a push notification credential.","get":{"description":"Retrieve a list of all push notification credentials on your account","operationId":"ListCredential","parameters":[{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"credentials":{"items":{"$ref":"#/components/schemas/conversations.v1.credential"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListCredentialResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Credential"],"x-maturity":["GA"]},"post":{"description":"Add a new push notification credential to your account","operationId":"CreateCredential","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"ApiKey":{"description":"[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.","type":"string"},"Certificate":{"description":"[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==\n-----END CERTIFICATE-----`.","type":"string"},"FriendlyName":{"description":"A descriptive string that you create to describe the new resource. It can be up to 64 characters long.","type":"string"},"PrivateKey":{"description":"[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...\n-----END RSA PRIVATE KEY-----`.","type":"string"},"Sandbox":{"description":"[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.","type":"boolean"},"Secret":{"description":"[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.","type":"string"},"Type":{"$ref":"#/components/schemas/credential_enum_push_type","description":"The type of push-notification service the credential is for. Can be: `fcm`, `gcm`, or `apn`.","type":"string"}},"required":["Type"],"title":"CreateCredentialRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.credential"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Credential"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","friendly_name","type"],"pathType":"list"}},"/v1/Credentials/{Sid}":{"delete":{"description":"Remove a push notification credential from your account","operationId":"DeleteCredential","parameters":[{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^CR[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Credential"],"x-maturity":["GA"]},"description":"A Credential resource represents a push notification credential.","get":{"description":"Fetch a push notification credential from your account","operationId":"FetchCredential","parameters":[{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^CR[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.credential"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Credential"],"x-maturity":["GA"]},"post":{"description":"Update an existing push notification credential on your account","operationId":"UpdateCredential","parameters":[{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^CR[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"ApiKey":{"description":"[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.","type":"string"},"Certificate":{"description":"[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==\n-----END CERTIFICATE-----`.","type":"string"},"FriendlyName":{"description":"A descriptive string that you create to describe the new resource. It can be up to 64 characters long.","type":"string"},"PrivateKey":{"description":"[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...\n-----END RSA PRIVATE KEY-----`.","type":"string"},"Sandbox":{"description":"[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.","type":"boolean"},"Secret":{"description":"[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.","type":"string"},"Type":{"$ref":"#/components/schemas/credential_enum_push_type","description":"The type of push-notification service the credential is for. Can be: `fcm`, `gcm`, or `apn`.","type":"string"}},"title":"UpdateCredentialRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.credential"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Credential"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","friendly_name","type"],"pathType":"instance"}},"/v1/ParticipantConversations":{"description":"Participant Conversations resource represents a list of Conversations that this Participant belongs to belonging to a default conversation service.","get":{"description":"Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.","operationId":"ListParticipantConversation","parameters":[{"description":"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.","in":"query","name":"Identity","schema":{"type":"string"}},{"description":"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.","in":"query","name":"Address","schema":{"type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"conversations":{"items":{"$ref":"#/components/schemas/conversations.v1.participant_conversation"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListParticipantConversationResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1ParticipantConversation"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["chat_service_sid","participant_sid","conversation_sid"],"pathType":"list"}},"/v1/Roles":{"description":"A Role resource represents a set of permissions granted to a user within a service or a conversation.","get":{"description":"Retrieve a list of all user roles in your account's default service","operationId":"ListRole","parameters":[{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"roles":{"items":{"$ref":"#/components/schemas/conversations.v1.role"},"type":"array"}},"title":"ListRoleResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Role"],"x-maturity":["GA"]},"post":{"description":"Create a new user role in your account's default service","operationId":"CreateRole","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"FriendlyName":{"description":"A descriptive string that you create to describe the new resource. It can be up to 64 characters long.","type":"string"},"Permission":{"description":"A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type`.","items":{"type":"string"},"type":"array"},"Type":{"$ref":"#/components/schemas/role_enum_role_type","description":"The type of role. Can be: `conversation` for [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) roles or `service` for [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) roles.","type":"string"}},"required":["FriendlyName","Type","Permission"],"title":"CreateRoleRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.role"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Role"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","friendly_name","type"],"pathType":"list"}},"/v1/Roles/{Sid}":{"delete":{"description":"Remove a user role from your account's default service","operationId":"DeleteRole","parameters":[{"description":"The SID of the Role resource to delete.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Role"],"x-maturity":["GA"]},"description":"A Role resource represents a set of permissions granted to a user within a service or a conversation.","get":{"description":"Fetch a user role from your account's default service","operationId":"FetchRole","parameters":[{"description":"The SID of the Role resource to fetch.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.role"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Role"],"x-maturity":["GA"]},"post":{"description":"Update an existing user role in your account's default service","operationId":"UpdateRole","parameters":[{"description":"The SID of the Role resource to update.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Permission":{"description":"A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's `type`.","items":{"type":"string"},"type":"array"}},"required":["Permission"],"title":"UpdateRoleRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.role"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Role"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","friendly_name","type"],"pathType":"instance"}},"/v1/Services":{"description":"A Service resource is a top-level conversation resource container that serves as a data silo.","get":{"description":"Retrieve a list of all conversation services on your account","operationId":"ListService","parameters":[{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"services":{"items":{"$ref":"#/components/schemas/conversations.v1.service"},"type":"array"}},"title":"ListServiceResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Service"],"x-maturity":["GA"]},"post":{"description":"Create a new conversation service on your account","operationId":"CreateService","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"FriendlyName":{"description":"The human-readable name of this service, limited to 256 characters. Optional.","type":"string"}},"required":["FriendlyName"],"title":"CreateServiceRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Service"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","friendly_name"],"dependentProperties":{"bindings":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Bindings"},"configuration":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Configuration"},"conversations":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations"},"participant_conversations":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/ParticipantConversations"},"roles":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Roles"},"users":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Users"}},"pathType":"list"}},"/v1/Services/{ChatServiceSid}/Bindings":{"description":"A Binding resource represents a push notification binding and its configuration, for delivering conversation events to mobile or web endpoints.","get":{"description":"Retrieve a list of all push notification bindings in the conversation service","operationId":"ListServiceBinding","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"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.","in":"query","name":"BindingType","schema":{"items":{"$ref":"#/components/schemas/service_binding_enum_binding_type","type":"string"},"type":"array"}},{"description":"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.","in":"query","name":"Identity","schema":{"items":{"type":"string"},"type":"array"},"x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"bindings":{"items":{"$ref":"#/components/schemas/conversations.v1.service.service_binding"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListServiceBindingResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Binding"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","endpoint","identity"],"parent":"/Services/{Sid}","pathType":"list"}},"/v1/Services/{ChatServiceSid}/Bindings/{Sid}":{"delete":{"description":"Remove a push notification binding from the conversation service","operationId":"DeleteServiceBinding","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the Binding resource from.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the Binding resource to delete.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^BS[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Binding"],"x-maturity":["GA"]},"description":"A Binding resource represents a push notification binding and its configuration, for delivering conversation events to mobile or web endpoints.","get":{"description":"Fetch a push notification binding from the conversation service","operationId":"FetchServiceBinding","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^BS[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_binding"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Binding"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","endpoint","identity"],"parent":"/Services/{Sid}","pathType":"instance"}},"/v1/Services/{ChatServiceSid}/Configuration":{"description":"A Service Configuration resource manages service-level settings applicable to the Conversation API.","get":{"description":"Fetch the configuration of a conversation service","operationId":"FetchServiceConfiguration","parameters":[{"description":"The SID of the Service configuration resource to fetch.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_configuration"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Configuration"],"x-maturity":["GA"]},"post":{"description":"Update configuration settings of a conversation service","operationId":"UpdateServiceConfiguration","parameters":[{"description":"The SID of the Service configuration resource to update.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"DefaultChatServiceRoleSid":{"description":"The service-level role assigned to users when they are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.","maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"DefaultConversationCreatorRoleSid":{"description":"The conversation-level role assigned to a conversation creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.","maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"DefaultConversationRoleSid":{"description":"The conversation-level role assigned to users when they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.","maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"ReachabilityEnabled":{"description":"Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`.","type":"boolean"}},"title":"UpdateServiceConfigurationRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_configuration"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Configuration"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["chat_service_sid"],"parent":"/Services/{Sid}","pathType":"instance"}},"/v1/Services/{ChatServiceSid}/Configuration/Notifications":{"description":"A Service Notification resource manages a set of settings to determine push notification behavior at service level.","get":{"description":"Fetch push notification service settings","operationId":"FetchServiceNotification","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_configuration.service_notification"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Notification"],"x-maturity":["GA"]},"post":{"description":"Update push notification service settings","operationId":"UpdateServiceNotification","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"AddedToConversation.Enabled":{"description":"Whether to send a notification when a participant is added to a conversation. The default is `false`.","type":"boolean"},"AddedToConversation.Sound":{"description":"The name of the sound to play when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.","type":"string"},"AddedToConversation.Template":{"description":"The template to use to create the notification text displayed when a participant is added to a conversation and `added_to_conversation.enabled` is `true`.","type":"string"},"LogEnabled":{"description":"Weather the notification logging is enabled.","type":"boolean"},"NewMessage.BadgeCountEnabled":{"description":"Whether the new message badge is enabled. The default is `false`.","type":"boolean"},"NewMessage.Enabled":{"description":"Whether to send a notification when a new message is added to a conversation. The default is `false`.","type":"boolean"},"NewMessage.Sound":{"description":"The name of the sound to play when a new message is added to a conversation and `new_message.enabled` is `true`.","type":"string"},"NewMessage.Template":{"description":"The template to use to create the notification text displayed when a new message is added to a conversation and `new_message.enabled` is `true`.","type":"string"},"NewMessage.WithMedia.Enabled":{"description":"Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is `false`.","type":"boolean"},"NewMessage.WithMedia.Template":{"description":"The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and `new_message.attachments.enabled` is `true`.","type":"string"},"RemovedFromConversation.Enabled":{"description":"Whether to send a notification to a user when they are removed from a conversation. The default is `false`.","type":"boolean"},"RemovedFromConversation.Sound":{"description":"The name of the sound to play to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.","type":"string"},"RemovedFromConversation.Template":{"description":"The template to use to create the notification text displayed to a user when they are removed from a conversation and `removed_from_conversation.enabled` is `true`.","type":"string"}},"title":"UpdateServiceNotificationRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_configuration.service_notification"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Notification"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["chat_service_sid"],"parent":"/Services/{ChatServiceSid}/Configuration","pathType":"instance"}},"/v1/Services/{ChatServiceSid}/Configuration/Webhooks":{"description":"A service webhook configuration resource manages a service-level set of callback URLs and their configuration for receiving all the corresponding service events.","get":{"description":"Fetch a specific service webhook configuration.","operationId":"FetchServiceWebhookConfiguration","parameters":[{"description":"The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"post":{"description":"Update a specific Webhook.","operationId":"UpdateServiceWebhookConfiguration","parameters":[{"description":"The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Filters":{"description":"The list of events that your configured webhook targets will receive. Events not configured here will not fire. Possible values are `onParticipantAdd`, `onParticipantAdded`, `onDeliveryUpdated`, `onConversationUpdated`, `onConversationRemove`, `onParticipantRemove`, `onConversationUpdate`, `onMessageAdd`, `onMessageRemoved`, `onParticipantUpdated`, `onConversationAdded`, `onMessageAdded`, `onConversationAdd`, `onConversationRemoved`, `onParticipantUpdate`, `onMessageRemove`, `onMessageUpdated`, `onParticipantRemoved`, `onMessageUpdate` or `onConversationStateUpdated`.","items":{"type":"string"},"type":"array"},"Method":{"description":"The HTTP method to be used when sending a webhook request. One of `GET` or `POST`.","type":"string"},"PostWebhookUrl":{"description":"The absolute url the post-event webhook request should be sent to.","format":"uri","type":"string"},"PreWebhookUrl":{"description":"The absolute url the pre-event webhook request should be sent to.","format":"uri","type":"string"}},"title":"UpdateServiceWebhookConfigurationRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["chat_service_sid"],"parent":"/Services/{ChatServiceSid}/Configuration","pathType":"instance"}},"/v1/Services/{ChatServiceSid}/Conversations":{"description":"A Service Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster.","get":{"description":"Retrieve a list of conversations in your service","operationId":"ListServiceConversation","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"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.","in":"query","name":"StartDate","schema":{"type":"string"}},{"description":"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.","in":"query","name":"EndDate","schema":{"type":"string"}},{"description":"State for sorting and filtering list of Conversations. Can be `active`, `inactive` or `closed`","in":"query","name":"State","schema":{"$ref":"#/components/schemas/service_conversation_enum_state","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"conversations":{"items":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListServiceConversationResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Conversation"],"x-maturity":["GA"]},"post":{"description":"Create a new conversation in your service","operationId":"CreateServiceConversation","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_conversation_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","type":"string"},"Bindings.Email.Address":{"description":"The default email address that will be used when sending outbound emails in this conversation.","type":"string"},"Bindings.Email.Name":{"description":"The default name that will be used when sending outbound emails in this conversation.","type":"string"},"DateCreated":{"description":"The date that this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date that this resource was last updated.","format":"date-time","type":"string"},"FriendlyName":{"description":"The human-readable name of this conversation, limited to 256 characters. Optional.","type":"string"},"MessagingServiceSid":{"description":"The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"},"State":{"$ref":"#/components/schemas/service_conversation_enum_state","description":"Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active`","type":"string"},"Timers.Closed":{"description":"ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.","type":"string"},"Timers.Inactive":{"description":"ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.","type":"string"},"UniqueName":{"description":"An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.","type":"string"}},"title":"CreateServiceConversationRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Conversation"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","chat_service_sid","friendly_name","date_created"],"dependentProperties":{"messages":{"mapping":{"chat_service_sid":"chat_service_sid","conversation_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages"},"participants":{"mapping":{"chat_service_sid":"chat_service_sid","conversation_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Participants"},"webhooks":{"mapping":{"chat_service_sid":"chat_service_sid","conversation_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Webhooks"}},"parent":"/Services/{Sid}","pathType":"list"}},"/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages":{"description":"A Service Message resource represents a message in a conversation within a specific service.","get":{"description":"Retrieve a list of all messages in the conversation","operationId":"ListServiceConversationMessage","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for messages.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending), with `asc` as the default.","in":"query","name":"Order","schema":{"$ref":"#/components/schemas/service_conversation_message_enum_order_type","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListServiceConversationMessageResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Message"],"x-maturity":["GA"]},"post":{"description":"Add a new message to the conversation in a specific service","operationId":"CreateServiceConversationMessage","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_conversation_message_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","type":"string"},"Author":{"description":"The channel specific identifier of the message's author. Defaults to `system`.","type":"string"},"Body":{"description":"The content of the message, can be up to 1,600 characters long.","type":"string"},"ContentSid":{"description":"The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template, required for template-generated messages.  **Note** that if this field is set, `Body` and `MediaSid` parameters are ignored.","maxLength":34,"minLength":34,"pattern":"^HX[0-9a-fA-F]{32}$","type":"string"},"ContentVariables":{"description":"A structurally valid JSON string that contains values to resolve Rich Content template variables.","type":"string"},"DateCreated":{"description":"The date that this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date that this resource was last updated. `null` if the message has not been edited.","format":"date-time","type":"string"},"MediaSid":{"description":"The Media SID to be attached to the new Message.","maxLength":34,"minLength":34,"pattern":"^ME[0-9a-fA-F]{32}$","type":"string"},"Subject":{"description":"The subject of the message, can be up to 256 characters long.","type":"string"}},"title":"CreateServiceConversationMessageRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Message"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","index","author","date_created"],"dependentProperties":{"channel_metadata":{"mapping":{"chat_service_sid":"chat_service_sid","conversation_sid":"conversation_sid","message_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata"},"delivery_receipts":{"mapping":{"chat_service_sid":"chat_service_sid","conversation_sid":"conversation_sid","message_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts"}},"parent":"/Services/{ChatServiceSid}/Conversations/{Sid}","pathType":"list"}},"/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts":{"description":"A Service Message Receipt resource represents a delivery/read receipt of a message in a conversation.","get":{"description":"Retrieve a list of all delivery and read receipts of the conversation message","operationId":"ListServiceConversationMessageReceipt","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.","in":"path","name":"MessageSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"delivery_receipts":{"items":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListServiceConversationMessageReceiptResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1DeliveryReceipt"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","message_sid","status","date_created"],"mountName":"delivery_receipts","parent":"/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}","pathType":"list"}},"/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}":{"description":"A Service Message Receipt resource represents a delivery/read receipt of a message in a conversation.","get":{"description":"Fetch the delivery and read receipts of the conversation message","operationId":"FetchServiceConversationMessageReceipt","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to.","in":"path","name":"MessageSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^DY[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1DeliveryReceipt"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","message_sid","status","date_created"],"mountName":"delivery_receipts","parent":"/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}","pathType":"instance"}},"/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}":{"delete":{"description":"Remove a message from the conversation","operationId":"DeleteServiceConversationMessage","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_conversation_message_enum_webhook_enabled_type","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Message"],"x-maturity":["GA"]},"description":"A Service Message resource represents a message in a conversation within a specific service.","get":{"description":"Fetch a message from the conversation","operationId":"FetchServiceConversationMessage","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Message"],"x-maturity":["GA"]},"post":{"description":"Update an existing message in the conversation","operationId":"UpdateServiceConversationMessage","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_conversation_message_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","type":"string"},"Author":{"description":"The channel specific identifier of the message's author. Defaults to `system`.","type":"string"},"Body":{"description":"The content of the message, can be up to 1,600 characters long.","type":"string"},"DateCreated":{"description":"The date that this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date that this resource was last updated. `null` if the message has not been edited.","format":"date-time","type":"string"},"Subject":{"description":"The subject of the message, can be up to 256 characters long.","type":"string"}},"title":"UpdateServiceConversationMessageRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Message"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","index","author","date_created"],"dependentProperties":{"channel_metadata":{"mapping":{"chat_service_sid":"chat_service_sid","conversation_sid":"conversation_sid","message_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata"},"delivery_receipts":{"mapping":{"chat_service_sid":"chat_service_sid","conversation_sid":"conversation_sid","message_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts"}},"parent":"/Services/{ChatServiceSid}/Conversations/{Sid}","pathType":"instance"}},"/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants":{"description":"A Service Participant resource represents a member of the conversation within a specific service.","get":{"description":"Retrieve a list of all participants of the conversation","operationId":"ListServiceConversationParticipant","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for participants.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"participants":{"items":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant"},"type":"array"}},"title":"ListServiceConversationParticipantResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Participant"],"x-maturity":["GA"]},"post":{"description":"Add a new participant to the conversation in a specific service","operationId":"CreateServiceConversationParticipant","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_conversation_participant_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set `{}` will be returned.","type":"string"},"DateCreated":{"description":"The date on which this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date on which this resource was last updated.","format":"date-time","type":"string"},"Identity":{"description":"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 [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.","type":"string"},"MessagingBinding.Address":{"description":"The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with `proxy_address`) is only null when the participant is interacting from an SDK endpoint (see the `identity` field).","type":"string"},"MessagingBinding.ProjectedAddress":{"description":"The address of the Twilio phone number that is used in Group MMS.","type":"string"},"MessagingBinding.ProxyAddress":{"description":"The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the `identity` field).","type":"string"},"RoleSid":{"description":"The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.","maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}},"title":"CreateServiceConversationParticipantRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Participant"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","messaging_binding"],"parent":"/Services/{ChatServiceSid}/Conversations/{Sid}","pathType":"list"}},"/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}":{"delete":{"description":"Remove a participant from the conversation","operationId":"DeleteServiceConversationParticipant","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_conversation_participant_enum_webhook_enabled_type","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Participant"],"x-maturity":["GA"]},"description":"A Service Participant resource represents a member of the conversation within a specific service.","get":{"description":"Fetch a participant of the conversation","operationId":"FetchServiceConversationParticipant","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's `identity` rather than the SID.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Participant"],"x-maturity":["GA"]},"post":{"description":"Update an existing participant in the conversation","operationId":"UpdateServiceConversationParticipant","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_conversation_participant_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set `{}` will be returned.","type":"string"},"DateCreated":{"description":"The date on which this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date on which this resource was last updated.","format":"date-time","type":"string"},"Identity":{"description":"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 [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.","type":"string"},"LastReadMessageIndex":{"description":"Index of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.","nullable":true,"type":"integer"},"LastReadTimestamp":{"description":"Timestamp of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.","type":"string"},"MessagingBinding.ProjectedAddress":{"description":"The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it.","type":"string"},"MessagingBinding.ProxyAddress":{"description":"The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it.","type":"string"},"RoleSid":{"description":"The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.","maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}},"title":"UpdateServiceConversationParticipantRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Participant"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","messaging_binding"],"parent":"/Services/{ChatServiceSid}/Conversations/{Sid}","pathType":"instance"}},"/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks":{"description":"A Conversation-scoped Webhook resource manages a set of callback URLs and their configuration for receiving events specific to one conversation.","get":{"description":"Retrieve a list of all webhooks scoped to the conversation","operationId":"ListServiceConversationScopedWebhook","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"webhooks":{"items":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook"},"type":"array"}},"title":"ListServiceConversationScopedWebhookResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"post":{"description":"Create a new webhook scoped to the conversation in a specific service","operationId":"CreateServiceConversationScopedWebhook","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Configuration.Filters":{"description":"The list of events, firing webhook event for this Conversation.","items":{"type":"string"},"type":"array"},"Configuration.FlowSid":{"description":"The studio flow SID, where the webhook should be sent to.","maxLength":34,"minLength":34,"pattern":"^FW[0-9a-fA-F]{32}$","type":"string"},"Configuration.Method":{"$ref":"#/components/schemas/service_conversation_scoped_webhook_enum_method","description":"The HTTP method to be used when sending a webhook request.","type":"string"},"Configuration.ReplayAfter":{"description":"The message index for which and it's successors the webhook will be replayed. Not set by default","type":"integer"},"Configuration.Triggers":{"description":"The list of keywords, firing webhook event for this Conversation.","items":{"type":"string"},"type":"array"},"Configuration.Url":{"description":"The absolute url the webhook request should be sent to.","type":"string"},"Target":{"$ref":"#/components/schemas/service_conversation_scoped_webhook_enum_target","description":"The target of this webhook: `webhook`, `studio`, `trigger`","type":"string"}},"required":["Target"],"title":"CreateServiceConversationScopedWebhookRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","target"],"parent":"/Services/{ChatServiceSid}/Conversations/{Sid}","pathType":"list"}},"/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}":{"delete":{"description":"Remove an existing webhook scoped to the conversation","operationId":"DeleteServiceConversationScopedWebhook","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^WH[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"description":"A Conversation-scoped Webhook resource manages a set of callback URLs and their configuration for receiving events specific to one conversation.","get":{"description":"Fetch the configuration of a conversation-scoped webhook","operationId":"FetchServiceConversationScopedWebhook","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^WH[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"post":{"description":"Update an existing conversation-scoped webhook","operationId":"UpdateServiceConversationScopedWebhook","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}},{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^WH[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Configuration.Filters":{"description":"The list of events, firing webhook event for this Conversation.","items":{"type":"string"},"type":"array"},"Configuration.FlowSid":{"description":"The studio flow SID, where the webhook should be sent to.","maxLength":34,"minLength":34,"pattern":"^FW[0-9a-fA-F]{32}$","type":"string"},"Configuration.Method":{"$ref":"#/components/schemas/service_conversation_scoped_webhook_enum_method","description":"The HTTP method to be used when sending a webhook request.","type":"string"},"Configuration.Triggers":{"description":"The list of keywords, firing webhook event for this Conversation.","items":{"type":"string"},"type":"array"},"Configuration.Url":{"description":"The absolute url the webhook request should be sent to.","type":"string"}},"title":"UpdateServiceConversationScopedWebhookRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Webhook"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","target"],"parent":"/Services/{ChatServiceSid}/Conversations/{Sid}","pathType":"instance"}},"/v1/Services/{ChatServiceSid}/Conversations/{Sid}":{"delete":{"description":"Remove a conversation from your service","operationId":"DeleteServiceConversation","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_conversation_enum_webhook_enabled_type","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Conversation"],"x-maturity":["GA"]},"description":"A Service Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster.","get":{"description":"Fetch a conversation from your service","operationId":"FetchServiceConversation","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Conversation"],"x-maturity":["GA"]},"post":{"description":"Update an existing conversation in your service","operationId":"UpdateServiceConversation","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_conversation_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","type":"string"},"Bindings.Email.Address":{"description":"The default email address that will be used when sending outbound emails in this conversation.","type":"string"},"Bindings.Email.Name":{"description":"The default name that will be used when sending outbound emails in this conversation.","type":"string"},"DateCreated":{"description":"The date that this resource was created.","format":"date-time","type":"string"},"DateUpdated":{"description":"The date that this resource was last updated.","format":"date-time","type":"string"},"FriendlyName":{"description":"The human-readable name of this conversation, limited to 256 characters. Optional.","type":"string"},"MessagingServiceSid":{"description":"The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"},"State":{"$ref":"#/components/schemas/service_conversation_enum_state","description":"Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active`","type":"string"},"Timers.Closed":{"description":"ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.","type":"string"},"Timers.Inactive":{"description":"ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.","type":"string"},"UniqueName":{"description":"An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.","type":"string"}},"title":"UpdateServiceConversationRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_conversation"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Conversation"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","chat_service_sid","friendly_name","date_created"],"dependentProperties":{"messages":{"mapping":{"chat_service_sid":"chat_service_sid","conversation_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages"},"participants":{"mapping":{"chat_service_sid":"chat_service_sid","conversation_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Participants"},"webhooks":{"mapping":{"chat_service_sid":"chat_service_sid","conversation_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Webhooks"}},"parent":"/Services/{Sid}","pathType":"instance"}},"/v1/Services/{ChatServiceSid}/ParticipantConversations":{"description":"Service Participant Conversations resource represents a list of Conversations that this Participant belongs to belonging to a specific conversation service.","get":{"description":"Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified.","operationId":"ListServiceParticipantConversation","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant Conversations resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"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.","in":"query","name":"Identity","schema":{"type":"string"}},{"description":"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.","in":"query","name":"Address","schema":{"type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"conversations":{"items":{"$ref":"#/components/schemas/conversations.v1.service.service_participant_conversation"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListServiceParticipantConversationResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1ParticipantConversation"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["chat_service_sid","participant_sid","conversation_sid"],"parent":"/Services/{Sid}","pathType":"list"}},"/v1/Services/{ChatServiceSid}/Roles":{"description":"A Service Role resource represents a set of permissions granted to a user within a service or a conversation.","get":{"description":"Retrieve a list of all user roles in your service","operationId":"ListServiceRole","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the Role resources from.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"roles":{"items":{"$ref":"#/components/schemas/conversations.v1.service.service_role"},"type":"array"}},"title":"ListServiceRoleResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Role"],"x-maturity":["GA"]},"post":{"description":"Create a new user role in your service","operationId":"CreateServiceRole","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to create the Role resource under.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"FriendlyName":{"description":"A descriptive string that you create to describe the new resource. It can be up to 64 characters long.","type":"string"},"Permission":{"description":"A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type`.","items":{"type":"string"},"type":"array"},"Type":{"$ref":"#/components/schemas/service_role_enum_role_type","description":"The type of role. Can be: `conversation` for [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) roles or `service` for [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) roles.","type":"string"}},"required":["FriendlyName","Type","Permission"],"title":"CreateServiceRoleRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_role"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Role"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","friendly_name","type"],"parent":"/Services/{Sid}","pathType":"list"}},"/v1/Services/{ChatServiceSid}/Roles/{Sid}":{"delete":{"description":"Remove a user role from your service","operationId":"DeleteServiceRole","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the Role resource from.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the Role resource to delete.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Role"],"x-maturity":["GA"]},"description":"A Service Role resource represents a set of permissions granted to a user within a service or a conversation.","get":{"description":"Fetch a user role from your service","operationId":"FetchServiceRole","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the Role resource from.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the Role resource to fetch.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_role"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Role"],"x-maturity":["GA"]},"post":{"description":"Update an existing user role in your service","operationId":"UpdateServiceRole","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to update the Role resource in.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the Role resource to update.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Permission":{"description":"A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's `type`.","items":{"type":"string"},"type":"array"}},"required":["Permission"],"title":"UpdateServiceRoleRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_role"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Role"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","friendly_name","type"],"parent":"/Services/{Sid}","pathType":"instance"}},"/v1/Services/{ChatServiceSid}/Users":{"description":"A Service User resource represents a conversation user belonging to a specific conversation service.","get":{"description":"Retrieve a list of all conversation users in your service","operationId":"ListServiceUser","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the User resources from.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"users":{"items":{"$ref":"#/components/schemas/conversations.v1.service.service_user"},"type":"array"}},"title":"ListServiceUserResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1User"],"x-maturity":["GA"]},"post":{"description":"Add a new conversation user to your service","operationId":"CreateServiceUser","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_user_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.","type":"string"},"FriendlyName":{"description":"The string that you assigned to describe the resource.","type":"string"},"Identity":{"description":"The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.","type":"string"},"RoleSid":{"description":"The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user.","maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}},"required":["Identity"],"title":"CreateServiceUserRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_user"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1User"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","identity"],"dependentProperties":{"user_conversations":{"mapping":{"chat_service_sid":"chat_service_sid","user_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Users/{user_sid}/Conversations"}},"parent":"/Services/{Sid}","pathType":"list"}},"/v1/Services/{ChatServiceSid}/Users/{Sid}":{"delete":{"description":"Remove a conversation user from your service","operationId":"DeleteServiceUser","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the User resource from.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the User resource to delete. This value can be either the `sid` or the `identity` of the User resource to delete.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_user_enum_webhook_enabled_type","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1User"],"x-maturity":["GA"]},"description":"A Service User resource represents a conversation user belonging to a specific conversation service.","get":{"description":"Fetch a conversation user from your service","operationId":"FetchServiceUser","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the User resource from.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_user"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1User"],"x-maturity":["GA"]},"post":{"description":"Update an existing conversation user in your service","operationId":"UpdateServiceUser","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/service_user_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.","type":"string"},"FriendlyName":{"description":"The string that you assigned to describe the resource.","type":"string"},"RoleSid":{"description":"The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user.","maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}},"title":"UpdateServiceUserRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_user"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1User"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","identity"],"dependentProperties":{"user_conversations":{"mapping":{"chat_service_sid":"chat_service_sid","user_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Users/{user_sid}/Conversations"}},"parent":"/Services/{Sid}","pathType":"instance"}},"/v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations":{"description":"A Service User Conversation resource represents a conversation of the user belonging to a specific conversation service.","get":{"description":"Retrieve a list of all User Conversations for the User.","operationId":"ListServiceUserConversation","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"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.","in":"path","name":"UserSid","required":true,"schema":{"type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"conversations":{"items":{"$ref":"#/components/schemas/conversations.v1.service.service_user.service_user_conversation"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListServiceUserConversationResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1UserConversation"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["conversation_sid","user_sid","chat_service_sid","friendly_name","date_created"],"mountName":"user_conversations","parent":"/Services/{ChatServiceSid}/Users/{Sid}","pathType":"list"}},"/v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}":{"delete":{"description":"Delete a specific User Conversation.","operationId":"DeleteServiceUserConversation","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"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.","in":"path","name":"UserSid","required":true,"schema":{"type":"string"}},{"description":"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).","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1UserConversation"],"x-maturity":["GA"]},"description":"A Service User Conversation resource represents a conversation of the user belonging to a specific conversation service.","get":{"description":"Fetch a specific User Conversation.","operationId":"FetchServiceUserConversation","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"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.","in":"path","name":"UserSid","required":true,"schema":{"type":"string"}},{"description":"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).","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_user.service_user_conversation"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1UserConversation"],"x-maturity":["GA"]},"post":{"description":"Update a specific User Conversation.","operationId":"UpdateServiceUserConversation","parameters":[{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.","in":"path","name":"ChatServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}},{"description":"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.","in":"path","name":"UserSid","required":true,"schema":{"type":"string"}},{"description":"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).","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"LastReadMessageIndex":{"description":"The index of the last Message in the Conversation that the Participant has read.","nullable":true,"type":"integer"},"LastReadTimestamp":{"description":"The date of the last message read in conversation by the user, given in ISO 8601 format.","format":"date-time","type":"string"},"NotificationLevel":{"$ref":"#/components/schemas/service_user_conversation_enum_notification_level","description":"The Notification Level of this User Conversation. One of `default` or `muted`.","type":"string"}},"title":"UpdateServiceUserConversationRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service.service_user.service_user_conversation"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1UserConversation"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["conversation_sid","user_sid","chat_service_sid","friendly_name","date_created"],"mountName":"user_conversations","parent":"/Services/{ChatServiceSid}/Users/{Sid}","pathType":"instance"}},"/v1/Services/{Sid}":{"delete":{"description":"Remove a conversation service with all its nested resources from your account","operationId":"DeleteService","parameters":[{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Service"],"x-maturity":["GA"]},"description":"A Service resource is a top-level conversation resource container that serves as a data silo.","get":{"description":"Fetch a conversation service from your account","operationId":"FetchService","parameters":[{"description":"A 34 character string that uniquely identifies this resource.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.service"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1Service"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","friendly_name"],"dependentProperties":{"bindings":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Bindings"},"configuration":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Configuration"},"conversations":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Conversations"},"participant_conversations":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/ParticipantConversations"},"roles":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Roles"},"users":{"mapping":{"chat_service_sid":"sid"},"resource_url":"/v1/Services/{chat_service_sid}/Users"}},"pathType":"instance"}},"/v1/Users":{"description":"A User resource represents a conversation user belonging to a default conversation service.","get":{"description":"Retrieve a list of all conversation users in your account's default service","operationId":"ListUser","parameters":[{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"},"users":{"items":{"$ref":"#/components/schemas/conversations.v1.user"},"type":"array"}},"title":"ListUserResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1User"],"x-maturity":["GA"]},"post":{"description":"Add a new conversation user to your account's default service","operationId":"CreateUser","parameters":[{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/user_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.","type":"string"},"FriendlyName":{"description":"The string that you assigned to describe the resource.","type":"string"},"Identity":{"description":"The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.","type":"string"},"RoleSid":{"description":"The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user.","maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}},"required":["Identity"],"title":"CreateUserRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.user"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1User"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","identity"],"dependentProperties":{"user_conversations":{"mapping":{"user_sid":"sid"},"resource_url":"/v1/Users/{user_sid}/Conversations"}},"pathType":"list"}},"/v1/Users/{Sid}":{"delete":{"description":"Remove a conversation user from your account's default service","operationId":"DeleteUser","parameters":[{"description":"The SID of the User resource to delete. This value can be either the `sid` or the `identity` of the User resource to delete.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/user_enum_webhook_enabled_type","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1User"],"x-maturity":["GA"]},"description":"A User resource represents a conversation user belonging to a default conversation service.","get":{"description":"Fetch a conversation user from your account's default service","operationId":"FetchUser","parameters":[{"description":"The SID of the User resource to fetch. This value can be either the `sid` or the `identity` of the User resource to fetch.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.user"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1User"],"x-maturity":["GA"]},"post":{"description":"Update an existing conversation user in your account's default service","operationId":"UpdateUser","parameters":[{"description":"The SID of the User resource to update. This value can be either the `sid` or the `identity` of the User resource to update.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}},{"description":"The X-Twilio-Webhook-Enabled HTTP request header","in":"header","name":"X-Twilio-Webhook-Enabled","schema":{"$ref":"#/components/schemas/user_enum_webhook_enabled_type","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"Attributes":{"description":"The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.","type":"string"},"FriendlyName":{"description":"The string that you assigned to describe the resource.","type":"string"},"RoleSid":{"description":"The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user.","maxLength":34,"minLength":34,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"}},"title":"UpdateUserRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.user"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1User"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","identity"],"dependentProperties":{"user_conversations":{"mapping":{"user_sid":"sid"},"resource_url":"/v1/Users/{user_sid}/Conversations"}},"pathType":"instance"}},"/v1/Users/{UserSid}/Conversations":{"description":"A User Conversation resource represents a conversation of the user belonging to a default conversation service.","get":{"description":"Retrieve a list of all User Conversations for the User.","operationId":"ListUserConversation","parameters":[{"description":"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.","in":"path","name":"UserSid","required":true,"schema":{"type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"conversations":{"items":{"$ref":"#/components/schemas/conversations.v1.user.user_conversation"},"type":"array"},"meta":{"properties":{"first_page_url":{"format":"uri","type":"string"},"key":{"type":"string"},"next_page_url":{"format":"uri","nullable":true,"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"previous_page_url":{"format":"uri","nullable":true,"type":"string"},"url":{"format":"uri","type":"string"}},"type":"object"}},"title":"ListUserConversationResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1UserConversation"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["conversation_sid","user_sid","chat_service_sid","friendly_name","date_created"],"mountName":"user_conversations","parent":"/Users/{Sid}","pathType":"list"}},"/v1/Users/{UserSid}/Conversations/{ConversationSid}":{"delete":{"description":"Delete a specific User Conversation.","operationId":"DeleteUserConversation","parameters":[{"description":"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.","in":"path","name":"UserSid","required":true,"schema":{"type":"string"}},{"description":"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).","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1UserConversation"],"x-maturity":["GA"]},"description":"A User Conversation resource represents a conversation of the user belonging to a default conversation service.","get":{"description":"Fetch a specific User Conversation.","operationId":"FetchUserConversation","parameters":[{"description":"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.","in":"path","name":"UserSid","required":true,"schema":{"type":"string"}},{"description":"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).","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.user.user_conversation"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1UserConversation"],"x-maturity":["GA"]},"post":{"description":"Update a specific User Conversation.","operationId":"UpdateUserConversation","parameters":[{"description":"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.","in":"path","name":"UserSid","required":true,"schema":{"type":"string"}},{"description":"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).","in":"path","name":"ConversationSid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"LastReadMessageIndex":{"description":"The index of the last Message in the Conversation that the Participant has read.","nullable":true,"type":"integer"},"LastReadTimestamp":{"description":"The date of the last message read in conversation by the user, given in ISO 8601 format.","format":"date-time","type":"string"},"NotificationLevel":{"$ref":"#/components/schemas/user_conversation_enum_notification_level","description":"The Notification Level of this User Conversation. One of `default` or `muted`.","type":"string"}},"title":"UpdateUserConversationRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/conversations.v1.user.user_conversation"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["ConversationsV1UserConversation"],"x-maturity":["GA"]},"servers":[{"url":"https://conversations.twilio.com"}],"x-twilio":{"defaultOutputProperties":["conversation_sid","user_sid","chat_service_sid","friendly_name","date_created"],"mountName":"user_conversations","parent":"/Users/{Sid}","pathType":"instance"}}},"components":{"schemas":{"configuration_address_enum_auto_creation_type":{"enum":["webhook","studio","default"],"type":"string"},"configuration_address_enum_method":{"enum":["GET","POST"],"type":"string"},"configuration_address_enum_type":{"enum":["sms","whatsapp","messenger","gbm","email"],"type":"string"},"configuration_webhook_enum_method":{"enum":["GET","POST"],"type":"string"},"configuration_webhook_enum_target":{"enum":["webhook","flex"],"type":"string"},"conversation_enum_state":{"enum":["inactive","active","closed"],"type":"string"},"conversation_enum_webhook_enabled_type":{"enum":["true","false"],"type":"string"},"conversation_message_enum_order_type":{"enum":["asc","desc"],"type":"string"},"conversation_message_enum_webhook_enabled_type":{"enum":["true","false"],"type":"string"},"conversation_message_receipt_enum_delivery_status":{"enum":["read","failed","delivered","undelivered","sent"],"type":"string"},"conversation_participant_enum_webhook_enabled_type":{"enum":["true","false"],"type":"string"},"conversation_scoped_webhook_enum_method":{"enum":["GET","POST"],"type":"string"},"conversation_scoped_webhook_enum_target":{"enum":["webhook","trigger","studio"],"type":"string"},"conversations.v1.configuration":{"properties":{"account_sid":{"description":"The SID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this configuration.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"default_chat_service_sid":{"description":"The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) used when creating a conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"default_closed_timer":{"description":"Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes.","nullable":true,"type":"string"},"default_inactive_timer":{"description":"Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute.","nullable":true,"type":"string"},"default_messaging_service_sid":{"description":"The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) used when creating a conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"},"links":{"description":"Contains absolute API resource URLs to access the webhook and default service configurations.","format":"uri-map","nullable":true,"type":"object"},"url":{"description":"An absolute API resource URL for this global configuration.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.configuration.configuration_webhook":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"filters":{"description":"The list of webhook event triggers that are enabled for this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`","items":{"type":"string"},"nullable":true,"type":"array"},"method":{"$ref":"#/components/schemas/configuration_webhook_enum_method","description":"The HTTP method to be used when sending a webhook request.","nullable":true,"type":"string"},"post_webhook_url":{"description":"The absolute url the post-event webhook request should be sent to.","nullable":true,"type":"string"},"pre_webhook_url":{"description":"The absolute url the pre-event webhook request should be sent to.","nullable":true,"type":"string"},"target":{"$ref":"#/components/schemas/configuration_webhook_enum_target","description":"The routing target of the webhook. Can be ordinary or route internally to Flex","nullable":true,"type":"string"},"url":{"description":"An absolute API resource API resource URL for this webhook.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.configuration_address":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) the address belongs to","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"address":{"description":"The unique address to be configured. The address can be a whatsapp address or phone number","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"address_country":{"description":"An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.","nullable":true,"type":"string"},"auto_creation":{"description":"Auto Creation configuration for the address.","nullable":true},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated.","format":"date-time","nullable":true,"type":"string"},"friendly_name":{"description":"The human-readable name of this configuration, limited to 256 characters. Optional.","nullable":true,"type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IG[0-9a-fA-F]{32}$","type":"string"},"type":{"description":"Type of Address, value can be `whatsapp` or `sms`.","nullable":true,"type":"string"},"url":{"description":"An absolute API resource URL for this address configuration.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.conversation":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"bindings":{"nullable":true},"chat_service_sid":{"description":"The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated.","format":"date-time","nullable":true,"type":"string"},"friendly_name":{"description":"The human-readable name of this conversation, limited to 256 characters. Optional.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"links":{"description":"Contains absolute URLs to access the [participants](https://www.twilio.com/docs/conversations/api/conversation-participant-resource), [messages](https://www.twilio.com/docs/conversations/api/conversation-message-resource) and [webhooks](https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource) of this conversation.","format":"uri-map","nullable":true,"type":"object"},"messaging_service_sid":{"description":"The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"state":{"$ref":"#/components/schemas/conversation_enum_state","description":"Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active`","nullable":true,"type":"string"},"timers":{"description":"Timer date values representing state update for this conversation.","nullable":true},"unique_name":{"description":"An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"url":{"description":"An absolute API resource URL for this conversation.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.conversation.conversation_message":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this message.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"attributes":{"description":"A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"author":{"description":"The channel specific identifier of the message's author. Defaults to `system`.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"body":{"description":"The content of the message, can be up to 1,600 characters long.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"content_sid":{"description":"The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^HX[0-9a-fA-F]{32}$","type":"string"},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated. `null` if the message has not been edited.","format":"date-time","nullable":true,"type":"string"},"delivery":{"description":"An object that contains the summary of delivery statuses for the message to non-chat participants.","nullable":true},"index":{"description":"The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource).  Indices may skip numbers, but will always be in order of when the message was received.","nullable":true,"type":"integer"},"links":{"description":"Contains an absolute API resource URL to access the delivery & read receipts of this message.","format":"uri-map","nullable":true,"type":"object"},"media":{"description":"An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.","items":{},"nullable":true,"type":"array","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"participant_sid":{"description":"The unique ID of messages's author participant. Null in case of `system` sent message.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MB[0-9a-fA-F]{32}$","type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"},"url":{"description":"An absolute API resource API URL for this message.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.conversation.conversation_message.conversation_message_receipt":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"channel_message_sid":{"description":"A messaging channel-specific identifier for the message delivered to participant e.g. `SMxx` for SMS, `WAxx` for Whatsapp etc. ","maxLength":34,"minLength":34,"nullable":true,"pattern":"^[a-zA-Z]{2}[0-9a-fA-F]{32}$","type":"string"},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated. `null` if the delivery receipt has not been updated.","format":"date-time","nullable":true,"type":"string"},"error_code":{"description":"The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, ","nullable":true,"type":"integer"},"message_sid":{"description":"The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"},"participant_sid":{"description":"The unique ID of the participant the delivery receipt belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MB[0-9a-fA-F]{32}$","type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^DY[0-9a-fA-F]{32}$","type":"string"},"status":{"$ref":"#/components/schemas/conversation_message_receipt_enum_delivery_status","description":"The message delivery status, can be `read`, `failed`, `delivered`, `undelivered`, `sent` or null.","nullable":true,"type":"string"},"url":{"description":"An absolute API resource URL for this delivery receipt.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.conversation.conversation_participant":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated.","format":"date-time","nullable":true,"type":"string"},"identity":{"description":"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.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"last_read_message_index":{"description":"Index of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.","nullable":true,"type":"integer"},"last_read_timestamp":{"description":"Timestamp of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.","nullable":true,"type":"string"},"messaging_binding":{"description":"Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.","nullable":true,"x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"role_sid":{"description":"The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MB[0-9a-fA-F]{32}$","type":"string"},"url":{"description":"An absolute API resource URL for this participant.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.conversation.conversation_scoped_webhook":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"configuration":{"description":"The configuration of this webhook. Is defined based on target.","nullable":true},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated.","format":"date-time","nullable":true,"type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^WH[0-9a-fA-F]{32}$","type":"string"},"target":{"description":"The target of this webhook: `webhook`, `studio`, `trigger`","nullable":true,"type":"string"},"url":{"description":"An absolute API resource URL for this webhook.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.credential":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this credential.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated.","format":"date-time","nullable":true,"type":"string"},"friendly_name":{"description":"The human-readable name of this credential, limited to 64 characters. Optional.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"sandbox":{"description":"[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.","nullable":true,"type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CR[0-9a-fA-F]{32}$","type":"string"},"type":{"$ref":"#/components/schemas/credential_enum_push_type","description":"The type of push-notification service the credential is for. Can be: `fcm`, `gcm`, or `apn`.","nullable":true,"type":"string"},"url":{"description":"An absolute API resource URL for this credential.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.participant_conversation":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"chat_service_sid":{"description":"The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"conversation_attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"conversation_created_by":{"description":"Identity of the creator of this Conversation.","nullable":true,"type":"string"},"conversation_date_created":{"description":"The date that this conversation was created, given in ISO 8601 format.","format":"date-time","nullable":true,"type":"string"},"conversation_date_updated":{"description":"The date that this conversation was last updated, given in ISO 8601 format.","format":"date-time","nullable":true,"type":"string"},"conversation_friendly_name":{"description":"The human-readable name of this conversation, limited to 256 characters. Optional.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) this Participant belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"conversation_state":{"$ref":"#/components/schemas/participant_conversation_enum_state","description":"The current state of this User Conversation. One of `inactive`, `active` or `closed`.","nullable":true,"type":"string"},"conversation_timers":{"description":"Timer date values representing state update for this conversation.","nullable":true},"conversation_unique_name":{"description":"An application-defined string that uniquely identifies the Conversation resource.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"links":{"description":"Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) of this conversation.","format":"uri-map","nullable":true,"type":"object"},"participant_identity":{"description":"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.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"participant_messaging_binding":{"description":"Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.","nullable":true,"x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"participant_sid":{"description":"The unique ID of the [Participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource).","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MB[0-9a-fA-F]{32}$","type":"string"},"participant_user_sid":{"description":"The unique string that identifies the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource).","maxLength":34,"minLength":34,"nullable":true,"pattern":"^US[0-9a-fA-F]{32}$","type":"string"}},"type":"object"},"conversations.v1.role":{"properties":{"account_sid":{"description":"The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Role resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"chat_service_sid":{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Role resource is associated with.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","nullable":true,"type":"string"},"friendly_name":{"description":"The string that you assigned to describe the resource.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"permissions":{"description":"An array of the permissions the role has been granted.","items":{"type":"string"},"nullable":true,"type":"array"},"sid":{"description":"The unique string that we created to identify the Role resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"type":{"$ref":"#/components/schemas/role_enum_role_type","description":"The type of role. Can be: `conversation` for [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) roles or `service` for [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) roles.","nullable":true,"type":"string"},"url":{"description":"An absolute API resource URL for this user role.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this service.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated.","format":"date-time","nullable":true,"type":"string"},"friendly_name":{"description":"The human-readable name of this service, limited to 256 characters. Optional.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"links":{"description":"Contains absolute API resource URLs to access conversations, users, roles, bindings and configuration of this service.","format":"uri-map","nullable":true,"type":"object"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"url":{"description":"An absolute API resource URL for this service.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_binding":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this binding.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"binding_type":{"$ref":"#/components/schemas/service_binding_enum_binding_type","description":"The push technology to use for the Binding. Can be: `apn`, `gcm`, or `fcm`.  See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.","nullable":true,"type":"string"},"chat_service_sid":{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"credential_sid":{"description":"The SID of the [Credential](https://www.twilio.com/docs/conversations/api/credential-resource) for the binding. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CR[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated.","format":"date-time","nullable":true,"type":"string"},"endpoint":{"description":"The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"identity":{"description":"The application-defined string that uniquely identifies the [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource) within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). See [access tokens](https://www.twilio.com/docs/conversations/create-tokens) for more info.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"message_types":{"description":"The [Conversation message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to.","items":{"type":"string"},"nullable":true,"type":"array"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^BS[0-9a-fA-F]{32}$","type":"string"},"url":{"description":"An absolute API resource URL for this binding.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_configuration":{"properties":{"chat_service_sid":{"description":"The unique string that we created to identify the Service configuration resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"default_chat_service_role_sid":{"description":"The service-level role assigned to users when they are added to the service. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"default_conversation_creator_role_sid":{"description":"The conversation-level role assigned to a conversation creator when they join a new conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"default_conversation_role_sid":{"description":"The conversation-level role assigned to users when they are added to a conversation. See [Conversation Role](https://www.twilio.com/docs/conversations/api/role-resource) for more info about roles.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"links":{"description":"Contains an absolute API resource URL to access the push notifications configuration of this service.","format":"uri-map","nullable":true,"type":"object"},"reachability_enabled":{"description":"Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`.","nullable":true,"type":"boolean"},"url":{"description":"An absolute API resource URL for this service configuration.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_configuration.service_notification":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this configuration.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"added_to_conversation":{"description":"The Push Notification configuration for being added to a Conversation.","nullable":true},"chat_service_sid":{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"log_enabled":{"description":"Weather the notification logging is enabled.","nullable":true,"type":"boolean"},"new_message":{"description":"The Push Notification configuration for New Messages.","nullable":true},"removed_from_conversation":{"description":"The Push Notification configuration for being removed from a Conversation.","nullable":true},"url":{"description":"An absolute API resource URL for this configuration.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_configuration.service_webhook_configuration":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this service.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"chat_service_sid":{"description":"The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"filters":{"description":"The list of events that your configured webhook targets will receive. Events not configured here will not fire. Possible values are `onParticipantAdd`, `onParticipantAdded`, `onDeliveryUpdated`, `onConversationUpdated`, `onConversationRemove`, `onParticipantRemove`, `onConversationUpdate`, `onMessageAdd`, `onMessageRemoved`, `onParticipantUpdated`, `onConversationAdded`, `onMessageAdded`, `onConversationAdd`, `onConversationRemoved`, `onParticipantUpdate`, `onMessageRemove`, `onMessageUpdated`, `onParticipantRemoved`, `onMessageUpdate` or `onConversationStateUpdated`.","items":{"type":"string"},"nullable":true,"type":"array"},"method":{"$ref":"#/components/schemas/service_webhook_configuration_enum_method","description":"The HTTP method to be used when sending a webhook request. One of `GET` or `POST`.","nullable":true,"type":"string"},"post_webhook_url":{"description":"The absolute url the post-event webhook request should be sent to.","format":"uri","nullable":true,"type":"string"},"pre_webhook_url":{"description":"The absolute url the pre-event webhook request should be sent to.","format":"uri","nullable":true,"type":"string"},"url":{"description":"An absolute API resource URL for this webhook.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_conversation":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"bindings":{"nullable":true},"chat_service_sid":{"description":"The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated.","format":"date-time","nullable":true,"type":"string"},"friendly_name":{"description":"The human-readable name of this conversation, limited to 256 characters. Optional.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"links":{"description":"Contains absolute URLs to access the [participants](https://www.twilio.com/docs/conversations/api/conversation-participant-resource), [messages](https://www.twilio.com/docs/conversations/api/conversation-message-resource) and [webhooks](https://www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource) of this conversation.","format":"uri-map","nullable":true,"type":"object"},"messaging_service_sid":{"description":"The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"state":{"$ref":"#/components/schemas/service_conversation_enum_state","description":"Current state of this conversation. Can be either `active`, `inactive` or `closed` and defaults to `active`","nullable":true,"type":"string"},"timers":{"description":"Timer date values representing state update for this conversation.","nullable":true},"unique_name":{"description":"An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"url":{"description":"An absolute API resource URL for this conversation.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_conversation.service_conversation_message":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this message.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"attributes":{"description":"A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"author":{"description":"The channel specific identifier of the message's author. Defaults to `system`.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"body":{"description":"The content of the message, can be up to 1,600 characters long.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"chat_service_sid":{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"content_sid":{"description":"The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^HX[0-9a-fA-F]{32}$","type":"string"},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated. `null` if the message has not been edited.","format":"date-time","nullable":true,"type":"string"},"delivery":{"description":"An object that contains the summary of delivery statuses for the message to non-chat participants.","nullable":true},"index":{"description":"The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource).","nullable":true,"type":"integer"},"links":{"description":"Contains an absolute API resource URL to access the delivery & read receipts of this message.","format":"uri-map","nullable":true,"type":"object"},"media":{"description":"An array of objects that describe the Message's media, if the message contains media. Each object contains these fields: `content_type` with the MIME type of the media, `filename` with the name of the media, `sid` with the SID of the Media resource, and `size` with the media object's file size in bytes. If the Message has no media, this value is `null`.","items":{},"nullable":true,"type":"array","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"participant_sid":{"description":"The unique ID of messages's author participant. Null in case of `system` sent message.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MB[0-9a-fA-F]{32}$","type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"},"url":{"description":"An absolute API resource URL for this message.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"channel_message_sid":{"description":"A messaging channel-specific identifier for the message delivered to participant e.g. `SMxx` for SMS, `WAxx` for Whatsapp etc. ","maxLength":34,"minLength":34,"nullable":true,"pattern":"^[a-zA-Z]{2}[0-9a-fA-F]{32}$","type":"string"},"chat_service_sid":{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated. `null` if the delivery receipt has not been updated.","format":"date-time","nullable":true,"type":"string"},"error_code":{"description":"The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, ","nullable":true,"type":"integer"},"message_sid":{"description":"The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IM[0-9a-fA-F]{32}$","type":"string"},"participant_sid":{"description":"The unique ID of the participant the delivery receipt belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MB[0-9a-fA-F]{32}$","type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^DY[0-9a-fA-F]{32}$","type":"string"},"status":{"$ref":"#/components/schemas/service_conversation_message_receipt_enum_delivery_status","description":"The message delivery status, can be `read`, `failed`, `delivered`, `undelivered`, `sent` or null.","nullable":true,"type":"string"},"url":{"description":"An absolute API resource URL for this delivery receipt.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_conversation.service_conversation_participant":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set `{}` will be returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"chat_service_sid":{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date on which this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date on which this resource was last updated.","format":"date-time","nullable":true,"type":"string"},"identity":{"description":"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 [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"last_read_message_index":{"description":"Index of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.","nullable":true,"type":"integer"},"last_read_timestamp":{"description":"Timestamp of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.","nullable":true,"type":"string"},"messaging_binding":{"description":"Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.","nullable":true,"x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"role_sid":{"description":"The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MB[0-9a-fA-F]{32}$","type":"string"},"url":{"description":"An absolute API resource URL for this participant.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_conversation.service_conversation_scoped_webhook":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"chat_service_sid":{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"configuration":{"description":"The configuration of this webhook. Is defined based on target.","nullable":true},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date that this resource was created.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this resource was last updated.","format":"date-time","nullable":true,"type":"string"},"sid":{"description":"A 34 character string that uniquely identifies this resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^WH[0-9a-fA-F]{32}$","type":"string"},"target":{"description":"The target of this webhook: `webhook`, `studio`, `trigger`","nullable":true,"type":"string"},"url":{"description":"An absolute API resource URL for this webhook.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_participant_conversation":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"chat_service_sid":{"description":"The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"conversation_attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"conversation_created_by":{"description":"Identity of the creator of this Conversation.","nullable":true,"type":"string"},"conversation_date_created":{"description":"The date that this conversation was created, given in ISO 8601 format.","format":"date-time","nullable":true,"type":"string"},"conversation_date_updated":{"description":"The date that this conversation was last updated, given in ISO 8601 format.","format":"date-time","nullable":true,"type":"string"},"conversation_friendly_name":{"description":"The human-readable name of this conversation, limited to 256 characters. Optional.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) this Participant belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"conversation_state":{"$ref":"#/components/schemas/service_participant_conversation_enum_state","description":"The current state of this User Conversation. One of `inactive`, `active` or `closed`.","nullable":true,"type":"string"},"conversation_timers":{"description":"Timer date values representing state update for this conversation.","nullable":true},"conversation_unique_name":{"description":"An application-defined string that uniquely identifies the Conversation resource.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"links":{"description":"Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) of this conversation.","format":"uri-map","nullable":true,"type":"object"},"participant_identity":{"description":"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.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"participant_messaging_binding":{"description":"Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.","nullable":true,"x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"participant_sid":{"description":"The unique ID of the [Participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource).","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MB[0-9a-fA-F]{32}$","type":"string"},"participant_user_sid":{"description":"The unique string that identifies the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource).","maxLength":34,"minLength":34,"nullable":true,"pattern":"^US[0-9a-fA-F]{32}$","type":"string"}},"type":"object"},"conversations.v1.service.service_role":{"properties":{"account_sid":{"description":"The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Role resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"chat_service_sid":{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Role resource is associated with.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","nullable":true,"type":"string"},"friendly_name":{"description":"The string that you assigned to describe the resource.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"permissions":{"description":"An array of the permissions the role has been granted.","items":{"type":"string"},"nullable":true,"type":"array"},"sid":{"description":"The unique string that we created to identify the Role resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"type":{"$ref":"#/components/schemas/service_role_enum_role_type","description":"The type of role. Can be: `conversation` for [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) roles or `service` for [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) roles.","nullable":true,"type":"string"},"url":{"description":"An absolute API resource URL for this user role.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_user":{"properties":{"account_sid":{"description":"The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"attributes":{"description":"The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"chat_service_sid":{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","nullable":true,"type":"string"},"friendly_name":{"description":"The string that you assigned to describe the resource.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"identity":{"description":"The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"is_notifiable":{"description":"Whether the User has a potentially valid Push Notification registration (APN or GCM) for this Conversations Service. If at least one registration exists, `true`; otherwise `false`. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, and if the User has never had a notification registration, even if the Service's `reachability_enabled` is `true`.","nullable":true,"type":"boolean"},"is_online":{"description":"Whether the User is actively connected to this Conversations Service and online. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, if the User has never been online for this Conversations Service, even if the Service's `reachability_enabled` is `true`.","nullable":true,"type":"boolean"},"links":{"format":"uri-map","nullable":true,"type":"object"},"role_sid":{"description":"The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) assigned to the user.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"sid":{"description":"The unique string that we created to identify the User resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^US[0-9a-fA-F]{32}$","type":"string"},"url":{"description":"An absolute API resource URL for this user.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.service.service_user.service_user_conversation":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"chat_service_sid":{"description":"The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this User Conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"conversation_state":{"$ref":"#/components/schemas/service_user_conversation_enum_state","description":"The current state of this User Conversation. One of `inactive`, `active` or `closed`.","nullable":true,"type":"string"},"created_by":{"description":"Identity of the creator of this Conversation.","nullable":true,"type":"string"},"date_created":{"description":"The date that this conversation was created, given in ISO 8601 format.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this conversation was last updated, given in ISO 8601 format.","format":"date-time","nullable":true,"type":"string"},"friendly_name":{"description":"The human-readable name of this conversation, limited to 256 characters. Optional.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"last_read_message_index":{"description":"The index of the last Message in the Conversation that the Participant has read.","nullable":true,"type":"integer"},"links":{"description":"Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) of this conversation.","format":"uri-map","nullable":true,"type":"object"},"notification_level":{"$ref":"#/components/schemas/service_user_conversation_enum_notification_level","description":"The Notification Level of this User Conversation. One of `default` or `muted`.","nullable":true,"type":"string"},"participant_sid":{"description":"The unique ID of the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) the user conversation belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MB[0-9a-fA-F]{32}$","type":"string"},"timers":{"description":"Timer date values representing state update for this conversation.","nullable":true},"unique_name":{"description":"An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"unread_messages_count":{"description":"The number of unread Messages in the Conversation for the Participant.","nullable":true,"type":"integer"},"url":{"format":"uri","nullable":true,"type":"string"},"user_sid":{"description":"The unique string that identifies the [User resource](https://www.twilio.com/docs/conversations/api/user-resource).","maxLength":34,"minLength":34,"nullable":true,"pattern":"^US[0-9a-fA-F]{32}$","type":"string"}},"type":"object"},"conversations.v1.user":{"properties":{"account_sid":{"description":"The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"attributes":{"description":"The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"chat_service_sid":{"description":"The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"date_created":{"description":"The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.","format":"date-time","nullable":true,"type":"string"},"friendly_name":{"description":"The string that you assigned to describe the resource.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"identity":{"description":"The application-defined string that uniquely identifies the resource's User within the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource). This value is often a username or an email address, and is case-sensitive.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"is_notifiable":{"description":"Whether the User has a potentially valid Push Notification registration (APN or GCM) for this Conversations Service. If at least one registration exists, `true`; otherwise `false`. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, and if the User has never had a notification registration, even if the Service's `reachability_enabled` is `true`.","nullable":true,"type":"boolean"},"is_online":{"description":"Whether the User is actively connected to this Conversations Service and online. This value is only returned by Fetch actions that return a single resource and `null` is always returned by a Read action. This value is `null` if the Service's `reachability_enabled` is `false`, if the User has never been online for this Conversations Service, even if the Service's `reachability_enabled` is `true`.","nullable":true,"type":"boolean"},"links":{"format":"uri-map","nullable":true,"type":"object"},"role_sid":{"description":"The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) assigned to the user.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^RL[0-9a-fA-F]{32}$","type":"string"},"sid":{"description":"The unique string that we created to identify the User resource.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^US[0-9a-fA-F]{32}$","type":"string"},"url":{"description":"An absolute API resource URL for this user.","format":"uri","nullable":true,"type":"string"}},"type":"object"},"conversations.v1.user.user_conversation":{"properties":{"account_sid":{"description":"The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^AC[0-9a-fA-F]{32}$","type":"string"},"attributes":{"description":"An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set \"{}\" will be returned.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"sensitive"}}},"chat_service_sid":{"description":"The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^IS[0-9a-fA-F]{32}$","type":"string"},"conversation_sid":{"description":"The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this User Conversation.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^CH[0-9a-fA-F]{32}$","type":"string"},"conversation_state":{"$ref":"#/components/schemas/user_conversation_enum_state","description":"The current state of this User Conversation. One of `inactive`, `active` or `closed`.","nullable":true,"type":"string"},"created_by":{"description":"Identity of the creator of this Conversation.","nullable":true,"type":"string"},"date_created":{"description":"The date that this conversation was created, given in ISO 8601 format.","format":"date-time","nullable":true,"type":"string"},"date_updated":{"description":"The date that this conversation was last updated, given in ISO 8601 format.","format":"date-time","nullable":true,"type":"string"},"friendly_name":{"description":"The human-readable name of this conversation, limited to 256 characters. Optional.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"last_read_message_index":{"description":"The index of the last Message in the Conversation that the Participant has read.","nullable":true,"type":"integer"},"links":{"description":"Contains absolute URLs to access the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) of this conversation.","format":"uri-map","nullable":true,"type":"object"},"notification_level":{"$ref":"#/components/schemas/user_conversation_enum_notification_level","description":"The Notification Level of this User Conversation. One of `default` or `muted`.","nullable":true,"type":"string"},"participant_sid":{"description":"The unique ID of the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) the user conversation belongs to.","maxLength":34,"minLength":34,"nullable":true,"pattern":"^MB[0-9a-fA-F]{32}$","type":"string"},"timers":{"description":"Timer date values representing state update for this conversation.","nullable":true},"unique_name":{"description":"An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource's `conversation_sid` in the URL.","nullable":true,"type":"string","x-twilio":{"pii":{"deleteSla":30,"handling":"standard"}}},"unread_messages_count":{"description":"The number of unread Messages in the Conversation for the Participant.","nullable":true,"type":"integer"},"url":{"format":"uri","nullable":true,"type":"string"},"user_sid":{"description":"The unique string that identifies the [User resource](https://www.twilio.com/docs/conversations/api/user-resource).","maxLength":34,"minLength":34,"nullable":true,"pattern":"^US[0-9a-fA-F]{32}$","type":"string"}},"type":"object"},"credential_enum_push_type":{"enum":["apn","gcm","fcm"],"type":"string"},"participant_conversation_enum_state":{"enum":["inactive","active","closed"],"type":"string"},"role_enum_role_type":{"enum":["conversation","service"],"type":"string"},"service_binding_enum_binding_type":{"enum":["apn","gcm","fcm"],"type":"string"},"service_conversation_enum_state":{"enum":["inactive","active","closed"],"type":"string"},"service_conversation_enum_webhook_enabled_type":{"enum":["true","false"],"type":"string"},"service_conversation_message_enum_order_type":{"enum":["asc","desc"],"type":"string"},"service_conversation_message_enum_webhook_enabled_type":{"enum":["true","false"],"type":"string"},"service_conversation_message_receipt_enum_delivery_status":{"enum":["read","failed","delivered","undelivered","sent"],"type":"string"},"service_conversation_participant_enum_webhook_enabled_type":{"enum":["true","false"],"type":"string"},"service_conversation_scoped_webhook_enum_method":{"enum":["GET","POST"],"type":"string"},"service_conversation_scoped_webhook_enum_target":{"enum":["webhook","trigger","studio"],"type":"string"},"service_participant_conversation_enum_state":{"enum":["inactive","active","closed"],"type":"string"},"service_role_enum_role_type":{"enum":["conversation","service"],"type":"string"},"service_user_conversation_enum_notification_level":{"enum":["default","muted"],"type":"string"},"service_user_conversation_enum_state":{"enum":["inactive","active","closed"],"type":"string"},"service_user_enum_webhook_enabled_type":{"enum":["true","false"],"type":"string"},"service_webhook_configuration_enum_method":{"enum":["GET","POST"],"type":"string"},"user_conversation_enum_notification_level":{"enum":["default","muted"],"type":"string"},"user_conversation_enum_state":{"enum":["inactive","active","closed"],"type":"string"},"user_enum_webhook_enabled_type":{"enum":["true","false"],"type":"string"}},"securitySchemes":{"accountSid_authToken":{"scheme":"basic","type":"http"}}},"x-maturity":[{"description":"This product is Generally Available.","name":"GA"}]}