Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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.

ConversationParticipant properties

Resource Properties in REST API format
account_sid
sid<AC> Not PII

The unique id of the Account responsible for this participant.

conversation_sid
sid<CH> Not PII

The unique id of the Conversation for this participant.

sid
sid<MB> Not PII

A 34 character string that uniquely identifies this resource.

identity

A unique string identifier for the conversation participant as Chat User. This parameter is non-null if (and only if) the participant is using the Programmable Chat 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
sid<RL> Not PII

The SID of the Role to assign to the participant.

date_created
date_time<iso8601> Not PII

The date that this resource was created.

date_updated
date_time<iso8601> Not PII

The date that this resource was last updated.

url
url Not PII

An absolute URL for this participant.

Add a Conversation Participant (SMS)

post
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:

  1. Their phone number as the messagingbinding.address
  2. 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.

Parameters
Parameters in REST API format
conversation_sid
Path
post sid<CH> Not PII

The unique id of the Conversation for this participant.

identity
Optional
post string PII MTL: 120 DAYS

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

messaging_binding.address
Optional
post string Not PII

The address of the participant's device, e.g. a phone number or Messenger ID. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from a Chat endpoint (see the 'identity' field).

messaging_binding.proxy_address
Optional
post string Not PII

The address of the Twilio phone number (or WhatsApp number, or Messenger Page ID) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from a Chat endpoint (see the 'identity' field).

date_created
Optional
post date_time<iso8601> Not PII

The date that this resource was created.

date_updated
Optional
post date_time<iso8601> Not PII

The date that this resource was last updated.

attributes
Optional
post string PII MTL: 120 DAYS

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
post string Not PII

The address of the Twilio phone number that is used in Group MMS. Communication mask for the Chat participant with Identity.

role_sid
Optional
post sid<RL> Not PII

The SID of the Role to assign to the participant.

Example 1
        
        
        
        
        Connect someone to a Conversation over SMS

        Create Conversation Participant (SMS)

        Connect someone to a Conversation over SMS
        Example 2
              
              
              
              
              Connect someone to a Conversation over Chat

              Create Conversation Participant (Chat)

              Connect someone to a Conversation over Chat

              Fetch a ConversationParticipant resource

              get
              https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Participants/{Sid}
              Parameters
              Parameters in REST API format
              conversation_sid
              Path
              get sid<CH> Not PII

              The unique id of the Conversation for this participant.

              sid
              Path
              get sid<MB> Not PII

              A 34 character string that uniquely identifies this resource.

              Example 1
                    
                    
                    
                    
                    Fetch a Conversation Participant by SID

                    Fetch Conversation Participant

                    Fetch a Conversation Participant by SID

                    Read multiple ConversationParticipant resources

                    get
                    https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Participants
                    Parameters
                    Parameters in REST API format
                    conversation_sid
                    Path
                    get sid<CH> Not PII

                    The unique id of the Conversation for participants.

                    Example 1
                          
                          
                          
                          

                          Update a ConversationParticipant resource

                          post
                          https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Participants/{Sid}
                          Parameters
                          Parameters in REST API format
                          conversation_sid
                          Path
                          post sid<CH> Not PII

                          The unique id of the Conversation for this participant.

                          sid
                          Path
                          post sid<MB> Not PII

                          A 34 character string that uniquely identifies this resource.

                          date_created
                          Optional
                          post date_time<iso8601> Not PII

                          The date that this resource was created.

                          date_updated
                          Optional
                          post date_time<iso8601> Not PII

                          The date that this resource was last updated.

                          attributes
                          Optional
                          post string PII MTL: 120 DAYS

                          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
                          post sid<RL> Not PII

                          The SID of the Role to assign to the participant.

                          messaging_binding.proxy_address
                          Optional
                          post string Not PII

                          The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it.

                          messaging_binding.projected_address
                          Optional
                          post string Not PII

                          The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it.

                          Example 1
                                
                                
                                
                                
                                Update Conversation Participant by SID

                                Update Conversation Participant

                                Update Conversation Participant by SID
                                Example 2
                                      
                                      
                                      
                                      

                                      Delete a ConversationParticipant resource

                                      delete
                                      https://conversations.twilio.com/v1/Conversations/{ConversationSid}/Participants/{Sid}
                                      Parameters
                                      Parameters in REST API format
                                      conversation_sid
                                      Path
                                      delete sid<CH> Not PII

                                      The unique id of the Conversation for this participant.

                                      sid
                                      Path
                                      delete sid<MB> Not PII

                                      A 34 character string that uniquely identifies this resource.

                                      Example 1
                                            
                                            
                                            
                                            
                                            Delete a Conversation Participant by SID

                                            Delete Conversation Participant

                                            Delete a Conversation Participant by SID
                                            Rate this page:

                                            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 browsing the Twilio tag on Stack Overflow.