メニュー

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 Ruby format
sid
sid<US> Not PII

このリソースを一意に識別する 34 文字の文字列です。

account_sid
sid<AC> Not PII

このユーザーに関連するアカウントのユニーク ID です。

service_sid
sid<IS> Not PII

このユーザーが属するサービスのユニーク ID です。

attributes
文字列 PII MTL: 120 DAYS

An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.

friendly_name
文字列 PII MTL: 120 DAYS

このユーザーの人間の判読できる名前です。 オプションです。

role_sid
sid<RL> Not PII

このユーザーに割り当てられた[Role][role]の一意なIDです。

identity
文字列 PII MTL: 120 DAYS

サービス内でこのユーザーを識別するユニークな文字列です。通常は、ユーザー名またはメールアドレスを使用します。詳細については、アイデンティティに関するドキュメントを参照してください。

is_online
boolean Not PII

ユーザーが現在Serviceインスタンスに接続されてオンラインかどうかを表します。 オンラインの場合はtrue、そうでない場合はfalseです。 LIST GET操作によって返されるリソースは常にnullとなりますが、単一のGET操作には存在する点にご注意ください。 もしServiceインスタンスでReachabilityが有効でない場合はnullを返す点にご注意ください。 Reachabilityが有効であっても、Serviceインスタンス内で一度もオンラインになったことがないUsersに対してはnullとなる点にご注意ください。

is_notifiable
boolean Not PII

UserがServiceインスタンス内で有効なプッシュ通知登録(APNまたはGCM)があるかどうかを表します。 1つ以上の登録がある場合はtrue、そうでない場合はfalseです。 LIST GET操作によって返されるリソースは常にnullとなりますが、単一のGET操作には存在する点にご注意ください。 もしServiceインスタンスでReachabilityが有効でない場合はnullを返す点にご注意ください。 Reachabilityが有効であっても、Serviceインスタンス内で一度もオンラインになったことがないUsersに対してはnullとなる点にご注意ください。

date_created
date_time<iso8601> Not PII

リソースが生成された日時。ISO 8601 フォーマットで提供。

date_updated
date_time<iso8601> Not PII

リソースが最後に更新された日時。ISO 8601 フォーマットで提供。

joined_channels_count
integer Not PII

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

links
uri_map Not PII

url
url Not PII

このユーザーの絶対 URL です。

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

GET /Services/{Service SID}/Users
        
        
        
        

        ユーザーを作成

        POST /Services/{Service SID}/Users
        

        パラメーター

        Names in Ruby format
        service_sid
        必須
        post sid<IS> Not PII

        Sid of the Service this user belongs to.

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

        サービス内でこのユーザーを識別するユニークな文字列です。通常は、ユーザー名またはメールアドレスを使用します。 詳細については、[identity][identity]ドキュメントを参照してください。

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

        このユーザーに割り当てられているロールのユニーク ID です。

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

        Userについての任意のメタデータや他の情報の格納に使用される、オプションの文字列です。 指定する場合は、文字列は構造的に有効なJSONである必要があります。

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

        ユーザーを表す、オプションの人間が判読できる文字列です。 しばしば表示目的に使用されます。

              
              
              
              

              ユーザーを取得する

              アイデンティティーで

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

              ユーザーSIDで

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

                    ユーザーを更新する

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

                    パラメーター

                    Names in Ruby format
                    service_sid
                    必須
                    post sid<IS> Not PII

                    Sid of the Service this user belongs to.

                    sid
                    必須
                    post sid_like<US> Not PII

                    Key that uniquely defines the user to update. Could be Sid or Identity.

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

                    このユーザーに割り当てられた[Role][role]の一意なIDです。

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

                    Userについての任意のメタデータや他の情報の格納に使用される、オプションの文字列です。 指定する場合は、文字列は構造的に有効なJSONである必要があります。

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

                    ユーザーを表す、オプションの人間が判読できる文字列です。 しばしば表示目的に使用されます。

                          
                          
                          
                          

                          ユーザーを削除する

                          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.