Menu

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?

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

Names in PHP format
sid
sid<KP> Not PII

A 34 character string that uniquely identifies this Participant.

sessionSid
sid<KC> Not PII

The unique SID identifier of the parent Session.

serviceSid
sid<KS> Not PII

The unique SID identifier of the parent Service.

accountSid
sid<AC> Not PII

The unique SID identifier of the Account.

friendlyName
string Not PII

A human-readable description of this resource, up to 64 characters. Should not include PII.

identifier

The phone number of this Participant.

proxyIdentifier
string Not PII

The actual phone number or short code (aka masked number). This is the number the participant will call/message to reach the partner participant.

proxyIdentifierSid
sid<PN> Not PII

The unique SID identifier of the Proxy Identifier assigned to this Participant.

dateDeleted
date_time<iso8601> Not PII

The date that this Participant was removed from the session, given in ISO 8601 format.

dateCreated
date_time<iso8601> Not PII

The date that this Participant was created, given in ISO 8601 format.

dateUpdated
date_time<iso8601> Not PII

The date that this Participant was last updated, given in ISO 8601 format.

url
url Not PII

The URL of this resource.

links
uri_map Not PII

Contains a dictionary of URL links to nested resources of this Participant.

Create a Participant resource

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

The unique SID identifier of the parent Service.

session_sid
Required
post sid<KC> Not PII

The unique SID identifier of the parent Session.

identifier
Required
post string PII MTL: 30 DAYS

The phone number of this Participant.

friendly_name
Optional
post string Not PII

A human-readable description of this resource, up to 64 characters. Should not include PII.

proxy_identifier
Optional
post string Not PII

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

Example 1
        
        
        
        

        Fetch a Participant resource

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

        The unique SID identifier of the parent Service.

        session_sid
        Required
        get sid<KC> Not PII

        The unique SID identifier of the parent Session.

        sid
        Required
        get sid<KP> Not PII

        A 34 character string that uniquely identifies this Participant.

        Example
              
              
              
              

              Read multiple Participant resources

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

              The unique SID identifier of the parent Service.

              session_sid
              Required
              get sid<KC> Not PII

              The unique SID identifier of the parent Session.

              Example
                    
                    
                    
                    

                    Update a Participant

                    Participants cannot be changed once added. To add a new Participant, delete a Participant and add a new one. Note that you may not add a participant with the same identifier as a previously removed participant.

                    Delete a Participant resource

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

                    The unique SID identifier of the parent Service.

                    session_sid
                    Required
                    delete sid<KC> Not PII

                    The unique SID identifier of the parent Session.

                    sid
                    Required
                    delete sid<KP> Not PII

                    A 34 character string that uniquely identifies this Participant.

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