メニュー

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?

Invite Resource

An Invite resource for Programmable Chat represents an invitation for a User (within the Service instance) to join a Channel and become a Member.

Invite properties

Each Invite resource contains these properties.

Names in REST API format
sid
sid<IN> Not PII

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

account_sid
sid<AC> Not PII

The SID of the Account that created the Invite resource.

channel_sid
sid<CH> Not PII

The SID of the Channel the Invite resource belongs to.

service_sid
sid<IS> Not PII

The SID of the Service the Invite resource is associated with.

identity
文字列 PII MTL: 120 DAYS

The application-defined string that uniquely identifies the resource's User within the Service. See access tokens for more info.

date_created
date_time<iso8601> Not PII

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

date_updated
date_time<iso8601> Not PII

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

role_sid
sid<RL> Not PII

The SID of the Role assigned to the resource.

created_by
文字列 Not PII

The identity of the User that created the invite.

url
url Not PII

The absolute URL of the Invite resource.

Create an Invite resource

post
https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites

The {ChannelSid} value can be the Channel's sid or its unique_name.

パラメーター
Names in REST API format
service_sid
Path
post sid<IS> Not PII

The SID of the Service to create the Invite resource under.

channel_sid
Path
post sid_like<CH> Not PII

The SID of the Channel the new Invite resource belongs to. This value can be the Channel resource's sid or unique_name.

identity
必須
post 文字列 PII MTL: 120 DAYS

The identity value that uniquely identifies the new resource's User within the Service. See access tokens for more info.

role_sid
オプション
post sid<RL> Not PII

The SID of the Role assigned to the new member.

例 1
        
        
        
        

        Fetch an Invite resource

        GET
        https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}

        The {ChannelSid} value can be the Channel's sid or its unique_name.

        パラメーター
        Names in REST API format
        service_sid
        Path
        GET sid<IS> Not PII

        The SID of the Service to fetch the Invite resource from.

        channel_sid
        Path
        GET sid_like<CH> Not PII

        The SID of the Channel the Invite resource to fetch belongs to. This value can be the Channel resource's sid or unique_name.

        sid
        Path
        GET sid<IN> Not PII

        The SID of the Invite resource to fetch.

        例 1
              
              
              
              

              Read multiple Invite resources

              GET
              https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites

              The {ChannelSid} value can be the Channel's sid or its unique_name.

              パラメーター
              Names in REST API format
              service_sid
              Path
              GET sid<IS> Not PII

              The SID of the Service to read the Invite resources from.

              channel_sid
              Path
              GET sid_like<CH> Not PII

              The SID of the Channel the Invite resources to read belong to. This value can be the Channel resource's sid or unique_name.

              identity
              オプション
              GET string[] PII MTL: 120 DAYS

              The User's identity value of the resources to read. See access tokens for more details.

              例 1
                    
                    
                    
                    

                    Delete an Invite resource

                    削除する
                    https://chat.twilio.com/v2/Services/{ServiceSid}/Channels/{ChannelSid}/Invites/{Sid}

                    The {ChannelSid} value can be the Channel's sid or its unique_name.

                    パラメーター
                    Names in REST API format
                    service_sid
                    Path
                    削除する sid<IS> Not PII

                    The SID of the Service to delete the Invite resource from.

                    channel_sid
                    Path
                    削除する sid_like<CH> Not PII

                    The SID of the Channel the Invite resource to delete belongs to. This value can be the Channel resource's sid or unique_name.

                    sid
                    Path
                    削除する sid<IN> Not PII

                    The SID of the Invite resource to delete.

                    例 1
                          
                          
                          
                          
                          Rate this page:

                          ヘルプが必要ですか?

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