メニュー

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?

メンバーリソース

The Member resource of Programmable Chat represents the membership of a User within the Service instance to a Channel.

プロパティ

各メンバーに次のプロパティがあります。

Names in PHP format
sid
sid<MB> Not PII

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

accountSid
sid<AC> Not PII

The SID of the Account that created the Member resource.

channelSid
sid<CH> Not PII

The unique ID of the Channel for the member.

serviceSid
sid<IS> Not PII

The SID of the Service the 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.

dateCreated
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in RFC 2822 format.

dateUpdated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

roleSid
sid<RL> Not PII

The SID of the Role assigned to the member.

lastConsumedMessageIndex
integer? Not PII

The index of the last Message in the Channel that the Member has read.

lastConsumptionTimestamp
date_time<iso8601> Not PII

The ISO 8601 timestamp string that represents the date-time of the last Message read event for the Member within the Channel.

url
url Not PII

The absolute URL of the Member resource.

attributes
文字列 PII MTL: 120 DAYS

The JSON string that stores application-specific data. Note If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the attributes have not been set, {} is returned.

チャンネルのすべてのメンバーをリストにする

GET /Services/{Service SID}/Channels/{Channel SID}/Members
Names in PHP format
serviceSid
必須
GET sid<IS> Not PII

The SID of the Service to read the resources from.

channelSid
必須
GET sid_like<CH> Not PII

The unique ID of the Channel the members to read belong to. Can be the Channel resource's sid or unique_name value.

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

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

        
        
        
        

        チャンネルにメンバーを追加する

        POST /Services/{Service SID}/Channels/{Channel SID}/Members
        

        パラメーター

        Names in PHP format
        serviceSid
        必須
        post sid<IS> Not PII

        The SID of the Service to create the resource under.

        channelSid
        必須
        post sid_like<CH> Not PII

        The unique ID of the Channel the new member belongs to. 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 details.

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

        The SID of the Role to assign to the member. The default roles are those specified on the Service.

        lastConsumedMessageIndex
        オプション
        post integer? Not PII

        The index of the last Message in the Channel that the Member has read. This parameter should only be used when recreating a Member from a backup/separate source.

        lastConsumptionTimestamp
        オプション
        post date_time<iso8601> Not PII

        The ISO 8601 timestamp string that represents the date-time of the last Message read event for the Member within the Channel.

        dateCreated
        オプション
        post date_time<iso8601> Not PII

        The date, specified in ISO 8601 format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source.

        dateUpdated
        オプション
        post date_time<iso8601> Not PII

        The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated. The default value is null. Note that this parameter should only be used when a Member is being recreated from a backup/separate source and where a Member was previously updated.

        attributes
        オプション
        post 文字列 PII MTL: 120 DAYS

        A valid JSON string that contains application-specific data.

              
              
              
              

              Update an existing Member

              You are able to update an existing Member via the SID or Identity

              Member SID

              POST /Services/{Service SID}/Channels/{Channel SID}/Members/{Member SID}
              

              Member Identity

              POST /Services/{Service SID}/Channels/{Channel SID}/Members/{Member Identity}
              

              パラメーター

              Names in PHP format
              serviceSid
              必須
              post sid<IS> Not PII

              The SID of the Service to update the resource from.

              channelSid
              必須
              post sid_like<CH> Not PII

              The unique ID of the Channel the member to update belongs to. Can be the Channel resource's sid or unique_name.

              sid
              必須
              post sid_like<MB> Not PII

              The Twilio-provided string that uniquely identifies the Member resource to update.

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

              The SID of the Role to assign to the member. The default roles are those specified on the Service.

              lastConsumedMessageIndex
              オプション
              post integer? Not PII

              The index of the last Message that the Member has read within the Channel.

              lastConsumptionTimestamp
              オプション
              post date_time<iso8601> Not PII

              The ISO 8601 timestamp string that represents the date-time of the last Message read event for the Member within the Channel.

              dateCreated
              オプション
              post date_time<iso8601> Not PII

              The date, specified in ISO 8601 format, to assign to the resource as the date it was created. The default is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source.

              dateUpdated
              オプション
              post date_time<iso8601> Not PII

              The date, specified in ISO 8601 format, to assign to the resource as the date it was last updated. Note that this parameter should only be used when a Member is being recreated from a backup/separate source and where a Member was previously updated.

              attributes
              オプション
              post 文字列 PII MTL: 120 DAYS

              A valid JSON string that contains application-specific data.

              チャンネルメンバーを取得する

              You are able to retrieve an existing Member via the SID or Identity

              Member SID

              GET /Services/{Service SID}/Channels/{Channel SID}/Members/{Member SID}
              

              Member Identity

              GET /Services/{Service SID}/Channels/{Channel SID}/Members/{Member Identity}
              
                    
                    
                    
                    

                    チャンネルからメンバーを削除する

                    You are able to remove an existing Member via the SID or Identity

                    Member SID

                    DELETE /Services/{Service SID}/Channels/{Channel SID}/Members/{Member SID}
                    

                    Member Identity

                    DELETE /Services/{Service SID}/Channels/{Channel SID}/Members/{Member Identity}
                    
                          
                          
                          
                          
                          Rate this page:

                          ヘルプが必要ですか?

                          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.