メニュー

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?

Usersリソース

Programmable ChatのUserリソースは開発者によって供給されたアイデンティティーによって表される特定のユーザーを表現しています。 Usersは単一のChat Serviceインスタンスに存在します。 UsersはServiceインスタンス内で(アイデンティティーによって)一意である必要があります。

ユーザーレコードは、サービスインスタンス内でロールによってパーミッションを割り当てるために使用され、ユーザーがそのインスタンス内で実行できるアクションと実行できないアクションを決定します。

ユーザーは、クライアントのケイパビリティトークンを使用して、またはユーザーリソース REST API メソッドを使用して、サービスインスタンス内に作成できます。

Serviceインスタンス内において新規のアイデンティティーがChatで発見された場合、新しいUserインスタンスが作成されます。
アイデンティティーが存在する場合、既存のUserレコードがそのセッション/リクエストに使用されます。 これはエンドポイントとアクセストークンに当てはまり、またMembersリソースへのPOSTによるMembersの作成においても同様です。

Usersはまた、UsersリソースへのGET経由でのUser Sidまたはアイデンティティーによっても取得可能です。

プロパティ

各ユーザーに次のプロパティがあります。

Names in Java format
sid
sid<US> Not PII

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

accountSid
sid<AC> Not PII

The SID of the Account that created the User resource.

serviceSid
sid<IS> Not PII

The SID of the Service the resource is associated with.

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.

friendlyName
文字列 PII MTL: 120 DAYS

The string that you assigned to describe the resource.

roleSid
sid<RL> Not PII

The SID of the Role assigned to the user.

identity
文字列 PII MTL: 120 DAYS

The application-defined string that uniquely identifies the resource's User within the Service. This value is often a username or an email address. See access tokens for more info.

isOnline
boolean Not PII

Whether the User is actively connected to the Service instance and online. This value is only returned by Fetch actions that return a single resource and null is always returned by a Read action. This value is null if the Service's reachability_enabled is false, if the User has never been online for the Service instance, even if the Service's reachability_enabled is true.

isNotifiable
boolean Not PII

Whether the User has a potentially valid Push Notification registration (APN or GCM) for the Service instance. If at least one registration exists, true; otherwise false. This value is only returned by Fetch actions that return a single resource and null is always returned by a Read action. This value is null if the Service's reachability_enabled is false, and if the User has never had a notification registration, even if the Service's reachability_enabled is true.

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.

joinedChannelsCount
integer Not PII

このUserがMemberであるChannelの総数です。

links
uri_map Not PII

The absolute URLs of the Channel and Binding resources related to the user.

url
url Not PII

The absolute URL of the User resource.

すべてのユーザーをリストにする

GET /Services/{Service SID}/Users
        
        
        
        

        ユーザーを作成

        POST /Services/{Service SID}/Users
        

        パラメーター

        Names in Java format
        pathServiceSid
        必須
        post sid<IS> Not PII

        The SID of the Service to create the resource under.

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

        The identity value that uniquely identifies the new resource's User within the Service. This value is often a username or email address. See the Identity documentation for more details.

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

        The SID of the Role assigned to the new User.

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

        A valid JSON string that contains application-specific data.

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

        A descriptive string that you create to describe the new resource. This value is often used for display purposes.

              
              
              
              

              ユーザーを取得する

              アイデンティティーで

              GET /Services/{Service SID}/Users/{Identity}
              

              ユーザーSIDで

              GET /Services/{Service SID}/Users/{User SID}
              
                    
                    
                    
                    

                    ユーザーを更新する

                    POST /Services/{Service SID}/Users/{User SID}
                    

                    パラメーター

                    Names in Java format
                    pathServiceSid
                    必須
                    post sid<IS> Not PII

                    The SID of the Service to update the resource from.

                    pathSid
                    必須
                    post sid_like<US> Not PII

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

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

                    The SID of the Role assigned to this user.

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

                    A valid JSON string that contains application-specific data.

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

                    A descriptive string that you create to describe the resource. It is often used for display purposes.

                          
                          
                          
                          

                          ユーザーを削除する

                          DELETE /Services/{Service SID}/Users/{User SID}
                          
                                
                                
                                
                                
                                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.