メニュー

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?

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

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

sessionSid
sid<KC> Not PII

The SID of the parent Session resource.

serviceSid
sid<KS> Not PII

The SID of the resource's parent Service resource.

accountSid
sid<AC> Not PII

The SID of the Account that created the Participant resource.

friendlyName
文字列 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.

identifier
文字列 PII MTL: 30 DAYS

The phone number of the Participant.

proxyIdentifier
文字列 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.

proxyIdentifierSid
sid<PN> Not PII

The SID of the Proxy Identifier assigned to the Participant.

dateDeleted
date_time<iso8601> Not PII

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

dateCreated
date_time<iso8601> Not PII

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

dateUpdated
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
パラメーター
Names in None format
service_sid
必須
post sid<KS> Not PII

The SID of the parent Service resource.

session_sid
必須
post sid<KC> Not PII

The SID of the parent Session resource.

identifier
必須
post 文字列 PII MTL: 30 DAYS

The phone number of the Participant.

friendly_name
オプション
post 文字列 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
オプション
post 文字列 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
オプション
post sid<PN> Not PII

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

例 1
        
        
        
        

        Fetch a Participant resource

        GET
        https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}
        パラメーター
        Names in None format
        service_sid
        必須
        GET sid<KS> Not PII

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

        session_sid
        必須
        GET sid<KC> Not PII

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

        sid
        必須
        GET sid<KP> Not PII

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

              
              
              
              

              Read multiple Participant resources

              GET
              https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants
              パラメーター
              Names in None format
              service_sid
              必須
              GET sid<KS> Not PII

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

              session_sid
              必須
              GET sid<KC> Not PII

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

                    
                    
                    
                    

                    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.

                    Delete a Participant resource

                    削除する
                    https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{Sid}
                    パラメーター
                    Names in None format
                    service_sid
                    必須
                    削除する sid<KS> Not PII

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

                    session_sid
                    必須
                    削除する sid<KC> Not PII

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

                    sid
                    必須
                    削除する sid<KP> Not PII

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

                          
                          
                          
                          
                          Rate this page:

                          ヘルプが必要ですか?

                          誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。