components: securitySchemes: accountSid_authToken: scheme: basic type: http schemas: conversations.v1.configuration: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this configuration. default_chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) used when creating a conversation. default_messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) used when creating a conversation. default_inactive_timer: type: string nullable: true description: Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute. default_closed_timer: type: string nullable: true description: Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. url: type: string format: uri nullable: true description: An absolute API resource URL for this global configuration. links: type: object format: uri-map nullable: true description: Contains absolute API resource URLs to access the webhook and default service configurations. conversations.v1.configuration_address: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^IG[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) the address belongs to type: type: string nullable: true description: Type of Address, value can be `whatsapp` or `sms`. address: type: string nullable: true description: The unique address to be configured. The address can be a whatsapp address or phone number x-twilio: pii: handling: standard deleteSla: 30 friendly_name: type: string nullable: true description: The human-readable name of this configuration, limited to 256 characters. Optional. auto_creation: nullable: true description: Auto Creation configuration for the address. date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. url: type: string format: uri nullable: true description: An absolute API resource URL for this address configuration. address_country: type: string nullable: true description: An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses. configuration_address_enum_type: type: string enum: - sms - whatsapp - messenger - gbm - email - rcs - apple - chat description: Type of Address, value can be `whatsapp` or `sms`. configuration_address_enum_auto_creation_type: type: string enum: - webhook - studio - default configuration_address_enum_method: type: string enum: - get - post conversations.v1.configuration.configuration_webhook: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. method: $ref: '#/components/schemas/configuration_webhook_enum_method' filters: type: array items: type: string nullable: true description: 'The list of webhook event triggers that are enabled for this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onMessageAdd`, `onMessageUpdate`, `onMessageRemove`, `onConversationUpdated`, `onConversationRemoved`, `onConversationAdd`, `onConversationAdded`, `onConversationRemove`, `onConversationUpdate`, `onConversationStateUpdated`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onParticipantAdd`, `onParticipantRemove`, `onParticipantUpdate`, `onDeliveryUpdated`, `onUserAdded`, `onUserUpdate`, `onUserUpdated`' pre_webhook_url: type: string nullable: true description: The absolute url the pre-event webhook request should be sent to. post_webhook_url: type: string nullable: true description: The absolute url the post-event webhook request should be sent to. target: $ref: '#/components/schemas/configuration_webhook_enum_target' url: type: string format: uri nullable: true description: An absolute API resource API resource URL for this webhook. configuration_webhook_enum_target: type: string enum: - webhook - flex description: The routing target of the webhook. Can be ordinary or route internally to Flex configuration_webhook_enum_method: type: string enum: - GET - POST description: The HTTP method to be used when sending a webhook request. conversations.v1.conversation: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 unique_name: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 state: $ref: '#/components/schemas/conversation_enum_state' date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. timers: nullable: true description: Timer date values representing state update for this conversation. url: type: string format: uri nullable: true description: An absolute API resource URL for this conversation. links: type: object format: uri-map nullable: true 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. bindings: nullable: true conversation_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' conversation_enum_state: type: string enum: - inactive - active - closed description: Current state of this conversation. Can be either `initializing`, `active`, `inactive` or `closed` and defaults to `active` conversations.v1.conversation.conversation_message: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this message. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. sid: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. index: type: integer default: 0 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. author: type: string nullable: true description: The channel specific identifier of the message's author. Defaults to `system`. x-twilio: pii: handling: standard deleteSla: 30 body: type: string nullable: true description: The content of the message, can be up to 1,600 characters long. x-twilio: pii: handling: sensitive deleteSla: 30 media: type: array items: {} nullable: true 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`.' x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of messages's author participant. Null in case of `system` sent message. date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. `null` if the message has not been edited. url: type: string format: uri nullable: true description: An absolute API resource API URL for this message. delivery: nullable: true description: An object that contains the summary of delivery statuses for the message to non-chat participants. links: type: object format: uri-map nullable: true description: Contains an absolute API resource URL to access the delivery & read receipts of this message. content_sid: type: string minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template. conversation_message_enum_order_type: type: string enum: - asc - desc conversation_message_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' conversations.v1.conversation.conversation_message.conversation_message_receipt: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. sid: type: string minLength: 34 maxLength: 34 pattern: ^DY[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. message_sid: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ nullable: true description: The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to channel_message_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: 'A messaging channel-specific identifier for the message delivered to participant e.g. `SMxx` for SMS, `WAxx` for Whatsapp etc. ' participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the participant the delivery receipt belongs to. status: $ref: '#/components/schemas/conversation_message_receipt_enum_delivery_status' error_code: type: integer default: 0 description: 'The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, ' date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. `null` if the delivery receipt has not been updated. url: type: string format: uri nullable: true description: An absolute API resource URL for this delivery receipt. conversation_message_receipt_enum_delivery_status: type: string enum: - read - failed - delivered - undelivered - sent description: The message delivery status, can be `read`, `failed`, `delivered`, `undelivered`, `sent` or null. conversations.v1.conversation.conversation_participant: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. identity: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. x-twilio: pii: handling: standard deleteSla: 30 role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. url: type: string format: uri nullable: true description: An absolute API resource URL for this participant. last_read_message_index: type: integer nullable: true description: "Index of last \u201Cread\u201D message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." last_read_timestamp: type: string nullable: true description: "Timestamp of last \u201Cread\u201D message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." conversation_participant_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' conversations.v1.conversation.conversation_scoped_webhook: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. target: type: string nullable: true description: 'The target of this webhook: `webhook`, `studio`, `trigger`' url: type: string format: uri nullable: true description: An absolute API resource URL for this webhook. configuration: nullable: true description: The configuration of this webhook. Is defined based on target. date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. conversation_scoped_webhook_enum_target: type: string enum: - webhook - trigger - studio description: 'The target of this webhook: `webhook`, `studio`, `trigger`' conversation_scoped_webhook_enum_method: type: string enum: - get - post conversation_webhook_enum_target: type: string enum: - webhook - flex description: The routing target of the webhook. Can be ordinary or route internally to Flex conversation_webhook_enum_method: type: string enum: - GET - POST description: The HTTP method to be used when sending a webhook request. conversations.v1.conversation_with_participants: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 unique_name: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 state: $ref: '#/components/schemas/conversation_with_participants_enum_state' date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. timers: nullable: true description: Timer date values representing state update for this conversation. links: type: object format: uri-map nullable: true 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. bindings: nullable: true url: type: string format: uri nullable: true description: An absolute API resource URL for this conversation. conversation_with_participants_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' conversation_with_participants_enum_state: type: string enum: - inactive - active - closed description: Current state of this conversation. Can be either `initializing`, `active`, `inactive` or `closed` and defaults to `active` conversations.v1.credential: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this credential. friendly_name: type: string nullable: true description: The human-readable name of this credential, limited to 64 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 type: $ref: '#/components/schemas/credential_enum_push_type' sandbox: type: string nullable: true 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.' date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. url: type: string format: uri nullable: true description: An absolute API resource URL for this credential. credential_enum_push_type: type: string enum: - apn - gcm - fcm description: 'The type of push-notification service the credential is for. Can be: `fcm`, `gcm`, or `apn`.' conversations.v1.participant_conversation: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource). participant_user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). participant_identity: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 participant_messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. x-twilio: pii: handling: standard deleteSla: 30 conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) this Participant belongs to. conversation_unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the Conversation resource. x-twilio: pii: handling: standard deleteSla: 30 conversation_friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 conversation_attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 conversation_date_created: type: string format: date-time nullable: true description: The date that this conversation was created, given in ISO 8601 format. conversation_date_updated: type: string format: date-time nullable: true description: The date that this conversation was last updated, given in ISO 8601 format. conversation_created_by: type: string nullable: true description: Identity of the creator of this Conversation. conversation_state: $ref: '#/components/schemas/participant_conversation_enum_state' conversation_timers: nullable: true description: Timer date values representing state update for this conversation. links: type: object format: uri-map nullable: true 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. participant_conversation_enum_state: type: string enum: - inactive - active - closed description: The current state of this User Conversation. One of `inactive`, `active` or `closed`. conversations.v1.role: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Role resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Role resource. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Role resource is associated with. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. x-twilio: pii: handling: standard deleteSla: 30 type: $ref: '#/components/schemas/role_enum_role_type' permissions: type: array items: type: string nullable: true description: An array of the permissions the role has been granted. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true 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. url: type: string format: uri nullable: true description: An absolute API resource URL for this user role. role_enum_role_type: type: string enum: - conversation - service 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.' conversations.v1.service: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this service. sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. friendly_name: type: string nullable: true description: The human-readable name of this service, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. url: type: string format: uri nullable: true description: An absolute API resource URL for this service. links: type: object format: uri-map nullable: true description: Contains absolute API resource URLs to access conversations, users, roles, bindings and configuration of this service. conversations.v1.service.service_binding: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this binding. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with. credential_sid: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ nullable: true 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. date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. endpoint: type: string nullable: true description: The unique endpoint identifier for the Binding. The format of this value depends on the `binding_type`. x-twilio: pii: handling: standard deleteSla: 30 identity: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 binding_type: $ref: '#/components/schemas/service_binding_enum_binding_type' message_types: type: array items: type: string nullable: true description: The [Conversation message types](https://www.twilio.com/docs/chat/push-notification-configuration#push-types) the binding is subscribed to. url: type: string format: uri nullable: true description: An absolute API resource URL for this binding. service_binding_enum_binding_type: type: string enum: - apn - gcm - fcm 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.' conversations.v1.service.service_configuration: type: object properties: chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Service configuration resource. default_conversation_creator_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true 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. default_conversation_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true 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. default_chat_service_role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true 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. url: type: string format: uri nullable: true description: An absolute API resource URL for this service configuration. links: type: object format: uri-map nullable: true description: Contains an absolute API resource URL to access the push notifications configuration of this service. reachability_enabled: type: boolean nullable: true description: Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`. conversations.v1.service.service_conversation: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 unique_name: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 state: $ref: '#/components/schemas/service_conversation_enum_state' date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. timers: nullable: true description: Timer date values representing state update for this conversation. url: type: string format: uri nullable: true description: An absolute API resource URL for this conversation. links: type: object format: uri-map nullable: true 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. bindings: nullable: true service_conversation_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' service_conversation_enum_state: type: string enum: - inactive - active - closed description: Current state of this conversation. Can be either `initializing`, `active`, `inactive` or `closed` and defaults to `active` conversations.v1.service.service_conversation.service_conversation_message: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this message. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. sid: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. index: type: integer default: 0 description: The index of the message within the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource). author: type: string nullable: true description: The channel specific identifier of the message's author. Defaults to `system`. x-twilio: pii: handling: standard deleteSla: 30 body: type: string nullable: true description: The content of the message, can be up to 1,600 characters long. x-twilio: pii: handling: sensitive deleteSla: 30 media: type: array items: {} nullable: true 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`.' x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of messages's author participant. Null in case of `system` sent message. date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. `null` if the message has not been edited. delivery: nullable: true description: An object that contains the summary of delivery statuses for the message to non-chat participants. url: type: string format: uri nullable: true description: An absolute API resource URL for this message. links: type: object format: uri-map nullable: true description: Contains an absolute API resource URL to access the delivery & read receipts of this message. content_sid: type: string minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the multi-channel [Rich Content](https://www.twilio.com/docs/content) template. service_conversation_message_enum_order_type: type: string enum: - asc - desc service_conversation_message_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. message_sid: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ nullable: true description: The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to sid: type: string minLength: 34 maxLength: 34 pattern: ^DY[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. channel_message_sid: type: string minLength: 34 maxLength: 34 pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$ nullable: true description: 'A messaging channel-specific identifier for the message delivered to participant e.g. `SMxx` for SMS, `WAxx` for Whatsapp etc. ' participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the participant the delivery receipt belongs to. status: $ref: '#/components/schemas/service_conversation_message_receipt_enum_delivery_status' error_code: type: integer default: 0 description: 'The message [delivery error code](https://www.twilio.com/docs/sms/api/message-resource#delivery-related-errors) for a `failed` status, ' date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. `null` if the delivery receipt has not been updated. url: type: string format: uri nullable: true description: An absolute API resource URL for this delivery receipt. service_conversation_message_receipt_enum_delivery_status: type: string enum: - read - failed - delivered - undelivered - sent description: The message delivery status, can be `read`, `failed`, `delivered`, `undelivered`, `sent` or null. conversations.v1.service.service_conversation.service_conversation_participant: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this participant. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. identity: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. x-twilio: pii: handling: standard deleteSla: 30 role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. date_created: type: string format: date-time nullable: true description: The date on which this resource was created. date_updated: type: string format: date-time nullable: true description: The date on which this resource was last updated. url: type: string format: uri nullable: true description: An absolute API resource URL for this participant. last_read_message_index: type: integer nullable: true description: "Index of last \u201Cread\u201D message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." last_read_timestamp: type: string nullable: true description: "Timestamp of last \u201Cread\u201D message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." service_conversation_participant_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' conversations.v1.service.service_conversation.service_conversation_scoped_webhook: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. target: type: string nullable: true description: 'The target of this webhook: `webhook`, `studio`, `trigger`' url: type: string format: uri nullable: true description: An absolute API resource URL for this webhook. configuration: nullable: true description: The configuration of this webhook. Is defined based on target. date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. service_conversation_scoped_webhook_enum_target: type: string enum: - webhook - trigger - studio description: 'The target of this webhook: `webhook`, `studio`, `trigger`' service_conversation_scoped_webhook_enum_method: type: string enum: - get - post conversations.v1.service.service_conversation_with_participants: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: A 34 character string that uniquely identifies this resource. friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 unique_name: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 state: $ref: '#/components/schemas/service_conversation_with_participants_enum_state' date_created: type: string format: date-time nullable: true description: The date that this resource was created. date_updated: type: string format: date-time nullable: true description: The date that this resource was last updated. timers: nullable: true description: Timer date values representing state update for this conversation. links: type: object format: uri-map nullable: true 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. bindings: nullable: true url: type: string format: uri nullable: true description: An absolute API resource URL for this conversation. service_conversation_with_participants_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' service_conversation_with_participants_enum_state: type: string enum: - inactive - active - closed description: Current state of this conversation. Can be either `initializing`, `active`, `inactive` or `closed` and defaults to `active` conversations.v1.service.service_configuration.service_notification: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this configuration. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to. new_message: nullable: true description: The Push Notification configuration for New Messages. added_to_conversation: nullable: true description: The Push Notification configuration for being added to a Conversation. removed_from_conversation: nullable: true description: The Push Notification configuration for being removed from a Conversation. log_enabled: type: boolean nullable: true description: Weather the notification logging is enabled. url: type: string format: uri nullable: true description: An absolute API resource URL for this configuration. conversations.v1.service.service_participant_conversation: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource). participant_user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). participant_identity: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 participant_messaging_binding: nullable: true description: Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. x-twilio: pii: handling: standard deleteSla: 30 conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) this Participant belongs to. conversation_unique_name: type: string nullable: true description: An application-defined string that uniquely identifies the Conversation resource. x-twilio: pii: handling: standard deleteSla: 30 conversation_friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 conversation_attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 conversation_date_created: type: string format: date-time nullable: true description: The date that this conversation was created, given in ISO 8601 format. conversation_date_updated: type: string format: date-time nullable: true description: The date that this conversation was last updated, given in ISO 8601 format. conversation_created_by: type: string nullable: true description: Identity of the creator of this Conversation. conversation_state: $ref: '#/components/schemas/service_participant_conversation_enum_state' conversation_timers: nullable: true description: Timer date values representing state update for this conversation. links: type: object format: uri-map nullable: true 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. service_participant_conversation_enum_state: type: string enum: - inactive - active - closed description: The current state of this User Conversation. One of `inactive`, `active` or `closed`. conversations.v1.service.service_role: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Role resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Role resource. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Role resource is associated with. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. x-twilio: pii: handling: standard deleteSla: 30 type: $ref: '#/components/schemas/service_role_enum_role_type' permissions: type: array items: type: string nullable: true description: An array of the permissions the role has been granted. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true 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. url: type: string format: uri nullable: true description: An absolute API resource URL for this user role. service_role_enum_role_type: type: string enum: - conversation - service 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.' service_stats_conversations_ratelimitingerrors_enum_source: type: string enum: - SDK - API description: Source via which the request came from. Can be sdk, api. conversations.v1.service.service_user: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the User resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User resource. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) assigned to the user. identity: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. x-twilio: pii: handling: sensitive deleteSla: 30 is_online: type: boolean nullable: true 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`. is_notifiable: type: boolean nullable: true 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`. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true 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. url: type: string format: uri nullable: true description: An absolute API resource URL for this user. links: type: object format: uri-map nullable: true service_user_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' conversations.v1.service.service_user.service_user_conversation: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this User Conversation. unread_messages_count: type: integer nullable: true description: The number of unread Messages in the Conversation for the Participant. last_read_message_index: type: integer nullable: true description: The index of the last Message in the Conversation that the Participant has read. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) the user conversation belongs to. user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 conversation_state: $ref: '#/components/schemas/service_user_conversation_enum_state' timers: nullable: true description: Timer date values representing state update for this conversation. attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date that this conversation was created, given in ISO 8601 format. date_updated: type: string format: date-time nullable: true description: The date that this conversation was last updated, given in ISO 8601 format. created_by: type: string nullable: true description: Identity of the creator of this Conversation. notification_level: $ref: '#/components/schemas/service_user_conversation_enum_notification_level' unique_name: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 url: type: string format: uri nullable: true links: type: object format: uri-map nullable: true 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. service_user_conversation_enum_notification_level: type: string enum: - default - muted description: The Notification Level of this User Conversation. One of `default` or `muted`. service_user_conversation_enum_state: type: string enum: - inactive - active - closed description: The current state of this User Conversation. One of `inactive`, `active` or `closed`. conversations.v1.service.service_configuration.service_webhook_configuration: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this service. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. pre_webhook_url: type: string format: uri nullable: true description: The absolute url the pre-event webhook request should be sent to. post_webhook_url: type: string format: uri nullable: true description: The absolute url the post-event webhook request should be sent to. filters: type: array items: type: string nullable: true 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`. method: $ref: '#/components/schemas/service_webhook_configuration_enum_method' url: type: string format: uri nullable: true description: An absolute API resource URL for this webhook. service_webhook_configuration_enum_method: type: string enum: - GET - POST description: The HTTP method to be used when sending a webhook request. One of `GET` or `POST`. stats_twilsock_ratelimitingerrors_enum_source: type: string enum: - TWILSOCK description: Source via which the request came from. Can be Twilsock. conversations.v1.user: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the User resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the User resource. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with. role_sid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ nullable: true description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) assigned to the user. identity: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. x-twilio: pii: handling: standard deleteSla: 30 attributes: type: string nullable: true description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. x-twilio: pii: handling: sensitive deleteSla: 30 is_online: type: boolean nullable: true 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`. is_notifiable: type: boolean nullable: true 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`. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true 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. url: type: string format: uri nullable: true description: An absolute API resource URL for this user. links: type: object format: uri-map nullable: true user_enum_webhook_enabled_type: type: string enum: - 'true' - 'false' conversations.v1.user.user_conversation: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this conversation. chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. conversation_sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this User Conversation. unread_messages_count: type: integer nullable: true description: The number of unread Messages in the Conversation for the Participant. last_read_message_index: type: integer nullable: true description: The index of the last Message in the Conversation that the Participant has read. participant_sid: type: string minLength: 34 maxLength: 34 pattern: ^MB[0-9a-fA-F]{32}$ nullable: true description: The unique ID of the [participant](https://www.twilio.com/docs/conversations/api/conversation-participant-resource) the user conversation belongs to. user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the [User resource](https://www.twilio.com/docs/conversations/api/user-resource). friendly_name: type: string nullable: true description: The human-readable name of this conversation, limited to 256 characters. Optional. x-twilio: pii: handling: standard deleteSla: 30 conversation_state: $ref: '#/components/schemas/user_conversation_enum_state' timers: nullable: true description: Timer date values representing state update for this conversation. attributes: type: string nullable: true 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. x-twilio: pii: handling: sensitive deleteSla: 30 date_created: type: string format: date-time nullable: true description: The date that this conversation was created, given in ISO 8601 format. date_updated: type: string format: date-time nullable: true description: The date that this conversation was last updated, given in ISO 8601 format. created_by: type: string nullable: true description: Identity of the creator of this Conversation. notification_level: $ref: '#/components/schemas/user_conversation_enum_notification_level' unique_name: type: string nullable: true 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. x-twilio: pii: handling: standard deleteSla: 30 url: type: string format: uri nullable: true links: type: object format: uri-map nullable: true 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. user_conversation_enum_notification_level: type: string enum: - default - muted description: The Notification Level of this User Conversation. One of `default` or `muted`. user_conversation_enum_state: type: string enum: - inactive - active - closed description: The current state of this User Conversation. One of `inactive`, `active` or `closed`. info: title: Twilio - Conversations description: This is the public Twilio REST API. termsOfService: https://www.twilio.com/legal/tos contact: name: Twilio Support url: https://support.twilio.com email: support@twilio.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 openapi: 3.0.1 paths: /v1/Configuration: servers: - url: https://conversations.twilio.com description: The Configuration resource manages a set of account-level settings applicable to the Conversations API. x-twilio: defaultOutputProperties: - account_sid - default_chat_service_sid - default_messaging_service_sid pathType: instance get: description: Fetch the global configuration of conversations on your account summary: Fetch the global configuration of conversations on your account tags: - ConversationsV1Configuration responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_inactive_timer: PT1M default_closed_timer: PT10M url: https://conversations.twilio.com/v1/Configuration links: service: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration webhooks: https://conversations.twilio.com/v1/Configuration/Webhooks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchConfiguration post: description: Update the global configuration of conversations on your account summary: Update the global configuration of conversations on your account tags: - ConversationsV1Configuration responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_inactive_timer: PT1M default_closed_timer: PT10M url: https://conversations.twilio.com/v1/Configuration links: service: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration webhooks: https://conversations.twilio.com/v1/Configuration/Webhooks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateConfiguration requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateConfigurationRequest properties: DefaultChatServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ description: The SID of the default [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation. DefaultMessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The SID of the default [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation. DefaultInactiveTimer: type: string description: Default ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute. DefaultClosedTimer: type: string description: Default ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. examples: update: value: DefaultChatServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DefaultMessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DefaultInactiveTimer: PT1M DefaultClosedTimer: PT10M /v1/Configuration/Addresses: servers: - url: https://conversations.twilio.com description: Address Configuration resource manages the configurations related to a unique address within Conversations x-twilio: defaultOutputProperties: - sid - type - address - friendly_name mountName: address_configurations pathType: list get: description: Retrieve a list of address configurations for an account summary: Retrieve a list of address configurations for an account tags: - ConversationsV1AddressConfiguration parameters: - name: Type in: query description: 'Filter the address configurations by its type. This value can be one of: `whatsapp`, `sms`.' schema: type: string examples: readByAddressType: value: sms - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 50. schema: type: integer format: int64 minimum: 1 maximum: 50 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: address_configurations: type: array items: $ref: '#/components/schemas/conversations.v1.configuration_address' 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 examples: readAll: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 next_page_url: null key: address_configurations address_configurations: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address: '+37256123457' type: sms friendly_name: My Test Configuration address_country: CA auto_creation: enabled: true type: webhook conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa webhook_url: https://example.com webhook_method: POST webhook_filters: - onParticipantAdded - onMessageAdded date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab address: '+37256123458' type: sms friendly_name: Studio Test Configuration address_country: US auto_creation: enabled: false type: studio conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa studio_flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa studio_retry_count: 3 date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac address: '+37256123459' type: sms friendly_name: Default Test Configuration address_country: NG auto_creation: enabled: true type: default date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac readBlank: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 url: https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0 previous_page_url: null next_page_url: null key: address_configurations address_configurations: [] readByAddressType: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0 next_page_url: null key: address_configurations address_configurations: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address: '+37256123457' type: sms friendly_name: My Test Configuration address_country: CA auto_creation: enabled: true type: webhook conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa webhook_url: https://example.com webhook_method: POST webhook_filters: - onParticipantAdded - onMessageAdded date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab address: '+37256123458' type: sms friendly_name: Studio Test Configuration address_country: US auto_creation: enabled: false type: studio conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa studio_flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa studio_retry_count: 3 date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac address: '+37256123459' type: sms friendly_name: Default Test Configuration address_country: NG auto_creation: enabled: true type: default date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListConfigurationAddress post: description: Create a new address configuration summary: Create a new address configuration tags: - ConversationsV1AddressConfiguration responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration_address' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address: '+37256123457' type: sms friendly_name: My Test Configuration address_country: CA auto_creation: enabled: true type: webhook conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa webhook_url: https://example.com webhook_method: POST webhook_filters: - onParticipantAdded - onMessageAdded date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createAmb: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address: urn:mbid:AQAAYyUbut6E4B3T9FLv5EbG type: apple friendly_name: My AMB Test Configuration address_country: CA auto_creation: enabled: true type: webhook conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa webhook_url: https://example.com webhook_method: POST webhook_filters: - onParticipantAdded - onMessageAdded date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createEmail: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address: example@example.com type: email friendly_name: My Email Configuration auto_creation: enabled: true type: default address_country: null date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateConfigurationAddress requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateConfigurationAddressRequest properties: Type: $ref: '#/components/schemas/configuration_address_enum_type' Address: type: string description: The unique address to be configured. The address can be a whatsapp address or phone number FriendlyName: type: string description: The human-readable name of this configuration, limited to 256 characters. Optional. AutoCreation.Enabled: type: boolean description: Enable/Disable auto-creating conversations for messages to this address AutoCreation.Type: $ref: '#/components/schemas/configuration_address_enum_auto_creation_type' AutoCreation.ConversationServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ description: Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service. AutoCreation.WebhookUrl: type: string description: For type `webhook`, the url for the webhook request. AutoCreation.WebhookMethod: $ref: '#/components/schemas/configuration_address_enum_method' AutoCreation.WebhookFilters: type: array items: type: string 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`' AutoCreation.StudioFlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: For type `studio`, the studio flow SID where the webhook should be sent to. AutoCreation.StudioRetryCount: type: integer description: For type `studio`, number of times to retry the webhook request AddressCountry: type: string description: An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses. required: - Type - Address examples: create: value: Address: '+37256123457' Type: sms FriendlyName: My Test Configuration AutoCreation.Enabled: true AutoCreation.Type: webhook AutoCreation.ConversationServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa AutoCreation.WebhookUrl: https://example.com AutoCreation.WebhookMethod: post AutoCreation.WebhookFilters: - onParticipantAdded - onMessageAdded AddressCountry: CA createAmb: value: Address: urn:mbid:AQAAYyUbut6E4B3T9FLv5EbG Type: apple FriendlyName: My AMB Test Configuration AutoCreation.Enabled: true AutoCreation.Type: webhook AutoCreation.ConversationServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa AutoCreation.WebhookUrl: https://example.com AutoCreation.WebhookMethod: post AutoCreation.WebhookFilters: - onParticipantAdded - onMessageAdded AddressCountry: CA createEmail: value: Address: example@example.com Type: email FriendlyName: My Email Configuration AutoCreation.Enabled: true AutoCreation.Type: default /v1/Configuration/Addresses/{Sid}: servers: - url: https://conversations.twilio.com description: Address Configuration resource manages the configurations related to a unique address within Conversations x-twilio: defaultOutputProperties: - sid - type - address - friendly_name mountName: address_configurations pathType: instance get: description: 'Fetch an address configuration ' summary: 'Fetch an address configuration ' tags: - ConversationsV1AddressConfiguration parameters: - name: Sid in: path description: The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration_address' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address: '+37256123457' type: sms friendly_name: My Test Configuration address_country: CA auto_creation: enabled: true type: webhook conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa webhook_url: https://example.com webhook_method: POST webhook_filters: - onParticipantAdded - onMessageAdded date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchConfigurationAddress post: description: Update an existing address configuration summary: Update an existing address configuration tags: - ConversationsV1AddressConfiguration parameters: - name: Sid in: path description: The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration_address' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa address: '+37256123457' type: sms friendly_name: My Test Configuration Updated address_country: CA auto_creation: enabled: false type: studio conversation_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa studio_flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa studio_retry_count: 3 date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:51Z' url: https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateConfigurationAddress requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateConfigurationAddressRequest properties: FriendlyName: type: string description: The human-readable name of this configuration, limited to 256 characters. Optional. AutoCreation.Enabled: type: boolean description: Enable/Disable auto-creating conversations for messages to this address AutoCreation.Type: $ref: '#/components/schemas/configuration_address_enum_auto_creation_type' AutoCreation.ConversationServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ description: Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service. AutoCreation.WebhookUrl: type: string description: For type `webhook`, the url for the webhook request. AutoCreation.WebhookMethod: $ref: '#/components/schemas/configuration_address_enum_method' AutoCreation.WebhookFilters: type: array items: type: string 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`' AutoCreation.StudioFlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: For type `studio`, the studio flow SID where the webhook should be sent to. AutoCreation.StudioRetryCount: type: integer description: For type `studio`, number of times to retry the webhook request examples: update: value: FriendlyName: My Test Configuration Updated AutoCreation.Enabled: false AutoCreation.Type: studio AutoCreation.StudioFlowSid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa AutoCreation.StudioRetryCount: 3 delete: description: Remove an existing address configuration summary: Remove an existing address configuration tags: - ConversationsV1AddressConfiguration parameters: - name: Sid in: path description: The SID of the Address Configuration resource. This value can be either the `sid` or the `address` of the configuration schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteConfigurationAddress /v1/Configuration/Webhooks: servers: - url: https://conversations.twilio.com description: A Webhook resource manages a service-level set of callback URLs and their configuration for receiving all conversation events. x-twilio: defaultOutputProperties: - target - method - pre_webhook_url - post_webhook_url parent: /Configuration pathType: instance get: description: '' summary: '' tags: - ConversationsV1Webhook responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration.configuration_webhook' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa pre_webhook_url: https://example.com/pre post_webhook_url: https://example.com/post method: GET filters: - onMessageSend - onConversationUpdated target: webhook url: https://conversations.twilio.com/v1/Configuration/Webhooks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchConfigurationWebhook post: description: '' summary: '' tags: - ConversationsV1Webhook responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.configuration.configuration_webhook' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa pre_webhook_url: https://example.com/pre post_webhook_url: http://example.com/post method: GET filters: - onConversationUpdated target: webhook url: https://conversations.twilio.com/v1/Configuration/Webhooks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateConfigurationWebhook requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateConfigurationWebhookRequest properties: Method: type: string description: The HTTP method to be used when sending a webhook request. Filters: type: array items: type: string description: 'The list of webhook event triggers that are enabled for this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onMessageAdd`, `onMessageUpdate`, `onMessageRemove`, `onConversationUpdated`, `onConversationRemoved`, `onConversationAdd`, `onConversationAdded`, `onConversationRemove`, `onConversationUpdate`, `onConversationStateUpdated`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`, `onParticipantAdd`, `onParticipantRemove`, `onParticipantUpdate`, `onDeliveryUpdated`, `onUserAdded`, `onUserUpdate`, `onUserUpdated`' PreWebhookUrl: type: string description: The absolute url the pre-event webhook request should be sent to. PostWebhookUrl: type: string description: The absolute url the post-event webhook request should be sent to. Target: $ref: '#/components/schemas/configuration_webhook_enum_target' examples: update: value: PreWebhookUrl: https://example.com/pre PostWebhookUrl: https://example.com/post Method: GET Filters: - onConversationUpdated Target: webhook /v1/Conversations: servers: - url: https://conversations.twilio.com description: A Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster. x-twilio: defaultOutputProperties: - sid - chat_service_sid - friendly_name - date_created dependentProperties: participants: mapping: conversation_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Participants messages: mapping: conversation_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Messages webhooks: mapping: conversation_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Webhooks export: mapping: conversation_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Export pathType: list post: description: Create a new conversation in your account's default service summary: Create a new conversation in your account's default service tags: - ConversationsV1Conversation parameters: - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/conversation_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation' examples: create: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: unique_name attributes: '{ "topic": "feedback" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' bindings: {} url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks export: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export createNoTimersNoAttributes: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: null attributes: '{}' date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' state: active timers: {} bindings: {} url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks export: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export createEmailConversation: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: null attributes: '{}' date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' state: active timers: {} bindings: email: projected_address: example+123@example.com name: example url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks export: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateConversation requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateConversationRequest properties: FriendlyName: type: string description: The human-readable name of this conversation, limited to 256 characters. Optional. UniqueName: type: string 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. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. Attributes: type: string 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. State: $ref: '#/components/schemas/conversation_enum_state' Timers.Inactive: type: string description: ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute. Timers.Closed: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. Bindings.Email.Address: type: string description: The default email address that will be used when sending outbound emails in this conversation. Bindings.Email.Name: type: string description: The default name that will be used when sending outbound emails in this conversation. examples: create: value: FriendlyName: friendly_name UniqueName: unique_name Attributes: '{ "topic": "feedback" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa State: inactive Timers.Inactive: PT1M Timers.Closed: PT10M createNoTimersNoAttributes: value: FriendlyName: friendly_name DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa State: active createEmailConversation: value: FriendlyName: friendly_name DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' Bindings.Email.Address: example@example.com Bindings.Email.Name: Example get: description: Retrieve a list of conversations in your account's default service summary: Retrieve a list of conversations in your account's default service tags: - ConversationsV1Conversation parameters: - name: StartDate in: query description: Specifies the beginning of the date range for filtering Conversations based on their creation date. Conversations that were created on or after this date will be included in the results. The date must be in ISO8601 format, specifically starting at the beginning of the specified date (YYYY-MM-DDT00:00:00Z), for precise filtering. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order. schema: type: string - name: EndDate in: query description: Defines the end of the date range for filtering conversations by their creation date. Only conversations that were created on or before this date will appear in the results. The date must be in ISO8601 format, specifically capturing up to the end of the specified date (YYYY-MM-DDT23:59:59Z), to ensure that conversations from the entire end day are included. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order. schema: type: string - name: State in: query description: State for sorting and filtering list of Conversations. Can be `active`, `inactive` or `closed` schema: $ref: '#/components/schemas/conversation_enum_state' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 100. schema: type: integer format: int64 minimum: 1 maximum: 100 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: conversations: type: array items: $ref: '#/components/schemas/conversations.v1.conversation' 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 examples: readFull: value: conversations: - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Home Repair Visit unique_name: null attributes: '{ "topic": "feedback" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' state: active timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' bindings: {} url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks export: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Conversations?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Conversations?PageSize=50&Page=0 next_page_url: null key: conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListConversation /v1/Conversations/{Sid}: servers: - url: https://conversations.twilio.com description: A Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster. x-twilio: defaultOutputProperties: - sid - chat_service_sid - friendly_name - date_created dependentProperties: participants: mapping: conversation_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Participants messages: mapping: conversation_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Messages webhooks: mapping: conversation_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Webhooks export: mapping: conversation_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Export pathType: instance post: description: Update an existing conversation in your account's default service summary: Update an existing conversation in your account's default service tags: - ConversationsV1Conversation parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/conversation_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation' examples: update: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab friendly_name: friendly_name unique_name: unique_name attributes: '{ "topic": "feedback" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' bindings: {} url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks export: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateConversation requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateConversationRequest properties: FriendlyName: type: string description: The human-readable name of this conversation, limited to 256 characters. Optional. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. Attributes: type: string 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. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. State: $ref: '#/components/schemas/conversation_enum_state' Timers.Inactive: type: string description: ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute. Timers.Closed: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. UniqueName: type: string 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. Bindings.Email.Address: type: string description: The default email address that will be used when sending outbound emails in this conversation. Bindings.Email.Name: type: string description: The default name that will be used when sending outbound emails in this conversation. examples: update: value: FriendlyName: friendly_name UniqueName: unique_name Attributes: '{ "topic": "feedback" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab State: inactive Timers.Inactive: PT1M Timers.Closed: PT10M delete: description: Remove a conversation from your account's default service summary: Remove a conversation from your account's default service tags: - ConversationsV1Conversation parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/conversation_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteConversation get: description: Fetch a conversation from your account's default service summary: Fetch a conversation from your account's default service tags: - ConversationsV1Conversation parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation' examples: fetch: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: My First Conversation unique_name: first_conversation attributes: '{ "topic": "feedback" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' state: active timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' bindings: {} url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks export: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchConversation /v1/Conversations/{ConversationSid}/Messages: servers: - url: https://conversations.twilio.com description: A Message resource represents a message in a conversation. x-twilio: defaultOutputProperties: - sid - index - author - date_created dependentProperties: delivery_receipts: mapping: conversation_sid: conversation_sid message_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts channel_metadata: mapping: conversation_sid: conversation_sid message_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata parent: /Conversations/{Sid} pathType: list post: description: Add a new message to the conversation summary: Add a new message to the conversation tags: - ConversationsV1Message parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/conversation_message_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' examples: create: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Hello media: null author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata createWithMedia: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: null media: - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa size: 42056 content_type: image/jpeg filename: car.jpg author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata createNoAttributes: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Hello media: null author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{}' date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata createWithContentSid: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Hello John media: null author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{}' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata createWithSubject: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: message body media: null author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{}' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateConversationMessage requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateConversationMessageRequest properties: Author: type: string description: The channel specific identifier of the message's author. Defaults to `system`. Body: type: string description: The content of the message, can be up to 1,600 characters long. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. `null` if the message has not been edited. Attributes: type: string 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. MediaSid: type: string minLength: 34 maxLength: 34 pattern: ^ME[0-9a-fA-F]{32}$ description: The Media SID to be attached to the new Message. ContentSid: type: string minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ 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. ContentVariables: type: string description: A structurally valid JSON string that contains values to resolve Rich Content template variables. Subject: type: string description: The subject of the message, can be up to 256 characters long. examples: create: value: Body: Hello Author: message author Attributes: '{ "importance": "high" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createWithMedia: value: MediaSid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Author: message author Attributes: '{ "importance": "high" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createNoAttributes: value: Body: Hello Author: message author DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' createWithContentSid: value: Author: message author DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' ContentSid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ContentVariables: '{"name": "John"}' createWithSubject: value: Author: message author Body: message body DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' Subject: message subject get: description: Retrieve a list of all messages in the conversation summary: Retrieve a list of all messages in the conversation tags: - ConversationsV1Message parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for messages. schema: type: string required: true - name: Order in: query description: 'The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending), with `asc` as the default.' schema: $ref: '#/components/schemas/conversation_message_enum_order_type' examples: readLastMessage: value: desc - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 100. schema: type: integer format: int64 minimum: 1 maximum: 100 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: messages: type: array items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' 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 examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 next_page_url: null key: messages messages: - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: I like pie. media: null author: pie_preferrer participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Cake is my favorite! media: null author: cake_lover participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2016-03-24T20:38:21Z' date_updated: '2016-03-24T20:38:21Z' index: 5 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: null media: - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa size: 42056 content_type: image/jpeg filename: car.jpg author: cake_lover participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2016-03-24T20:38:21Z' date_updated: '2016-03-24T20:38:21Z' index: 9 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata readLastMessage: value: meta: page: 0 page_size: 1 first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0 next_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=1&PageToken=PAIMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa key: messages messages: - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: null media: - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa size: 42056 content_type: image/jpeg filename: car.jpg author: cake_lover participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2016-03-24T20:38:21Z' date_updated: '2016-03-24T20:38:21Z' index: 9 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListConversationMessage /v1/Conversations/{ConversationSid}/Messages/{Sid}: servers: - url: https://conversations.twilio.com description: A Message resource represents a message in a conversation. x-twilio: defaultOutputProperties: - sid - index - author - date_created dependentProperties: delivery_receipts: mapping: conversation_sid: conversation_sid message_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Messages/{message_sid}/Receipts channel_metadata: mapping: conversation_sid: conversation_sid message_sid: sid resource_url: /v1/Conversations/{conversation_sid}/Messages/{message_sid}/ChannelMetadata parent: /Conversations/{Sid} pathType: instance post: description: Update an existing message in the conversation summary: Update an existing message in the conversation tags: - ConversationsV1Message parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/conversation_message_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' examples: update: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Hello media: null author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateConversationMessage requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateConversationMessageRequest properties: Author: type: string description: The channel specific identifier of the message's author. Defaults to `system`. Body: type: string description: The content of the message, can be up to 1,600 characters long. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. `null` if the message has not been edited. Attributes: type: string 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. Subject: type: string description: The subject of the message, can be up to 256 characters long. examples: update: value: Body: Hello Author: message author Attributes: '{ "importance": "high" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' delete: description: Remove a message from the conversation summary: Remove a message from the conversation tags: - ConversationsV1Message parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/conversation_message_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteConversationMessage get: description: Fetch a message from the conversation summary: Fetch a message from the conversation tags: - ConversationsV1Message parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message' examples: fetch: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Welcome! media: null author: system participant_sid: null attributes: '{ "importance": "high" }' date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchConversationMessage /v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}: servers: - url: https://conversations.twilio.com description: A Message Receipt resource represents a delivery/read receipt of a message in a conversation. x-twilio: defaultOutputProperties: - sid - message_sid - status - date_created parent: /Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts pathType: instance get: description: Fetch the delivery and read receipts of the conversation message summary: Fetch the delivery and read receipts of the conversation message tags: - ConversationsV1DeliveryReceipt parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: MessageSid in: path description: The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^DY[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message.conversation_message_receipt' examples: fetch: value: sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: failed error_code: 3000 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchConversationMessageReceipt /v1/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts: servers: - url: https://conversations.twilio.com description: A Message Receipt resource represents a delivery/read receipt of a message in a conversation. x-twilio: defaultOutputProperties: - sid - message_sid - status - date_created parent: /Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts pathType: list get: description: Retrieve a list of all delivery and read receipts of the conversation message summary: Retrieve a list of all delivery and read receipts of the conversation message tags: - ConversationsV1DeliveryReceipt parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: MessageSid in: path description: The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 50. schema: type: integer format: int64 minimum: 1 maximum: 50 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: delivery_receipts: type: array items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_message.conversation_message_receipt' 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 examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 next_page_url: null key: delivery_receipts delivery_receipts: - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: failed error_code: 3000 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: failed error_code: 3000 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: failed error_code: 3000 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListConversationMessageReceipt /v1/Conversations/{ConversationSid}/Participants: servers: - url: https://conversations.twilio.com description: A Participant resource represents a member of the conversation. x-twilio: defaultOutputProperties: - sid - messaging_binding parent: /Conversations/{Sid} pathType: list post: description: Add a new participant to the conversation summary: Add a new participant to the conversation tags: - ConversationsV1Participant parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/conversation_participant_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' examples: createSms: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: null attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675310' proxy_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createChat: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: IDENTITY attributes: '{ "role": "driver" }' messaging_binding: null role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createGmms: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: IDENTITY attributes: '{ "role": "driver" }' messaging_binding: type: sms projected_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createGmmsChatNoAttributes: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: IDENTITY attributes: '{}' messaging_binding: type: sms projected_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createGmmsSmsNoAttributes: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: null attributes: '{}' messaging_binding: type: sms address: '+15017122661' role_sid: null date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createRcs: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: null attributes: '{ "role": "driver" }' messaging_binding: type: rcs address: rcs:+15558675310 proxy_address: rcs:+15017122661 role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createRcsWithFallback: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: null attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675311' proxy_address: '+12025552661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateConversationParticipant requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateConversationParticipantRequest properties: Identity: 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. MessagingBinding.Address: type: string 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). MessagingBinding.ProxyAddress: type: string 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). DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. Attributes: type: string 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. MessagingBinding.ProjectedAddress: type: string description: The address of the Twilio phone number that is used in Group MMS. Communication mask for the Conversation participant with Identity. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. examples: createSms: value: Attributes: '{ "role": "driver" }' MessagingBinding.Address: '+15558675310' MessagingBinding.ProxyAddress: '+15017122661' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createChat: value: Identity: IDENTITY Attributes: '{ "role": "driver" }' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createGmms: value: Identity: IDENTITY Attributes: '{ "role": "driver" }' MessagingBinding.ProjectedAddress: '+15017122661' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createGmmsChatNoAttributes: value: Identity: IDENTITY MessagingBinding.ProjectedAddress: '+15017122661' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' createGmmsSmsNoAttributes: value: MessagingBinding.Address: '+15017122661' DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' createRcs: value: Attributes: '{ "role": "driver" }' MessagingBinding.Address: rcs:+15558675310 MessagingBinding.ProxyAddress: rcs:+15017122661 RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createRcsWithFallback: value: Attributes: '{ "role": "driver" }' MessagingBinding.Address: rcs:+15558675311 MessagingBinding.ProxyAddress: rcs:+15017122661 MessagingBinding.ProxyAddressFallback: '+12025552661' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' get: description: Retrieve a list of all participants of the conversation summary: Retrieve a list of all participants of the conversation tags: - ConversationsV1Participant parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for participants. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 100. schema: type: integer format: int64 minimum: 1 maximum: 100 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: participants: type: array items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' 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: ListConversationParticipantResponse examples: read: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 next_page_url: null key: participants participants: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: null attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675310' proxy_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: IDENTITY attributes: '{ "role": "driver" }' messaging_binding: null role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListConversationParticipant /v1/Conversations/{ConversationSid}/Participants/{Sid}: servers: - url: https://conversations.twilio.com description: A Participant resource represents a member of the conversation. x-twilio: defaultOutputProperties: - sid - messaging_binding parent: /Conversations/{Sid} pathType: instance post: description: Update an existing participant in the conversation summary: Update an existing participant in the conversation tags: - ConversationsV1Participant parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/conversation_participant_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: null attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675310' proxy_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null updateGmms: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: id attributes: '{ "role": "driver" }' messaging_binding: type: sms projected_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateConversationParticipant requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateConversationParticipantRequest properties: DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. Attributes: type: string 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. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. MessagingBinding.ProxyAddress: type: string description: The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it. MessagingBinding.ProjectedAddress: type: string description: The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it. Identity: 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. LastReadMessageIndex: type: integer nullable: true description: "Index of last \u201Cread\u201D message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." LastReadTimestamp: type: string description: "Timestamp of last \u201Cread\u201D message in the\ \ [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." examples: update: value: Attributes: '{ "role": "driver" }' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' updateGmms: value: MessagingBinding.ProjectedAddress: '+15017122661' delete: description: Remove a participant from the conversation summary: Remove a participant from the conversation tags: - ConversationsV1Participant parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/conversation_participant_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteConversationParticipant get: description: Fetch a participant of the conversation summary: Fetch a participant of the conversation tags: - ConversationsV1Participant parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's `identity` rather than the SID. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_participant' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: null attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675310' proxy_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null fetchByIdentity: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: alice attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675310' proxy_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchConversationParticipant /v1/Conversations/{ConversationSid}/Webhooks: servers: - url: https://conversations.twilio.com description: A Scoped Webhook resource manages a set of callback URLs and their configuration for receiving events specific to one conversation. x-twilio: defaultOutputProperties: - sid - target parent: /Conversations/{Sid} pathType: list get: description: Retrieve a list of all webhooks scoped to the conversation summary: Retrieve a list of all webhooks scoped to the conversation tags: - ConversationsV1Webhook parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 5, and the maximum is 5. schema: type: integer format: int64 minimum: 1 maximum: 5 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: webhooks: type: array items: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' 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: ListConversationScopedWebhookResponse examples: readFull: value: meta: page: 0 page_size: 5 first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 next_page_url: null key: webhooks webhooks: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: webhook configuration: url: https://example.com method: get filters: - onMessageSent - onConversationDestroyed date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: trigger configuration: url: https://example.com method: post filters: - keyword1 - keyword2 date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: studio configuration: flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 5 first_page_url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 previous_page_url: null next_page_url: null key: webhooks webhooks: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListConversationScopedWebhook post: description: Create a new webhook scoped to the conversation summary: Create a new webhook scoped to the conversation tags: - ConversationsV1Webhook parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: webhook configuration: url: https://example.com method: get filters: - onMessageSent - onConversationDestroyed date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateConversationScopedWebhook requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateConversationScopedWebhookRequest properties: Target: $ref: '#/components/schemas/conversation_scoped_webhook_enum_target' Configuration.Url: type: string description: The absolute url the webhook request should be sent to. Configuration.Method: $ref: '#/components/schemas/conversation_scoped_webhook_enum_method' Configuration.Filters: type: array items: type: string description: The list of events, firing webhook event for this Conversation. Configuration.Triggers: type: array items: type: string description: The list of keywords, firing webhook event for this Conversation. Configuration.FlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: The studio flow SID, where the webhook should be sent to. Configuration.ReplayAfter: type: integer description: The message index for which and it's successors the webhook will be replayed. Not set by default required: - Target examples: create: value: Target: webhook Configuration.Url: https://example.com Configuration.Method: get Configuration.Filters: - onMessageSent - onConversationDestroyed Configuration.ReplayAfter: 7 /v1/Conversations/{ConversationSid}/Webhooks/{Sid}: servers: - url: https://conversations.twilio.com description: A Scoped Webhook resource manages a set of callback URLs and their configuration for receiving events specific to one conversation. x-twilio: defaultOutputProperties: - sid - target parent: /Conversations/{Sid} pathType: instance get: description: Fetch the configuration of a conversation-scoped webhook summary: Fetch the configuration of a conversation-scoped webhook tags: - ConversationsV1Webhook parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: studio configuration: flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchConversationScopedWebhook post: description: Update an existing conversation-scoped webhook summary: Update an existing conversation-scoped webhook tags: - ConversationsV1Webhook parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: trigger configuration: url: https://example.com method: post filters: - keyword1 - keyword2 date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:51Z' url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateConversationScopedWebhook requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateConversationScopedWebhookRequest properties: Configuration.Url: type: string description: The absolute url the webhook request should be sent to. Configuration.Method: $ref: '#/components/schemas/conversation_scoped_webhook_enum_method' Configuration.Filters: type: array items: type: string description: The list of events, firing webhook event for this Conversation. Configuration.Triggers: type: array items: type: string description: The list of keywords, firing webhook event for this Conversation. Configuration.FlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: The studio flow SID, where the webhook should be sent to. examples: update: value: Configuration.Url: https://example.com Configuration.Method: post Configuration.Triggers: - keyword1 - keyword2 delete: description: Remove an existing webhook scoped to the conversation summary: Remove an existing webhook scoped to the conversation tags: - ConversationsV1Webhook parameters: - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteConversationScopedWebhook /v1/ConversationWithParticipants: servers: - url: https://conversations.twilio.com description: A Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster. x-twilio: defaultOutputProperties: - sid - chat_service_sid - friendly_name - date_created className: conversation_with_participants pathType: list post: description: Create a new conversation with the list of participants in your account's default service summary: Create a new conversation with the list of participants in your account's default service tags: - ConversationsV1ConversationWithParticipants parameters: - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/conversation_with_participants_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation_with_participants' examples: create: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: unique_name attributes: '{ "topic": "feedback" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' bindings: {} links: participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createNoTimersNoAttributes: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: null attributes: '{}' date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' state: active timers: {} bindings: {} links: participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created '202': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.conversation_with_participants' examples: createWithParticipants: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: null attributes: '{}' date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' state: active timers: {} bindings: {} links: participants: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks url: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Accepted security: - accountSid_authToken: [] operationId: CreateConversationWithParticipants requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateConversationWithParticipantsRequest properties: FriendlyName: type: string description: The human-readable name of this conversation, limited to 256 characters. Optional. UniqueName: type: string 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. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. Attributes: type: string 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. State: $ref: '#/components/schemas/conversation_with_participants_enum_state' Timers.Inactive: type: string description: ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute. Timers.Closed: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. Bindings.Email.Address: type: string description: The default email address that will be used when sending outbound emails in this conversation. Bindings.Email.Name: type: string description: The default name that will be used when sending outbound emails in this conversation. Participant: type: array items: type: string description: The participant to be added to the conversation in JSON format. The JSON object attributes are as parameters in [Participant Resource](https://www.twilio.com/docs/conversations/api/conversation-participant-resource). The maximum number of participants that can be added in a single request is 10. examples: create: value: FriendlyName: friendly_name UniqueName: unique_name Attributes: '{ "topic": "feedback" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa State: inactive Timers.Inactive: PT1M Timers.Closed: PT10M createNoTimersNoAttributes: value: FriendlyName: friendly_name DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa State: active createWithParticipants: value: FriendlyName: friendly_name DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa State: active Participant: - '{ "identity": "user1" }' - '{ "identity": "user2" }' /v1/Credentials: servers: - url: https://conversations.twilio.com description: A Credential resource represents a push notification credential. x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: list post: description: Add a new push notification credential to your account summary: Add a new push notification credential to your account tags: - ConversationsV1Credential responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.credential' examples: create: value: sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Test slow create type: apn sandbox: 'False' date_created: '2015-10-07T17:50:01Z' date_updated: '2015-10-07T17:50:01Z' url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateCredential requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateCredentialRequest properties: Type: $ref: '#/components/schemas/credential_enum_push_type' FriendlyName: type: string description: A descriptive string that you create to describe the new resource. It can be up to 64 characters long. Certificate: type: string description: "[APN only] The URL encoded representation of the certificate.\ \ For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==\n\ -----END CERTIFICATE-----`." PrivateKey: type: string description: '[APN only] The URL encoded representation of the private key. For example, `-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----END RSA PRIVATE KEY-----`.' Sandbox: type: boolean 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.' ApiKey: type: string description: '[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.' Secret: type: string description: '[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.' required: - Type examples: create: value: Type: apn get: description: Retrieve a list of all push notification credentials on your account summary: Retrieve a list of all push notification credentials on your account tags: - ConversationsV1Credential parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 100. schema: type: integer format: int64 minimum: 1 maximum: 100 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: credentials: type: array items: $ref: '#/components/schemas/conversations.v1.credential' 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 examples: readFull: value: credentials: - sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Test slow create type: apn sandbox: 'False' date_created: '2015-10-07T17:50:01Z' date_updated: '2015-10-07T17:50:01Z' url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 next_page_url: null key: credentials readEmpty: value: credentials: [] meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0 next_page_url: null key: credentials headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListCredential /v1/Credentials/{Sid}: servers: - url: https://conversations.twilio.com description: A Credential resource represents a push notification credential. x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: instance post: description: Update an existing push notification credential on your account summary: Update an existing push notification credential on your account tags: - ConversationsV1Credential parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.credential' examples: update: value: sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Test slow create type: apn sandbox: 'False' date_created: '2015-10-07T17:50:01Z' date_updated: '2015-10-07T17:50:01Z' url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateCredential requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateCredentialRequest properties: Type: $ref: '#/components/schemas/credential_enum_push_type' FriendlyName: type: string description: A descriptive string that you create to describe the new resource. It can be up to 64 characters long. Certificate: type: string description: "[APN only] The URL encoded representation of the certificate.\ \ For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==\n\ -----END CERTIFICATE-----`." PrivateKey: type: string description: '[APN only] The URL encoded representation of the private key. For example, `-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----END RSA PRIVATE KEY-----`.' Sandbox: type: boolean 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.' ApiKey: type: string description: '[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.' Secret: type: string description: '[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.' examples: update: value: FriendlyName: Test slow create delete: description: Remove a push notification credential from your account summary: Remove a push notification credential from your account tags: - ConversationsV1Credential parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteCredential get: description: Fetch a push notification credential from your account summary: Fetch a push notification credential from your account tags: - ConversationsV1Credential parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.credential' examples: fetch: value: sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Test slow create type: apn sandbox: 'False' date_created: '2015-10-07T17:50:01Z' date_updated: '2015-10-07T17:50:01Z' url: https://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchCredential /v1/ParticipantConversations: servers: - url: https://conversations.twilio.com description: Participant Conversations resource represents a list of Conversations that this Participant belongs to belonging to a default conversation service. x-twilio: defaultOutputProperties: - chat_service_sid - participant_sid - conversation_sid pathType: list get: description: Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified. summary: Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified. tags: - ConversationsV1ParticipantConversation parameters: - name: Identity in: query 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. schema: type: string examples: readEmpty: value: identity readFullByIdentity: value: identity - name: Address in: query 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. schema: type: string examples: readFullByAddress: value: '+375255555555' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 50. schema: type: integer format: int64 minimum: 1 maximum: 50 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: conversations: type: array items: $ref: '#/components/schemas/conversations.v1.participant_conversation' 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 examples: readEmpty: value: conversations: [] meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 next_page_url: null key: conversations readFullByIdentity: value: conversations: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_friendly_name: friendly_name conversation_state: inactive conversation_timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' conversation_attributes: '{}' conversation_date_created: '2015-07-30T20:00:00Z' conversation_date_updated: '2015-07-30T20:00:00Z' conversation_created_by: created_by conversation_unique_name: unique_name participant_user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa participant_identity: identity participant_messaging_binding: null links: participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/ParticipantConversations?Identity=identity&PageSize=50&Page=0 next_page_url: null key: conversations readFullByAddress: value: conversations: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_friendly_name: friendly_name conversation_state: inactive conversation_timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' conversation_attributes: '{}' conversation_date_created: '2015-07-30T20:00:00Z' conversation_date_updated: '2015-07-30T20:00:00Z' conversation_created_by: created_by conversation_unique_name: unique_name participant_user_sid: null participant_identity: null participant_messaging_binding: address: '+375255555555' proxy_address: '+12345678910' type: sms level: null name: null projected_address: null links: participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 next_page_url: null key: conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListParticipantConversation /v1/Roles: servers: - url: https://conversations.twilio.com description: A Role resource represents a set of permissions granted to a user within a service or a conversation. x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: list post: description: Create a new user role in your account's default service summary: Create a new user role in your account's default service tags: - ConversationsV1Role responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.role' examples: create: value: sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Conversation Role type: conversation permissions: - sendMessage - leaveConversation - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateRole requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateRoleRequest properties: FriendlyName: type: string description: A descriptive string that you create to describe the new resource. It can be up to 64 characters long. Type: $ref: '#/components/schemas/role_enum_role_type' Permission: type: array items: type: string 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`. required: - FriendlyName - Type - Permission examples: create: value: FriendlyName: Conversation Role Type: conversation Permission: sendMessage get: description: Retrieve a list of all user roles in your account's default service summary: Retrieve a list of all user roles in your account's default service tags: - ConversationsV1Role parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 50. schema: type: integer format: int64 minimum: 1 maximum: 50 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: roles: type: array items: $ref: '#/components/schemas/conversations.v1.role' 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: ListRoleResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 next_page_url: null key: roles roles: - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Conversation Role type: conversation permissions: - sendMessage - leaveConversation - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Roles?PageSize=50&Page=0 next_page_url: null key: roles roles: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListRole /v1/Roles/{Sid}: servers: - url: https://conversations.twilio.com description: A Role resource represents a set of permissions granted to a user within a service or a conversation. x-twilio: defaultOutputProperties: - sid - friendly_name - type pathType: instance post: description: Update an existing user role in your account's default service summary: Update an existing user role in your account's default service tags: - ConversationsV1Role parameters: - name: Sid in: path description: The SID of the Role resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.role' examples: update: value: sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Conversation Role type: conversation permissions: - sendMessage - leaveConversation - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateRole requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateRoleRequest properties: Permission: type: array items: type: string 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`. required: - Permission examples: update: value: Permission: sendMessage delete: description: Remove a user role from your account's default service summary: Remove a user role from your account's default service tags: - ConversationsV1Role parameters: - name: Sid in: path description: The SID of the Role resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteRole get: description: Fetch a user role from your account's default service summary: Fetch a user role from your account's default service tags: - ConversationsV1Role parameters: - name: Sid in: path description: The SID of the Role resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.role' examples: fetch: value: sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Conversation Role type: conversation permissions: - sendMessage - leaveConversation - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://conversations.twilio.com/v1/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchRole /v1/Services: servers: - url: https://conversations.twilio.com description: A Service resource is a top-level conversation resource container that serves as a data silo. x-twilio: defaultOutputProperties: - sid - friendly_name dependentProperties: conversations: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations bindings: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Bindings users: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Users roles: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Roles configuration: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Configuration participant_conversations: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/ParticipantConversations conversation_with_participants: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/ConversationWithParticipants pathType: list post: description: Create a new conversation service on your account summary: Create a new conversation service on your account tags: - ConversationsV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service' examples: create: value: sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations users: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users roles: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles bindings: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings configuration: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration participant_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations conversation_with_participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConversationWithParticipants headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateService requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateServiceRequest properties: FriendlyName: type: string description: The human-readable name of this service, limited to 256 characters. Optional. required: - FriendlyName examples: create: value: FriendlyName: friendly_name get: description: Retrieve a list of all conversation services on your account summary: Retrieve a list of all conversation services on your account tags: - ConversationsV1Service parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 100. schema: type: integer format: int64 minimum: 1 maximum: 100 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: services: type: array items: $ref: '#/components/schemas/conversations.v1.service' 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: ListServiceResponse examples: readFull: value: services: - sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Home Service date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations users: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users roles: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles bindings: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings configuration: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration participant_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations conversation_with_participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConversationWithParticipants meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services?PageSize=50&Page=0 next_page_url: null key: services headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListService /v1/Services/{Sid}: servers: - url: https://conversations.twilio.com description: A Service resource is a top-level conversation resource container that serves as a data silo. x-twilio: defaultOutputProperties: - sid - friendly_name dependentProperties: conversations: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations bindings: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Bindings users: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Users roles: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Roles configuration: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/Configuration participant_conversations: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/ParticipantConversations conversation_with_participants: mapping: chat_service_sid: sid resource_url: /v1/Services/{chat_service_sid}/ConversationWithParticipants pathType: instance delete: description: Remove a conversation service with all its nested resources from your account summary: Remove a conversation service with all its nested resources from your account tags: - ConversationsV1Service parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteService get: description: Fetch a conversation service from your account summary: Fetch a conversation service from your account tags: - ConversationsV1Service parameters: - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service' examples: fetch: value: sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: My First Service date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations users: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users roles: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles bindings: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings configuration: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration participant_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations conversation_with_participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ConversationWithParticipants headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchService /v1/Services/{ChatServiceSid}/Bindings/{Sid}: servers: - url: https://conversations.twilio.com description: A Binding resource represents a push notification binding and its configuration, for delivering conversation events to mobile or web endpoints. x-twilio: defaultOutputProperties: - sid - endpoint - identity parent: /Services/{Sid} pathType: instance delete: description: Remove a push notification binding from the conversation service summary: Remove a push notification binding from the conversation service tags: - ConversationsV1Binding parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the Binding resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Binding resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceBinding get: description: Fetch a push notification binding from the conversation service summary: Fetch a push notification binding from the conversation service tags: - ConversationsV1Binding parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^BS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_binding' examples: fetch: value: sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-10-21T11:37:03Z' date_updated: '2016-10-21T11:37:03Z' endpoint: TestUser-endpoint identity: TestUser binding_type: gcm credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa message_types: - removed_from_conversation - new_message - added_to_conversation url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceBinding /v1/Services/{ChatServiceSid}/Bindings: servers: - url: https://conversations.twilio.com description: A Binding resource represents a push notification binding and its configuration, for delivering conversation events to mobile or web endpoints. x-twilio: defaultOutputProperties: - sid - endpoint - identity parent: /Services/{Sid} pathType: list get: description: Retrieve a list of all push notification bindings in the conversation service summary: Retrieve a list of all push notification bindings in the conversation service tags: - ConversationsV1Binding parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Binding resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: BindingType in: query 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.' schema: type: array items: $ref: '#/components/schemas/service_binding_enum_binding_type' - name: Identity in: query 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. schema: type: array items: type: string x-twilio: pii: handling: standard deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 100. schema: type: integer format: int64 minimum: 1 maximum: 100 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: bindings: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_binding' 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 examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 next_page_url: null key: bindings bindings: - sid: BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-10-21T11:37:03Z' date_updated: '2016-10-21T11:37:03Z' endpoint: TestUser-endpoint identity: TestUser binding_type: gcm credential_sid: CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa message_types: - removed_from_conversation - new_message - added_to_conversation url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0 next_page_url: null key: bindings bindings: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListServiceBinding /v1/Services/{ChatServiceSid}/Configuration: servers: - url: https://conversations.twilio.com description: A Service Configuration resource manages service-level settings applicable to the Conversation API. x-twilio: defaultOutputProperties: - chat_service_sid parent: /Services/{Sid} pathType: instance get: description: Fetch the configuration of a conversation service summary: Fetch the configuration of a conversation service tags: - ConversationsV1Configuration parameters: - name: ChatServiceSid in: path description: The SID of the Service configuration resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration' examples: fetch: value: chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_conversation_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_conversation_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_chat_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa reachability_enabled: false url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration links: notifications: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceConfiguration post: description: Update configuration settings of a conversation service summary: Update configuration settings of a conversation service tags: - ConversationsV1Configuration parameters: - name: ChatServiceSid in: path description: The SID of the Service configuration resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration' examples: update: value: chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_conversation_creator_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_conversation_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa default_chat_service_role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa reachability_enabled: false url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration links: notifications: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConfiguration requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceConfigurationRequest properties: DefaultConversationCreatorRoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ 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. DefaultConversationRoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ 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. DefaultChatServiceRoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ 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. ReachabilityEnabled: type: boolean description: Whether the [Reachability Indicator](https://www.twilio.com/docs/conversations/reachability) is enabled for this Conversations Service. The default is `false`. examples: update: value: DefaultConversationCreatorRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DefaultConversationRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DefaultChatServiceRoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ReachabilityEnabled: false /v1/Services/{ChatServiceSid}/Conversations: servers: - url: https://conversations.twilio.com description: A Service Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster. x-twilio: defaultOutputProperties: - sid - chat_service_sid - friendly_name - date_created dependentProperties: participants: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Participants messages: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages webhooks: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Webhooks export: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Export parent: /Services/{Sid} pathType: list post: description: Create a new conversation in your service summary: Create a new conversation in your service tags: - ConversationsV1Conversation parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_conversation_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' examples: create: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: unique_name attributes: '{ "topic": "feedback" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' bindings: {} url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks export: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export createNoTimersNoAttributes: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: null attributes: '{}' date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' state: active timers: {} bindings: {} url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks export: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversation requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateServiceConversationRequest properties: FriendlyName: type: string description: The human-readable name of this conversation, limited to 256 characters. Optional. UniqueName: type: string 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. Attributes: type: string 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. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. State: $ref: '#/components/schemas/service_conversation_enum_state' Timers.Inactive: type: string description: ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute. Timers.Closed: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. Bindings.Email.Address: type: string description: The default email address that will be used when sending outbound emails in this conversation. Bindings.Email.Name: type: string description: The default name that will be used when sending outbound emails in this conversation. examples: create: value: FriendlyName: friendly_name UniqueName: unique_name Attributes: '{ "topic": "feedback" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa State: inactive Timers.Inactive: PT1M Timers.Closed: PT10M createNoTimersNoAttributes: value: FriendlyName: friendly_name DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa State: active get: description: Retrieve a list of conversations in your service summary: Retrieve a list of conversations in your service tags: - ConversationsV1Conversation parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: StartDate in: query description: Specifies the beginning of the date range for filtering Conversations based on their creation date. Conversations that were created on or after this date will be included in the results. The date must be in ISO8601 format, specifically starting at the beginning of the specified date (YYYY-MM-DDT00:00:00Z), for precise filtering. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order. schema: type: string - name: EndDate in: query description: Defines the end of the date range for filtering conversations by their creation date. Only conversations that were created on or before this date will appear in the results. The date must be in ISO8601 format, specifically capturing up to the end of the specified date (YYYY-MM-DDT23:59:59Z), to ensure that conversations from the entire end day are included. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order. schema: type: string - name: State in: query description: State for sorting and filtering list of Conversations. Can be `active`, `inactive` or `closed` schema: $ref: '#/components/schemas/service_conversation_enum_state' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 100. schema: type: integer format: int64 minimum: 1 maximum: 100 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: conversations: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_conversation' 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 examples: readFull: value: conversations: - sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Home Repair Visit unique_name: null attributes: '{ "topic": "feedback" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' state: active timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' bindings: {} url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks export: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 next_page_url: null key: conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListServiceConversation /v1/Services/{ChatServiceSid}/Conversations/{Sid}: servers: - url: https://conversations.twilio.com description: A Service Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster. x-twilio: defaultOutputProperties: - sid - chat_service_sid - friendly_name - date_created dependentProperties: participants: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Participants messages: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Messages webhooks: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Webhooks export: mapping: chat_service_sid: chat_service_sid conversation_sid: sid resource_url: /v1/Services/{chat_service_sid}/Conversations/{conversation_sid}/Export parent: /Services/{Sid} pathType: instance post: description: Update an existing conversation in your service summary: Update an existing conversation in your service tags: - ConversationsV1Conversation parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_conversation_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' examples: update: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab friendly_name: friendly_name unique_name: unique_name attributes: '{ "topic": "feedback" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' bindings: {} url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks export: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversation requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceConversationRequest properties: FriendlyName: type: string description: The human-readable name of this conversation, limited to 256 characters. Optional. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. Attributes: type: string 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. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. State: $ref: '#/components/schemas/service_conversation_enum_state' Timers.Inactive: type: string description: ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute. Timers.Closed: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. UniqueName: type: string 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. Bindings.Email.Address: type: string description: The default email address that will be used when sending outbound emails in this conversation. Bindings.Email.Name: type: string description: The default name that will be used when sending outbound emails in this conversation. examples: update: value: FriendlyName: friendly_name UniqueName: unique_name Attributes: '{ "topic": "feedback" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab State: inactive Timers.Inactive: PT1M Timers.Closed: PT10M delete: description: Remove a conversation from your service summary: Remove a conversation from your service tags: - ConversationsV1Conversation parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_conversation_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceConversation get: description: Fetch a conversation from your service summary: Fetch a conversation from your service tags: - ConversationsV1Conversation parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Can also be the `unique_name` of the Conversation. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation' examples: fetch: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: My First Conversation unique_name: first_conversation attributes: '{ "topic": "feedback" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' state: active timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' bindings: {} url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks export: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Export headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversation /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages: servers: - url: https://conversations.twilio.com description: A Service Message resource represents a message in a conversation within a specific service. x-twilio: defaultOutputProperties: - sid - index - author - date_created dependentProperties: 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 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 parent: /Services/{ChatServiceSid}/Conversations/{Sid} pathType: list post: description: Add a new message to the conversation in a specific service summary: Add a new message to the conversation in a specific service tags: - ConversationsV1Message parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_conversation_message_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' examples: create: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Hello media: null author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata createWithMedia: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: null media: - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa size: 42056 content_type: image/jpeg filename: car.jpg author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata createNoAttributes: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Hello media: null author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{}' date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata createWithContentSid: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Hello John media: null author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{}' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata createWithSubject: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: message body media: null author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{}' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationMessage requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateServiceConversationMessageRequest properties: Author: type: string description: The channel specific identifier of the message's author. Defaults to `system`. Body: type: string description: The content of the message, can be up to 1,600 characters long. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. `null` if the message has not been edited. Attributes: type: string 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. MediaSid: type: string minLength: 34 maxLength: 34 pattern: ^ME[0-9a-fA-F]{32}$ description: The Media SID to be attached to the new Message. ContentSid: type: string minLength: 34 maxLength: 34 pattern: ^HX[0-9a-fA-F]{32}$ 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. ContentVariables: type: string description: A structurally valid JSON string that contains values to resolve Rich Content template variables. Subject: type: string description: The subject of the message, can be up to 256 characters long. examples: create: value: Body: Hello Author: message author Attributes: '{ "importance": "high" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createWithMedia: value: MediaSid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Author: message author Attributes: '{ "importance": "high" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createNoAttributes: value: Body: Hello Author: message author DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' createWithContentSid: value: Author: message author DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' ContentSid: HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ContentVariables: '{"name": "John"}' createWithSubject: value: Author: message author Body: message body DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' Subject: message subject get: description: Retrieve a list of all messages in the conversation summary: Retrieve a list of all messages in the conversation tags: - ConversationsV1Message parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for messages. schema: type: string required: true - name: Order in: query description: 'The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending), with `asc` as the default.' schema: $ref: '#/components/schemas/service_conversation_message_enum_order_type' examples: readLastMessage: value: desc - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 100. schema: type: integer format: int64 minimum: 1 maximum: 100 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: messages: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' 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 examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?PageSize=50&Page=0 next_page_url: null key: messages messages: - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: I like pie. media: null author: pie_preferrer participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Cake is my favorite! media: null author: cake_lover participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2016-03-24T20:38:21Z' date_updated: '2016-03-24T20:38:21Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: null media: - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa size: 42056 content_type: image/jpeg filename: car.jpg author: cake_lover participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2016-03-24T20:38:21Z' date_updated: '2016-03-24T20:38:21Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata readLastMessage: value: meta: page: 0 page_size: 1 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=0 next_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages?Order=desc&PageSize=1&Page=1&PageToken=PAIMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa key: messages messages: - sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: null media: - sid: MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa size: 42056 content_type: image/jpeg filename: car.jpg author: cake_lover participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2016-03-24T20:38:21Z' date_updated: '2016-03-24T20:38:21Z' index: 9 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationMessage /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid}: servers: - url: https://conversations.twilio.com description: A Service Message resource represents a message in a conversation within a specific service. x-twilio: defaultOutputProperties: - sid - index - author - date_created dependentProperties: 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 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 parent: /Services/{ChatServiceSid}/Conversations/{Sid} pathType: instance post: description: Update an existing message in the conversation summary: Update an existing message in the conversation tags: - ConversationsV1Message parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_conversation_message_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' examples: update: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Hello media: null author: message author participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa attributes: '{ "importance": "high" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationMessage requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceConversationMessageRequest properties: Author: type: string description: The channel specific identifier of the message's author. Defaults to `system`. Body: type: string description: The content of the message, can be up to 1,600 characters long. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. `null` if the message has not been edited. Attributes: type: string 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. Subject: type: string description: The subject of the message, can be up to 256 characters long. examples: update: value: Body: Hello Author: message author Attributes: '{ "importance": "high" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' delete: description: Remove a message from the conversation summary: Remove a message from the conversation tags: - ConversationsV1Message parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_conversation_message_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceConversationMessage get: description: Fetch a message from the conversation summary: Fetch a message from the conversation tags: - ConversationsV1Message parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message' examples: fetch: value: sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa body: Welcome! media: null author: system participant_sid: null attributes: '{ "importance": "high" }' date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' index: 0 delivery: total: 2 sent: all delivered: some read: some failed: none undelivered: none content_sid: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: delivery_receipts: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts channel_metadata: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelMetadata headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationMessage /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts/{Sid}: servers: - url: https://conversations.twilio.com description: A Service Message Receipt resource represents a delivery/read receipt of a message in a conversation. x-twilio: defaultOutputProperties: - sid - message_sid - status - date_created parent: /Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts pathType: instance get: description: Fetch the delivery and read receipts of the conversation message summary: Fetch the delivery and read receipts of the conversation message tags: - ConversationsV1DeliveryReceipt parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: MessageSid in: path description: The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^DY[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt' examples: fetch: value: sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: failed error_code: 3000 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationMessageReceipt /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{MessageSid}/Receipts: servers: - url: https://conversations.twilio.com description: A Service Message Receipt resource represents a delivery/read receipt of a message in a conversation. x-twilio: defaultOutputProperties: - sid - message_sid - status - date_created parent: /Services/{ChatServiceSid}/Conversations/{ConversationSid}/Messages/{Sid} mountName: delivery_receipts pathType: list get: description: Retrieve a list of all delivery and read receipts of the conversation message summary: Retrieve a list of all delivery and read receipts of the conversation message tags: - ConversationsV1DeliveryReceipt parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Message resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this message. schema: type: string required: true - name: MessageSid in: path description: The SID of the message within a [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) the delivery receipt belongs to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IM[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 50. schema: type: integer format: int64 minimum: 1 maximum: 50 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: delivery_receipts: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_message.service_conversation_message_receipt' 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 examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts?PageSize=50&Page=0 next_page_url: null key: delivery_receipts delivery_receipts: - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: failed error_code: 3000 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: failed error_code: 3000 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - sid: DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa message_sid: IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_message_sid: SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: failed error_code: 3000 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T20:37:57Z' date_updated: '2016-03-24T20:37:57Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/IMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Receipts/DYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationMessageReceipt /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants: servers: - url: https://conversations.twilio.com description: A Service Participant resource represents a member of the conversation within a specific service. x-twilio: defaultOutputProperties: - sid - messaging_binding parent: /Services/{ChatServiceSid}/Conversations/{Sid} pathType: list post: description: Add a new participant to the conversation in a specific service summary: Add a new participant to the conversation in a specific service tags: - ConversationsV1Participant parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_conversation_participant_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' examples: createSms: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: 'null' attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675310' proxy_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createChat: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: IDENTITY attributes: '{ "role": "driver" }' messaging_binding: null role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createGmms: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: IDENTITY attributes: '{ "role": "driver" }' messaging_binding: type: sms projected_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createGmmsChatNoAttributes: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: IDENTITY attributes: '{}' messaging_binding: type: sms projected_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createGmmsSmsNoAttributes: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: null attributes: '{}' messaging_binding: type: sms address: '+15017122661' role_sid: null date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createRcs: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: 'null' attributes: '{ "role": "driver" }' messaging_binding: type: rcs address: rcs:+15558675310 proxy_address: rcs:+15017122661 role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null createRcsWithFallback: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: 'null' attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675311' proxy_address: '+12025552661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationParticipant requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateServiceConversationParticipantRequest properties: Identity: 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 [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. MessagingBinding.Address: type: string 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). MessagingBinding.ProxyAddress: type: string 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). DateCreated: type: string format: date-time description: The date on which this resource was created. DateUpdated: type: string format: date-time description: The date on which this resource was last updated. Attributes: type: string 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. MessagingBinding.ProjectedAddress: type: string description: The address of the Twilio phone number that is used in Group MMS. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. examples: createSms: value: Attributes: '{ "role": "driver" }' MessagingBinding.Address: '+15558675310' MessagingBinding.ProxyAddress: '+15017122661' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createChat: value: Identity: IDENTITY Attributes: '{ "role": "driver" }' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createGmms: value: Identity: IDENTITY Attributes: '{ "role": "driver" }' MessagingBinding.ProjectedAddress: '+15017122661' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createGmmsChatNoAttributes: value: Identity: IDENTITY MessagingBinding.ProjectedAddress: '+15017122661' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' createGmmsSmsNoAttributes: value: MessagingBinding.Address: '+15017122661' DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' createRcs: value: Attributes: '{ "role": "driver" }' MessagingBinding.Address: rcs:+15558675310 MessagingBinding.ProxyAddress: rcs:+15017122661 RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' createRcsWithFallback: value: Attributes: '{ "role": "driver" }' MessagingBinding.Address: rcs:+15558675311 MessagingBinding.ProxyAddress: rcs:+15017122661 MessagingBinding.ProxyAddressFallback: '+12025552661' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' get: description: Retrieve a list of all participants of the conversation summary: Retrieve a list of all participants of the conversation tags: - ConversationsV1Participant parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for participants. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 100. schema: type: integer format: int64 minimum: 1 maximum: 100 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: participants: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' 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: ListServiceConversationParticipantResponse examples: read: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants?PageSize=50&Page=0 next_page_url: null key: participants participants: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: null attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675310' proxy_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: IDENTITY attributes: '{ "role": "driver" }' messaging_binding: null role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationParticipant /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants/{Sid}: servers: - url: https://conversations.twilio.com description: A Service Participant resource represents a member of the conversation within a specific service. x-twilio: defaultOutputProperties: - sid - messaging_binding parent: /Services/{ChatServiceSid}/Conversations/{Sid} pathType: instance post: description: Update an existing participant in the conversation summary: Update an existing participant in the conversation tags: - ConversationsV1Participant parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_conversation_participant_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: null attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675310' proxy_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null updateGmms: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: id attributes: '{ "role": "driver" }' messaging_binding: type: sms projected_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationParticipant requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceConversationParticipantRequest properties: DateCreated: type: string format: date-time description: The date on which this resource was created. DateUpdated: type: string format: date-time description: The date on which this resource was last updated. Identity: 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 [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters. Attributes: type: string 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. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant. MessagingBinding.ProxyAddress: type: string description: The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it. MessagingBinding.ProjectedAddress: type: string description: The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it. LastReadMessageIndex: type: integer nullable: true description: "Index of last \u201Cread\u201D message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." LastReadTimestamp: type: string description: "Timestamp of last \u201Cread\u201D message in the\ \ [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource)\ \ for the Participant." examples: update: value: Attributes: '{ "role": "driver" }' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' updateGmms: value: MessagingBinding.ProjectedAddress: '+15017122661' delete: description: Remove a participant from the conversation summary: Remove a participant from the conversation tags: - ConversationsV1Participant parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_conversation_participant_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceConversationParticipant get: description: Fetch a participant of the conversation summary: Fetch a participant of the conversation tags: - ConversationsV1Participant parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this participant. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's `identity` rather than the SID. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_participant' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: null attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675310' proxy_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null fetchByIdentity: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: alice attributes: '{ "role": "driver" }' messaging_binding: type: sms address: '+15558675310' proxy_address: '+15017122661' role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa last_read_message_index: null last_read_timestamp: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationParticipant /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks: servers: - url: https://conversations.twilio.com description: A Conversation-scoped Webhook resource manages a set of callback URLs and their configuration for receiving events specific to one conversation. x-twilio: defaultOutputProperties: - sid - target parent: /Services/{ChatServiceSid}/Conversations/{Sid} pathType: list post: description: Create a new webhook scoped to the conversation in a specific service summary: Create a new webhook scoped to the conversation in a specific service tags: - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: webhook configuration: url: https://example.com method: get filters: - onMessageSent - onConversationDestroyed date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateServiceConversationScopedWebhook requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateServiceConversationScopedWebhookRequest properties: Target: $ref: '#/components/schemas/service_conversation_scoped_webhook_enum_target' Configuration.Url: type: string description: The absolute url the webhook request should be sent to. Configuration.Method: $ref: '#/components/schemas/service_conversation_scoped_webhook_enum_method' Configuration.Filters: type: array items: type: string description: The list of events, firing webhook event for this Conversation. Configuration.Triggers: type: array items: type: string description: The list of keywords, firing webhook event for this Conversation. Configuration.FlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: The studio flow SID, where the webhook should be sent to. Configuration.ReplayAfter: type: integer description: The message index for which and it's successors the webhook will be replayed. Not set by default required: - Target examples: create: value: Target: webhook Configuration.Url: https://example.com Configuration.Method: get Configuration.Filters: - onMessageSent - onConversationDestroyed Configuration.ReplayAfter: 7 get: description: Retrieve a list of all webhooks scoped to the conversation summary: Retrieve a list of all webhooks scoped to the conversation tags: - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 5, and the maximum is 5. schema: type: integer format: int64 minimum: 1 maximum: 5 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: webhooks: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' 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: ListServiceConversationScopedWebhookResponse examples: readFull: value: meta: page: 0 page_size: 5 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 next_page_url: null key: webhooks webhooks: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: webhook configuration: url: https://example.com method: get filters: - onMessageSent - onConversationDestroyed date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: trigger configuration: url: https://example.com method: post filters: - keyword1 - keyword2 date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: studio configuration: flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 5 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks?PageSize=5&Page=0 previous_page_url: null next_page_url: null key: webhooks webhooks: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListServiceConversationScopedWebhook /v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Webhooks/{Sid}: servers: - url: https://conversations.twilio.com description: A Conversation-scoped Webhook resource manages a set of callback URLs and their configuration for receiving events specific to one conversation. x-twilio: defaultOutputProperties: - sid - target parent: /Services/{ChatServiceSid}/Conversations/{Sid} pathType: instance post: description: Update an existing conversation-scoped webhook summary: Update an existing conversation-scoped webhook tags: - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: trigger configuration: url: https://example.com method: post filters: - keyword1 - keyword2 date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:51Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateServiceConversationScopedWebhook requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceConversationScopedWebhookRequest properties: Configuration.Url: type: string description: The absolute url the webhook request should be sent to. Configuration.Method: $ref: '#/components/schemas/service_conversation_scoped_webhook_enum_method' Configuration.Filters: type: array items: type: string description: The list of events, firing webhook event for this Conversation. Configuration.Triggers: type: array items: type: string description: The list of keywords, firing webhook event for this Conversation. Configuration.FlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: The studio flow SID, where the webhook should be sent to. examples: update: value: Configuration.Url: https://example.com Configuration.Method: post Configuration.Triggers: - keyword1 - keyword2 delete: description: Remove an existing webhook scoped to the conversation summary: Remove an existing webhook scoped to the conversation tags: - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceConversationScopedWebhook get: description: Fetch the configuration of a conversation-scoped webhook summary: Fetch the configuration of a conversation-scoped webhook tags: - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: ConversationSid in: path description: The unique ID of the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for this webhook. schema: type: string required: true - name: Sid in: path description: A 34 character string that uniquely identifies this resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^WH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation.service_conversation_scoped_webhook' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa target: studio configuration: flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-03-24T21:05:50Z' date_updated: '2016-03-24T21:05:50Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks/WHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceConversationScopedWebhook /v1/Services/{ChatServiceSid}/ConversationWithParticipants: servers: - url: https://conversations.twilio.com description: A Service Conversation resource represents an omnichannel group conversation with an ordered list of messages and a participant roster. x-twilio: defaultOutputProperties: - sid - chat_service_sid - friendly_name - date_created parent: /Services/{Sid} className: conversation_with_participants pathType: list post: description: Create a new conversation with the list of participants in your account's default service summary: Create a new conversation with the list of participants in your account's default service tags: - ConversationsV1ConversationWithParticipants parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_conversation_with_participants_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation_with_participants' examples: create: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: unique_name attributes: '{ "topic": "feedback" }' date_created: '2015-12-16T22:18:37Z' date_updated: '2015-12-16T22:18:38Z' state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' bindings: {} links: participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createNoTimersNoAttributes: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: null attributes: '{}' date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' state: active timers: {} bindings: {} links: participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created '202': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_conversation_with_participants' examples: createWithParticipants: value: sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name unique_name: null attributes: '{}' date_created: '2020-07-01T22:18:37Z' date_updated: '2020-07-01T22:18:37Z' state: active timers: {} bindings: {} links: participants: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants messages: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages webhooks: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Webhooks url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Accepted security: - accountSid_authToken: [] operationId: CreateServiceConversationWithParticipants requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateServiceConversationWithParticipantsRequest properties: FriendlyName: type: string description: The human-readable name of this conversation, limited to 256 characters. Optional. UniqueName: type: string 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. DateCreated: type: string format: date-time description: The date that this resource was created. DateUpdated: type: string format: date-time description: The date that this resource was last updated. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The unique ID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to. Attributes: type: string 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. State: $ref: '#/components/schemas/service_conversation_with_participants_enum_state' Timers.Inactive: type: string description: ISO8601 duration when conversation will be switched to `inactive` state. Minimum value for this timer is 1 minute. Timers.Closed: type: string description: ISO8601 duration when conversation will be switched to `closed` state. Minimum value for this timer is 10 minutes. Bindings.Email.Address: type: string description: The default email address that will be used when sending outbound emails in this conversation. Bindings.Email.Name: type: string description: The default name that will be used when sending outbound emails in this conversation. Participant: type: array items: type: string description: The participant to be added to the conversation in JSON format. The JSON object attributes are as parameters in [Participant Resource](https://www.twilio.com/docs/conversations/api/conversation-participant-resource). The maximum number of participants that can be added in a single request is 10. examples: create: value: FriendlyName: friendly_name UniqueName: unique_name Attributes: '{ "topic": "feedback" }' DateCreated: '2015-12-16T22:18:37Z' DateUpdated: '2015-12-16T22:18:38Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa State: inactive Timers.Inactive: PT1M Timers.Closed: PT10M createNoTimersNoAttributes: value: FriendlyName: friendly_name DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa State: active createWithParticipants: value: FriendlyName: friendly_name DateCreated: '2020-07-01T22:18:37Z' DateUpdated: '2020-07-01T22:18:37Z' MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa State: active Participant: - '{ "identity": "user1" }' - '{ "identity": "user2" }' /v1/Services/{ChatServiceSid}/Configuration/Notifications: servers: - url: https://conversations.twilio.com description: A Service Notification resource manages a set of settings to determine push notification behavior at service level. x-twilio: defaultOutputProperties: - chat_service_sid parent: /Services/{ChatServiceSid}/Configuration pathType: instance post: description: Update push notification service settings summary: Update push notification service settings tags: - ConversationsV1Notification parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_notification' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa log_enabled: true added_to_conversation: enabled: false template: 'You have been added to a Conversation: ${CONVERSATION}' sound: ring new_message: enabled: false template: 'You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}' badge_count_enabled: true sound: ring with_media: enabled: false template: 'You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}' removed_from_conversation: enabled: false template: 'You have been removed from a Conversation: ${CONVERSATION}' sound: ring url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateServiceNotification requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceNotificationRequest properties: LogEnabled: type: boolean description: Weather the notification logging is enabled. NewMessage.Enabled: type: boolean description: Whether to send a notification when a new message is added to a conversation. The default is `false`. NewMessage.Template: type: string 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`. NewMessage.Sound: type: string description: The name of the sound to play when a new message is added to a conversation and `new_message.enabled` is `true`. NewMessage.BadgeCountEnabled: type: boolean description: Whether the new message badge is enabled. The default is `false`. AddedToConversation.Enabled: type: boolean description: Whether to send a notification when a participant is added to a conversation. The default is `false`. AddedToConversation.Template: type: string 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`. AddedToConversation.Sound: type: string description: The name of the sound to play when a participant is added to a conversation and `added_to_conversation.enabled` is `true`. RemovedFromConversation.Enabled: type: boolean description: Whether to send a notification to a user when they are removed from a conversation. The default is `false`. RemovedFromConversation.Template: type: string 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`. RemovedFromConversation.Sound: type: string 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`. NewMessage.WithMedia.Enabled: type: boolean description: Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is `false`. NewMessage.WithMedia.Template: type: string 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`. examples: update: value: NewMessage.Enabled: false NewMessage.Template: 'You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}' NewMessage.Sound: ring NewMessage.BadgeCountEnabled: true NewMessage.WithMedia.Enabled: false NewMessage.WithMedia.Template: 'You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}' AddedToConversation.Enabled: false AddedToConversation.Template: 'You have been added to a Conversation: ${CONVERSATION}' AddedToConversation.Sound: ring RemovedFromConversation.Enabled: false RemovedFromConversation.Template: 'You have been removed from a Conversation: ${CONVERSATION}' RemovedFromConversation.Sound: ring LogEnabled: true get: description: Fetch push notification service settings summary: Fetch push notification service settings tags: - ConversationsV1Notification parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Configuration applies to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_notification' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa log_enabled: false added_to_conversation: enabled: true template: 'You have been added to a Conversation: ${CONVERSATION}' sound: ring new_message: enabled: true template: 'You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}' badge_count_enabled: false sound: ring with_media: enabled: false template: 'You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}' removed_from_conversation: enabled: true template: 'You have been removed from a Conversation: ${CONVERSATION}' sound: ring url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceNotification /v1/Services/{ChatServiceSid}/ParticipantConversations: servers: - url: https://conversations.twilio.com description: Service Participant Conversations resource represents a list of Conversations that this Participant belongs to belonging to a specific conversation service. x-twilio: defaultOutputProperties: - chat_service_sid - participant_sid - conversation_sid parent: /Services/{Sid} pathType: list get: description: Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified. summary: Retrieve a list of all Conversations that this Participant belongs to by identity or by address. Only one parameter should be specified. tags: - ConversationsV1ParticipantConversation parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Participant Conversations resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Identity in: query 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. schema: type: string examples: readEmpty: value: identity readFullByIdentity: value: identity - name: Address in: query 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. schema: type: string examples: readFullByAddress: value: '+375255555555' - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 50. schema: type: integer format: int64 minimum: 1 maximum: 50 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: conversations: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_participant_conversation' 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 examples: readEmpty: value: conversations: [] meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 next_page_url: null key: conversations readFullByIdentity: value: conversations: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_friendly_name: friendly_name conversation_state: inactive conversation_timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' conversation_attributes: '{}' conversation_date_created: '2015-07-30T20:00:00Z' conversation_date_updated: '2015-07-30T20:00:00Z' conversation_created_by: created_by conversation_unique_name: unique_name participant_user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa participant_identity: identity participant_messaging_binding: null links: participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Identity=identity&PageSize=50&Page=0 next_page_url: null key: conversations readFullByAddress: value: conversations: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_friendly_name: friendly_name conversation_state: inactive conversation_timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' conversation_attributes: '{}' conversation_date_created: '2015-07-30T20:00:00Z' conversation_date_updated: '2015-07-30T20:00:00Z' conversation_created_by: created_by conversation_unique_name: unique_name participant_user_sid: null participant_identity: null participant_messaging_binding: address: '+375255555555' proxy_address: '+12345678910' type: sms level: null name: null projected_address: null links: participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ParticipantConversations?Address=%2B375255555555&PageSize=50&Page=0 next_page_url: null key: conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListServiceParticipantConversation /v1/Services/{ChatServiceSid}/Roles: servers: - url: https://conversations.twilio.com description: A Service Role resource represents a set of permissions granted to a user within a service or a conversation. x-twilio: defaultOutputProperties: - sid - friendly_name - type parent: /Services/{Sid} pathType: list post: description: Create a new user role in your service summary: Create a new user role in your service tags: - ConversationsV1Role parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to create the Role resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' examples: create: value: sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Conversation Role type: conversation permissions: - sendMessage - leaveConversation - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateServiceRole requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateServiceRoleRequest properties: FriendlyName: type: string description: A descriptive string that you create to describe the new resource. It can be up to 64 characters long. Type: $ref: '#/components/schemas/service_role_enum_role_type' Permission: type: array items: type: string 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`. required: - FriendlyName - Type - Permission examples: create: value: FriendlyName: Conversation Role Type: conversation Permission: sendMessage get: description: Retrieve a list of all user roles in your service summary: Retrieve a list of all user roles in your service tags: - ConversationsV1Role parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the Role resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 50. schema: type: integer format: int64 minimum: 1 maximum: 50 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: roles: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_role' 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: ListServiceRoleResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 next_page_url: null key: roles roles: - sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Conversation Role type: conversation permissions: - sendMessage - leaveConversation - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0 next_page_url: null key: roles roles: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListServiceRole /v1/Services/{ChatServiceSid}/Roles/{Sid}: servers: - url: https://conversations.twilio.com description: A Service Role resource represents a set of permissions granted to a user within a service or a conversation. x-twilio: defaultOutputProperties: - sid - friendly_name - type parent: /Services/{Sid} pathType: instance post: description: Update an existing user role in your service summary: Update an existing user role in your service tags: - ConversationsV1Role parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to update the Role resource in. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Role resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' examples: update: value: sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Conversation Role type: conversation permissions: - sendMessage - leaveConversation - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateServiceRole requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceRoleRequest properties: Permission: type: array items: type: string 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`. required: - Permission examples: update: value: Permission: sendMessage delete: description: Remove a user role from your service summary: Remove a user role from your service tags: - ConversationsV1Role parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the Role resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Role resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceRole get: description: Fetch a user role from your service summary: Fetch a user role from your service tags: - ConversationsV1Role parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the Role resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Role resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_role' examples: fetch: value: sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Conversation Role type: conversation permissions: - sendMessage - leaveConversation - editOwnMessage - deleteOwnMessage date_created: '2016-03-03T19:47:15Z' date_updated: '2016-03-03T19:47:15Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceRole /v1/Services/{ChatServiceSid}/Users: servers: - url: https://conversations.twilio.com description: A Service User resource represents a conversation user belonging to a specific conversation service. 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 post: description: Add a new conversation user to your service summary: Add a new conversation user to your service tags: - ConversationsV1User parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_user_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' examples: create: value: sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: admin friendly_name: name attributes: '{ "duty": "tech" }' is_online: true is_notifiable: null date_created: '2019-12-16T22:18:37Z' date_updated: '2019-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateServiceUser requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateServiceUserRequest properties: Identity: type: string 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. FriendlyName: type: string description: The string that you assigned to describe the resource. Attributes: type: string description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user. required: - Identity examples: create: value: Identity: admin FriendlyName: name Attributes: '{ "duty": "tech" }' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all conversation users in your service summary: Retrieve a list of all conversation users in your service tags: - ConversationsV1User parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to read the User resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 50. schema: type: integer format: int64 minimum: 1 maximum: 50 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: users: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_user' 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: ListServiceUserResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users?PageSize=50&Page=0 next_page_url: null key: users users: - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: admin friendly_name: name attributes: '{ "duty": "tech" }' is_online: true is_notifiable: null date_created: '2019-12-16T22:18:37Z' date_updated: '2019-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: agent0034 friendly_name: John from customs attributes: '{ "duty": "agent" }' is_online: false is_notifiable: null date_created: '2020-03-24T20:38:21Z' date_updated: '2020-03-24T20:38:21Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListServiceUser /v1/Services/{ChatServiceSid}/Users/{Sid}: servers: - url: https://conversations.twilio.com description: A Service User resource represents a conversation user belonging to a specific conversation service. 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 post: description: Update an existing conversation user in your service summary: Update an existing conversation user in your service tags: - ConversationsV1User parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the User resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path 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. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_user_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' examples: update: value: sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: admin friendly_name: new name attributes: '{ "duty": "tech", "team": "internals" }' is_online: true is_notifiable: null date_created: '2019-12-16T22:18:37Z' date_updated: '2019-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateServiceUser requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceUserRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Attributes: type: string description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user. examples: update: value: FriendlyName: new name Attributes: '{ "duty": "tech", "team": "internals" }' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: Remove a conversation user from your service summary: Remove a conversation user from your service tags: - ConversationsV1User parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to delete the User resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path 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. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/service_user_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceUser get: description: Fetch a conversation user from your service summary: Fetch a conversation user from your service tags: - ConversationsV1User parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) to fetch the User resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: Sid in: path 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. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user' examples: fetch: value: sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: admin friendly_name: name attributes: '{ "duty": "tech" }' is_online: true is_notifiable: null date_created: '2019-12-16T22:18:37Z' date_updated: '2019-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: user_conversations: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceUser /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations/{ConversationSid}: servers: - url: https://conversations.twilio.com description: A Service User Conversation resource represents a conversation of the user belonging to a specific conversation service. x-twilio: defaultOutputProperties: - conversation_sid - user_sid - chat_service_sid - friendly_name - date_created parent: /Services/{ChatServiceSid}/Users/{Sid} mountName: user_conversations pathType: instance post: description: Update a specific User Conversation. summary: Update a specific User Conversation. tags: - ConversationsV1UserConversation parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path 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. schema: type: string required: true - name: ConversationSid in: path 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). schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unread_messages_count: 100 last_read_message_index: 100 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name conversation_state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' attributes: '{}' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' created_by: created_by notification_level: default unique_name: unique_name url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateServiceUserConversation requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceUserConversationRequest properties: NotificationLevel: $ref: '#/components/schemas/service_user_conversation_enum_notification_level' LastReadTimestamp: type: string format: date-time description: The date of the last message read in conversation by the user, given in ISO 8601 format. LastReadMessageIndex: type: integer nullable: true description: The index of the last Message in the Conversation that the Participant has read. examples: update: value: NotificationLevel: default LastReadTimestamp: '2015-07-30T20:00:00Z' LastReadMessageIndex: 100 delete: description: Delete a specific User Conversation. summary: Delete a specific User Conversation. tags: - ConversationsV1UserConversation parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path 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. schema: type: string required: true - name: ConversationSid in: path 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). schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteServiceUserConversation get: description: Fetch a specific User Conversation. summary: Fetch a specific User Conversation. tags: - ConversationsV1UserConversation parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path 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. schema: type: string required: true - name: ConversationSid in: path 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). schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unread_messages_count: 100 last_read_message_index: 100 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name conversation_state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' attributes: '{}' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' created_by: created_by notification_level: default unique_name: unique_name url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceUserConversation /v1/Services/{ChatServiceSid}/Users/{UserSid}/Conversations: servers: - url: https://conversations.twilio.com description: A Service User Conversation resource represents a conversation of the user belonging to a specific conversation service. x-twilio: defaultOutputProperties: - conversation_sid - user_sid - chat_service_sid - friendly_name - date_created parent: /Services/{ChatServiceSid}/Users/{Sid} mountName: user_conversations pathType: list get: description: Retrieve a list of all User Conversations for the User. summary: Retrieve a list of all User Conversations for the User. tags: - ConversationsV1UserConversation parameters: - name: ChatServiceSid in: path description: The SID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true - name: UserSid in: path 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. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 50. schema: type: integer format: int64 minimum: 1 maximum: 50 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: conversations: type: array items: $ref: '#/components/schemas/conversations.v1.service.service_user.service_user_conversation' 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 examples: readEmpty: value: conversations: [] meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 next_page_url: null key: conversations readFull: value: conversations: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unread_messages_count: 100 last_read_message_index: 100 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name conversation_state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' attributes: '{}' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' created_by: created_by notification_level: default unique_name: unique_name url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participant: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 next_page_url: null key: conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListServiceUserConversation /v1/Services/{ChatServiceSid}/Configuration/Webhooks: servers: - url: https://conversations.twilio.com description: A service webhook configuration resource manages a service-level set of callback URLs and their configuration for receiving all the corresponding service events. x-twilio: defaultOutputProperties: - chat_service_sid parent: /Services/{ChatServiceSid}/Configuration pathType: instance post: description: Update a specific Webhook. summary: Update a specific Webhook. tags: - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa pre_webhook_url: https://www.example.com/pre post_webhook_url: https://www.example.com/post filters: - onMessageRemoved - onParticipantAdded method: GET url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateServiceWebhookConfiguration requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceWebhookConfigurationRequest properties: PreWebhookUrl: type: string format: uri description: The absolute url the pre-event webhook request should be sent to. PostWebhookUrl: type: string format: uri description: The absolute url the post-event webhook request should be sent to. Filters: type: array items: type: string 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`. Method: type: string description: The HTTP method to be used when sending a webhook request. One of `GET` or `POST`. examples: update: value: PreWebhookUrl: https://www.example.com/pre PostWebhookUrl: https://www.example.com/post Filters: - onMessageRemoved - onParticipantAdded Method: GET get: description: Fetch a specific service webhook configuration. summary: Fetch a specific service webhook configuration. tags: - ConversationsV1Webhook parameters: - name: ChatServiceSid in: path description: The unique ID of the [Conversation Service](https://www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to. schema: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.service.service_configuration.service_webhook_configuration' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa pre_webhook_url: https://www.example.com/pre post_webhook_url: https://www.example.com/post filters: - onMessageRemove - onParticipantAdd method: POST url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks fetchEmpty: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Webhooks pre_webhook_url: null post_webhook_url: null filters: null method: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchServiceWebhookConfiguration /v1/Users: servers: - url: https://conversations.twilio.com description: A User resource represents a conversation user belonging to a default conversation service. x-twilio: defaultOutputProperties: - sid - identity dependentProperties: user_conversations: mapping: user_sid: sid resource_url: /v1/Users/{user_sid}/Conversations pathType: list post: description: Add a new conversation user to your account's default service summary: Add a new conversation user to your account's default service tags: - ConversationsV1User parameters: - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/user_enum_webhook_enabled_type' responses: '201': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.user' examples: create: value: sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: admin friendly_name: name attributes: '{ "duty": "tech" }' is_online: true is_notifiable: null date_created: '2019-12-16T22:18:37Z' date_updated: '2019-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateUser requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateUserRequest properties: Identity: type: string 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. FriendlyName: type: string description: The string that you assigned to describe the resource. Attributes: type: string description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user. required: - Identity examples: create: value: Identity: admin FriendlyName: name Attributes: '{ "duty": "tech" }' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Retrieve a list of all conversation users in your account's default service summary: Retrieve a list of all conversation users in your account's default service tags: - ConversationsV1User parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 50. schema: type: integer format: int64 minimum: 1 maximum: 50 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: users: type: array items: $ref: '#/components/schemas/conversations.v1.user' 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: ListUserResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Users?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Users?PageSize=50&Page=0 next_page_url: null key: users users: - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: admin friendly_name: name attributes: '{ "duty": "tech" }' is_online: true is_notifiable: null date_created: '2019-12-16T22:18:37Z' date_updated: '2019-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations - sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: agent0034 friendly_name: John from customs attributes: '{ "duty": "agent" }' is_online: false is_notifiable: null date_created: '2020-03-24T20:38:21Z' date_updated: '2020-03-24T20:38:21Z' url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListUser /v1/Users/{Sid}: servers: - url: https://conversations.twilio.com description: A User resource represents a conversation user belonging to a default conversation service. x-twilio: defaultOutputProperties: - sid - identity dependentProperties: user_conversations: mapping: user_sid: sid resource_url: /v1/Users/{user_sid}/Conversations pathType: instance post: description: Update an existing conversation user in your account's default service summary: Update an existing conversation user in your account's default service tags: - ConversationsV1User parameters: - name: Sid in: path 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. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/user_enum_webhook_enabled_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.user' examples: update: value: sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: admin friendly_name: new name attributes: '{ "duty": "tech", "team": "internals" }' is_online: true is_notifiable: null date_created: '2019-12-16T22:18:37Z' date_updated: '2019-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateUser requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateUserRequest properties: FriendlyName: type: string description: The string that you assigned to describe the resource. Attributes: type: string description: The JSON Object string that stores application-specific data. If attributes have not been set, `{}` is returned. RoleSid: type: string minLength: 34 maxLength: 34 pattern: ^RL[0-9a-fA-F]{32}$ description: The SID of a service-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the user. examples: update: value: FriendlyName: new name Attributes: '{ "duty": "tech", "team": "internals" }' RoleSid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa delete: description: Remove a conversation user from your account's default service summary: Remove a conversation user from your account's default service tags: - ConversationsV1User parameters: - name: Sid in: path 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. schema: type: string required: true - name: X-Twilio-Webhook-Enabled in: header description: The X-Twilio-Webhook-Enabled HTTP request header schema: $ref: '#/components/schemas/user_enum_webhook_enabled_type' responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUser get: description: Fetch a conversation user from your account's default service summary: Fetch a conversation user from your account's default service tags: - ConversationsV1User parameters: - name: Sid in: path 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. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.user' examples: fetch: value: sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa role_sid: RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa identity: admin friendly_name: name attributes: '{ "duty": "tech" }' is_online: true is_notifiable: null date_created: '2019-12-16T22:18:37Z' date_updated: '2019-12-16T22:18:38Z' url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: user_conversations: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchUser /v1/Users/{UserSid}/Conversations/{ConversationSid}: servers: - url: https://conversations.twilio.com description: A User Conversation resource represents a conversation of the user belonging to a default conversation service. x-twilio: defaultOutputProperties: - conversation_sid - user_sid - chat_service_sid - friendly_name - date_created parent: /Users/{Sid} mountName: user_conversations pathType: instance post: description: Update a specific User Conversation. summary: Update a specific User Conversation. tags: - ConversationsV1UserConversation parameters: - name: UserSid in: path 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. schema: type: string required: true - name: ConversationSid in: path 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). schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.user.user_conversation' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unread_messages_count: 100 last_read_message_index: 100 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name conversation_state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' attributes: '{}' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' created_by: created_by notification_level: default unique_name: unique_name url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateUserConversation requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateUserConversationRequest properties: NotificationLevel: $ref: '#/components/schemas/user_conversation_enum_notification_level' LastReadTimestamp: type: string format: date-time description: The date of the last message read in conversation by the user, given in ISO 8601 format. LastReadMessageIndex: type: integer nullable: true description: The index of the last Message in the Conversation that the Participant has read. examples: update: value: NotificationLevel: default LastReadTimestamp: '2015-07-30T20:00:00Z' LastReadMessageIndex: 100 delete: description: Delete a specific User Conversation. summary: Delete a specific User Conversation. tags: - ConversationsV1UserConversation parameters: - name: UserSid in: path 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. schema: type: string required: true - name: ConversationSid in: path 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). schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUserConversation get: description: Fetch a specific User Conversation. summary: Fetch a specific User Conversation. tags: - ConversationsV1UserConversation parameters: - name: UserSid in: path 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. schema: type: string required: true - name: ConversationSid in: path 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). schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/conversations.v1.user.user_conversation' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unread_messages_count: 100 last_read_message_index: 100 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name conversation_state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' attributes: '{}' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' created_by: created_by notification_level: default unique_name: unique_name url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchUserConversation /v1/Users/{UserSid}/Conversations: servers: - url: https://conversations.twilio.com description: A User Conversation resource represents a conversation of the user belonging to a default conversation service. x-twilio: defaultOutputProperties: - conversation_sid - user_sid - chat_service_sid - friendly_name - date_created parent: /Users/{Sid} mountName: user_conversations pathType: list get: description: Retrieve a list of all User Conversations for the User. summary: Retrieve a list of all User Conversations for the User. tags: - ConversationsV1UserConversation parameters: - name: UserSid in: path 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. schema: type: string required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 50. schema: type: integer format: int64 minimum: 1 maximum: 50 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: conversations: type: array items: $ref: '#/components/schemas/conversations.v1.user.user_conversation' 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 examples: readEmpty: value: conversations: [] meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 next_page_url: null key: conversations readFull: value: conversations: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation_sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unread_messages_count: 100 last_read_message_index: 100 participant_sid: MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: friendly_name conversation_state: inactive timers: date_inactive: '2015-12-16T22:19:38Z' date_closed: '2015-12-16T22:28:38Z' attributes: '{}' date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' created_by: created_by notification_level: default unique_name: unique_name url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: participant: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Participants/MBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa conversation: https://conversations.twilio.com/v1/Conversations/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 previous_page_url: null url: https://conversations.twilio.com/v1/Users/USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Conversations?PageSize=50&Page=0 next_page_url: null key: conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListUserConversation servers: - url: https://conversations.twilio.com tags: - name: ConversationsV1AddressConfiguration - name: ConversationsV1Binding - name: ConversationsV1ChannelMetadata - name: ConversationsV1Configuration - name: ConversationsV1Conversation - name: ConversationsV1ConversationWithParticipants - name: ConversationsV1Credential - name: ConversationsV1DeliveryReceipt - name: ConversationsV1Export - name: ConversationsV1Message - name: ConversationsV1Notification - name: ConversationsV1Participant - name: ConversationsV1ParticipantConversation - name: ConversationsV1Role - name: ConversationsV1Service - name: ConversationsV1StatsConversationsRatelimitingerrors - name: ConversationsV1StatsTwilsockConcurrentconnections - name: ConversationsV1StatsTwilsockRatelimitingerrors - name: ConversationsV1User - name: ConversationsV1UserConversation - name: ConversationsV1Webhook security: - accountSid_authToken: []