メニュー

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 PHP format
sid
sid<RL> Not PII

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

accountSid
sid<AC> Not PII

The SID of the Account that created the Role resource.

serviceSid
sid<IS> Not PII

The SID of the Service the resource is associated with.

friendlyName
文字列 PII MTL: 120 DAYS

The string that you assigned to describe the resource.

type
enum:role_type Not PII

The type of role. Can be: channel for Channel roles or deployment for Service roles.

permissions
string[] Not PII

An array of the permissions the role has been granted, formatted as a JSON string.

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.

url
url Not PII

The absolute URL of the Role resource.

次に、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 PHP format
        serviceSid
        必須
        post sid<IS> Not PII

        The SID of the Service to create the resource under.

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

        A descriptive string that you create to describe the new resource. It can be up to 64 characters long.

        type
        必須
        post enum:role_type Not PII

        The type of role. Can be: channel for Channel roles or deployment for Service roles.

        permission
        必須
        post string[] Not PII

        A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's type and are described in the documentation.

              
              
              
              

              ロールを取得する

              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 PHP format
                    serviceSid
                    必須
                    post sid<IS> Not PII

                    The SID of the Service to update the resource from.

                    sid
                    必須
                    post sid<RL> Not PII

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

                    permission
                    必須
                    post string[] Not PII

                    A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's type and are described in the documentation.

                          
                          
                          
                          

                          ロールを削除する

                          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.