Menu

Expand
Rate this page:

Participant

A Participant is a single individual communicating in a Session. There is a limit of two Participants per Session.

You can create a Proxy Participant in two ways:

  1. By specifying the private Phone Number of the Participant (Identifier) and relying on Proxy to select an appropriate Phone Number from the Proxy Number pool. The Proxy Number returned (Proxy Identifier) is the Phone Number that the Participant should call to reach the other party.
  2. By specifying both the Identifier and the Proxy Identifier. In this case, Proxy will attempt to use the Twilio Phone Number provided. Note: The Twilio Phone Number specified must already be added to the Proxy Number pool in order to be accepted.

Participant properties

Resource Properties in REST API format
sid
sid<KP> Not PII

The unique string that we created to identify the Participant resource.

session_sid
sid<KC> Not PII

The SID of the parent Session resource.

service_sid
sid<KS> Not PII

The SID of the resource's parent Service resource.

account_sid
sid<AC> Not PII

The SID of the Account that created the Participant resource.

friendly_name
string Not PII

The string that you assigned to describe the participant. This value must be 255 characters or fewer. Supports UTF-8 characters. This value should not have PII.

identifier

The phone number or channel identifier of the Participant. This value must be 191 characters or fewer. Supports UTF-8 characters.

proxy_identifier
string Not PII

The phone number or short code (masked number) of the participant's partner. The participant will call or message the partner participant at this number.

proxy_identifier_sid
sid<PN> Not PII

The SID of the Proxy Identifier assigned to the Participant.

date_deleted
date_time<iso8601> Not PII

The ISO 8601 date when the Participant was removed from the session.

date_created
date_time<iso8601> Not PII

The ISO 8601 date and time in GMT when the resource was created.

date_updated
date_time<iso8601> Not PII

The ISO 8601 date and time in GMT when the resource was last updated.

url
url Not PII

The absolute URL of the Participant resource.

links
uri_map Not PII

The URLs to resources related the participant.

Create a Participant resource

post
https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants
Parameters
Parameters in REST API format
service_sid
Path
post sid<KS> Not PII

The SID of the parent Service resource.

session_sid
Path
post sid<KC> Not PII

The SID of the parent Session resource.

identifier
Required
post string PII MTL: 30 DAYS

The phone number of the Participant.

friendly_name
Optional
post string Not PII

The string that you assigned to describe the participant. This value must be 255 characters or fewer. This value should not have PII.

proxy_identifier
Optional
post string Not PII

The proxy phone number to use for the Participant. If not specified, Proxy will select a number from the pool.

proxy_identifier_sid
Optional
post sid<PN> Not PII

The SID of the Proxy Identifier to assign to the Participant.

fail_on_participant_conflict
Optional
post boolean Not PII

[Experimental] For accounts with the ProxyAllowParticipantConflict account flag, setting to true enables per-request opt-in to allowing Proxy to reject a Participant create request that could cause the same Identifier/ProxyIdentifier pair to be active in multiple Sessions. Depending on the context, this could be a 409 error (Twilio error code 80623) or a 400 error (Twilio error code 80604). If not provided, requests will be allowed to succeed and a Debugger notification (80802) will be emitted. Having multiple, active Participants with the same Identifier/ProxyIdentifier pair causes calls and messages from affected Participants to be routed incorrectly. Please note, the default behavior for accounts without the ProxyAllowParticipantConflict flag is to reject the request as described. This will eventually be the default for all accounts.

Example 1
        
        
        
        

        Fetch a Participant resource

        get
        https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}
        Parameters
        Parameters in REST API format
        service_sid
        Path
        get sid<KS> Not PII

        The SID of the parent Service of the resource to fetch.

        session_sid
        Path
        get sid<KC> Not PII

        The SID of the parent Session of the resource to fetch.

        sid
        Path
        get sid<KP> Not PII

        The Twilio-provided string that uniquely identifies the Participant resource to fetch.

        Example 1
              
              
              
              

              Read multiple Participant resources

              get
              https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants
              Parameters
              Parameters in REST API format
              service_sid
              Path
              get sid<KS> Not PII

              The SID of the parent Service of the resources to read.

              session_sid
              Path
              get sid<KC> Not PII

              The SID of the parent Session of the resources to read.

              Update a Participant

              In order to add a new Participant in a Session, you can DELETE an existing Participant and then add a new one.

              Adding a participant that was removed is not possible.

              Proxy will return with error 80612 if the new participant's identifier matches the DELETEd participant's identifier.

              Example 1
                    
                    
                    
                    

                    Delete a Participant resource

                    delete
                    https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}
                    Parameters
                    Parameters in REST API format
                    service_sid
                    Path
                    delete sid<KS> Not PII

                    The SID of the parent Service of the resource to delete.

                    session_sid
                    Path
                    delete sid<KC> Not PII

                    The SID of the parent Session of the resource to delete.

                    sid
                    Path
                    delete sid<KP> Not PII

                    The Twilio-provided string that uniquely identifies the Participant resource to delete.

                    Example 1
                          
                          
                          
                          
                          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.

                                
                                
                                

                                Thank you for your feedback!

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

                                Sending your feedback...
                                🎉 Thank you for your feedback!
                                Something went wrong. Please try again.

                                Thanks for your feedback!

                                Refer us and get $10 in 3 simple steps!

                                Step 1

                                Get link

                                Get a free personal referral link here

                                Step 2

                                Give $10

                                Your user signs up and upgrade using link

                                Step 3

                                Get $10

                                1,250 free SMSes
                                OR 1,000 free voice mins
                                OR 12,000 chats
                                OR more