Conversation Participant Resource
Each Participant in a Conversation represents one real (probably human) participant in a Conversation.
Creating a Participant joins them with the conversation, and the connected person will receive all subsequent messages.
Deleting a participant removes them from the conversation. They will receive no new messages after that point, but their previous messages will remain in the conversation.
API Base URL
All URLs in the reference documentation use the following base URL:
https://conversations.twilio.com/v1Using the shortened base URL
Using the REST API, you can interact with Conversation Participant resources in the default Conversation Service instance via a "shortened" URL that does not include the Conversation Service instance SID ("ISXXX..."). If you are only using one Conversation Service (the default), you do not need to include the Conversation Service SID in your URL, e.g.
GET /v1/Conversations/CHxx/Participants
For Conversations applications that build on more than one Conversation Service instance, you will need to specify the Conversation Service SID in the REST API call:
GET /v1/Services/ISxx/Conversations/CHxx/ParticipantsConversationParticipant properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The unique ID of the Account responsible for this participant. |
conversation_sid
|
The unique ID of the Conversation for this participant. |
sid
|
A 34 character string that uniquely identifies this resource. |
identity
|
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 Conversations SDK to communicate. Limited to 256 characters. |
attributes
|
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_binding
|
Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant. |
role_sid
|
The SID of a conversation-level Role to assign to the participant. |
date_created
|
The date that this resource was created. |
date_updated
|
The date that this resource was last updated. |
url
|
An absolute API resource URL for this participant. |
last_read_message_index
|
Index of last “read” message in the Conversation for the Participant. |
last_read_timestamp
|
Timestamp of last “read” message in the Conversation for the Participant. |
Add a Conversation Participant (SMS)
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Participants
Adding a new participant to an ongoing conversation immediately allows them to see all subsequent communications. The same person (i.e., a single personal phone number) can be part of any number of conversations concurrently, as long as the address they are in contact with (the ProxyAddress) is unique.
To create a Conversation Participant by SMS, you must enter:
- Their phone number as the
messagingbinding.address - Your Twilio number as the
messagingbinding.proxyaddress.
To create a Conversation Participant by Chat, you must enter the Chat User Identity as the identity parameter.
We recommend following the standard URI specification and avoid the following reserved characters ! * ' ( ) ; : @ & = + $ , / ? % # [ ] for values such as identity and friendly name.
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this participant. |
identity
Optional
|
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 Conversations SDK to communicate. Limited to 256 characters. |
messaging_binding.address
Optional
|
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). |
messaging_binding.proxy_address
Optional
|
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). |
date_created
Optional
|
The date that this resource was created. |
date_updated
Optional
|
The date that this resource was last updated. |
attributes
Optional
|
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_binding.projected_address
Optional
|
The address of the Twilio phone number that is used in Group MMS. Communication mask for the Conversation participant with Identity. |
role_sid
Optional
|
The SID of a conversation-level Role to assign to the participant. |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Example 2
Fetch a ConversationParticipant resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Participants/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this participant. |
sid
Path
|
A 34 character string that uniquely identifies this resource. Alternatively, you can pass a Participant's |
Example 1
You can also fetch a Conversation Participant by their identity. Pass their identity as the value for the sid argument.
Example 2
Read multiple ConversationParticipant resources
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Participants
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for participants. |
Example 1
Update a ConversationParticipant resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Participants/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this participant. |
sid
Path
|
A 34 character string that uniquely identifies this resource. |
date_created
Optional
|
The date that this resource was created. |
date_updated
Optional
|
The date that this resource was last updated. |
attributes
Optional
|
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. |
role_sid
Optional
|
The SID of a conversation-level Role to assign to the participant. |
messaging_binding.proxy_address
Optional
|
The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it. |
messaging_binding.projected_address
Optional
|
The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it. |
identity
Optional
|
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 Conversations SDK to communicate. Limited to 256 characters. |
last_read_message_index
Optional
|
Index of last “read” message in the Conversation for the Participant. |
last_read_timestamp
Optional
|
Timestamp of last “read” message in the Conversation for the Participant. |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Example 2
Delete a ConversationParticipant resource
https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Participants/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
conversation_sid
Path
|
The unique ID of the Conversation for this participant. |
sid
Path
|
A 34 character string that uniquely identifies this resource. |
x_twilio_webhook_enabled
Header
|
The X-Twilio-Webhook-Enabled HTTP request header |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
