メニュー

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 Role resource of Programmable Chat represents what a user can do within a Chat Service instance. Roles are either Service scoped or Channel scoped.

Users are assigned a role at the Service scope, which determines what they are able to do within the Chat Service instance - e.g. create channels, destroy channels, and more.

メンバーは、チャンネルスコープで、チャンネルごとに、ロールを割り当てられます。これにより、メンバーが特定のチャンネル内で実行できるアクション(チャンネルのメンバーになるようにユーザーを招待する、メッセージを POST する、チャンネルからメンバーを退出させるなど)が決まります。

プロパティ

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

Names in Python format
sid
sid<RL> Not PII

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

account_sid
sid<AC> Not PII

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

service_sid
sid<IS> Not PII

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

friendly_name
文字列 PII MTL: 120 DAYS

このロールの、人間が読みやすい形式の名前です。

type
enum:role_type Not PII

このロールの種類です。channelチャンネルロールの場合)または deploymentサービスロールの場合)のどちらかです。

permissions
string[] Not PII

このロールに付与されているパーミッションの JSON 配列です。付与可能なすべてのパーミッションのリストについては、下記の表をご覧ください。

date_created
date_time<iso8601> Not PII

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

date_updated
date_time<iso8601> Not PII

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

url
url Not PII

このロールの絶対 URL です。

次に、deployment (サービス)ロールに付与可能なすべての permissions エントリのリストを示します。

name description
createChannel 新しいチャンネルを作成することをユーザーに許可します。
joinChannel チャンネルに参加することをユーザーに許可します。
destroyChannel チャンネルを削除することをユーザーに許可します。
inviteMember 他のユーザーをチャンネルのメンバーになるように招待することをユーザーに許可します。
removeMember チャンネルからメンバーを削除することをユーザーに許可します。
editChannelName チャンネルの名前を変更することをユーザーに許可します。
editChannelAttributes チャンネルのオプションの attributes メタデータフィールドを更新することをユーザーに許可します。
addMember 他のユーザーをチャンネルのメンバーとして追加することをユーザーに許可します。
editOwnMessage Allows users to edit their own messages in the Service
editAnyMessage サービス内の任意のメッセージを編集することをユーザーに許可します。
独自のメッセージ属性を編集する Allows users to edit the own message attributes in the Service
editAnyMessageAttributes Allows users to edit any message attributes in the Service
deleteAnyMessage サービス内の任意のメッセージを削除することをユーザーに許可します。
editOwnUserInfo 自身のユーザー情報プロパティを編集することをユーザーに許可します。
editAnyUserInfo 他のユーザーのユーザー情報プロパティを編集することをユーザーに許可します。

次に、channel ロールに付与可能なすべての permissions エントリのリストを示します。

name description
sendMessage チャンネルにメッセージを送信することをユーザーに許可します。
sendMediaMessage Allows the user to send media messages to channels
leaveChannel チャンネルを参加解除することをユーザーに許可します。
destroyChannel チャンネルを削除することをユーザーに許可します。
inviteMember 他のユーザーをチャンネルのメンバーになるように招待することをユーザーに許可します。
removeMember チャンネルからメンバーを削除することをユーザーに許可します。
editChannelName チャンネルの名前を変更することをユーザーに許可します。
editChannelAttributes チャンネルのオプションの attributes メタデータフィールドを更新することをユーザーに許可します。
addMember 他のユーザーをチャンネルのメンバーとして追加することをユーザーに許可します。
editOwnMessage Allows users to edit their own messages in the Service
editAnyMessage サービス内の任意のメッセージを編集することをユーザーに許可します。
独自のメッセージ属性を編集する Allows users to edit the own message attributes in the Service
editAnyMessageAttributes Allows users to edit any message attributes in the Service
deleteOwnMessage Allows user to delete their own messages in the Service
deleteAnyMessage サービス内の任意のメッセージを削除することをユーザーに許可します。
editOwnUserInfo 自身のユーザー情報プロパティを編集することをユーザーに許可します。
editAnyUserInfo 他のユーザーのユーザー情報プロパティを編集することをユーザーに許可します。

すべてのロールをリストにする

GET /Services/{Service SID}/Roles
        
        
        
        

        ロールを作成する

        POST /Services/{Service SID}/Roles
        

        パラメーター

        Names in Python format
        friendly_name
        必須
        post 文字列 PII MTL: 120 DAYS

        このロールの、人間が読みやすい形式の名前です。

        type
        必須
        post enum:role_type Not PII

        このロールの種類です。channelチャンネルロールの場合)または deploymentサービスロールの場合)のどちらかです。

        permission
        必須
        post string[] Not PII

        (複数)このロールに必要なパーミッションです。付与可能なパーミッションのリストについては、上記の表をご覧ください。

              
              
              
              

              ロールを取得する

              GET /Services/{Service SID}/Roles/{Role SID}
              
                    
                    
                    
                    

                    ロールを更新する

                    POST /Services/{Service SID}/Roles/{Role SID}
                    

                    Note: This operation replaces the existing permissions on a Role, to add a permission you must also include any existing permissions in your request.

                    パラメーター

                    Names in Python format
                    permission
                    必須
                    post string[] Not PII

                    (複数)このロールに必要なパーミッションです。付与可能なパーミッションのリストについては、上記の表をご覧ください。

                          
                          
                          
                          

                          ロールを削除する

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