ConversationsParticipant

Create Service Conversation Participant

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

Add a new participant to the conversation in a specific service

Authorization

accountSid_authToken
AuthorizationBasic <token>

In: header

Path Parameters

ChatServiceSid*string

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

Match^IS[0-9a-fA-F]{32}$
Length34 <= length <= 34
ConversationSid*string

The unique ID of the Conversation for this participant.

Header Parameters

X-Twilio-Webhook-Enabled?ServiceConversationParticipantWebhookEnabledType

The X-Twilio-Webhook-Enabled HTTP request header

Value in

  • "true"
  • "false"

Request Body

application/x-www-form-urlencoded

Identity?string

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.Address?string

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?string

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?string

The date on which this resource was created.

Formatdate-time
DateUpdated?string

The date on which this resource was last updated.

Formatdate-time
Attributes?string

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?string

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

RoleSid?string

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

Match^RL[0-9a-fA-F]{32}$
Length34 <= length <= 34

Response Body

application/json

curl -X POST "https://example.com/v1/Services/stringstringstringstringstringstri/Conversations/string/Participants" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'Attributes=%7B+%22role%22%3A+%22driver%22+%7D&MessagingBinding.Address=%2B15558675310&MessagingBinding.ProxyAddress=%2B15017122661&RoleSid=RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&DateCreated=2015-12-16T22%3A18%3A37Z&DateUpdated=2015-12-16T22%3A18%3A38Z'

{  "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}