TWtwilio
ConversationsV1Participant

Add a new participant to the conversation in a specific service

Changed on

Add a new participant to the conversation in a specific service

post/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants

Request

  • Base URL
    https://conversations.twilio.com
  • URL
    https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Conversations/{ConversationSid}/Participants
  • Auth
    HTTP basic

Path parameters

ChatServiceSidstring required

The SID of the Conversation Service the Participant resource is associated with.

ConversationSidstring required

The unique ID of the Conversation for this participant.

Headers

X-Twilio-Webhook-Enabled'true' | 'false'

The X-Twilio-Webhook-Enabled HTTP request header

Request body application/x-www-form-urlencoded

Identitystring

A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.

MessagingBinding.Addressstring

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.ProxyAddressstring

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).

DateCreatedstring date-time

The date on which this resource was created.

DateUpdatedstring date-time

The date on which this resource was last updated.

Attributesstring

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.ProjectedAddressstring

The address of the Twilio phone number that is used in Group MMS.

RoleSidstring

The SID of a conversation-level Role to assign to the participant.

Response

Created

account_sidstring nullable

The unique ID of the Account responsible for this participant.

chat_service_sidstring nullable

The SID of the Conversation Service the Participant resource is associated with.

conversation_sidstring nullable

The unique ID of the Conversation for this participant.

sidstring nullable

A 34 character string that uniquely identifies this resource.

identitystring nullable

A unique string identifier for the conversation participant as Conversation User. This parameter is non-null if (and only if) the participant is using the Conversation SDK to communicate. Limited to 256 characters.

attributesstring nullable

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.

messaging_bindingunknown
role_sidstring nullable

The SID of a conversation-level Role to assign to the participant.

date_createdstring date-time nullable

The date on which this resource was created.

date_updatedstring date-time nullable

The date on which this resource was last updated.

urlstring uri nullable

An absolute API resource URL for this participant.

last_read_message_indexinteger nullable

Index of last “read” message in the Conversation for the Participant.

last_read_timestampstring nullable

Timestamp of last “read” message in the Conversation for the Participant.

Changes

  • v192d1169c37c2Revision changes
    • breaking

      the response's property type changed from object to no type for status

  • v1b4d0e634cd69Revision changes
    • breaking

      the response's property type changed from no type to object for status