Skip to content Skip to navigation Skip to topbar

On this page

Role Resource

(error)

Danger

Programmable Chat has been deprecated and is no longer supported. Instead, we'll be focusing on the next generation of chat: Twilio Conversations. Find out more about the EOL process here.

If you're starting a new project, please visit the Conversations Docs to begin. If you've already built on Programmable Chat, please visit our Migration Guide to learn about how to switch.

The Role resource of Programmable Chat represents what a user can do within a Chat Service instance. Roles are scoped to either a Service or a Channel.

Users are assigned a role at the Service scope, which determines what they are can do within the Chat Service instance, such as create and destroy channels.

Members are assigned a role at the Channel scope. This determines what they are able to do within a particular channel, such as invite users to be members of the channel, post messages, and remove members from the channel.

See Permission values for information about the permissions that can be assigned in each scope.

Role Properties

Each Role resource contains these properties.

Property nameTypePIIDescription

sidSID<RL>

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

Pattern: ^RL[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>

The SID of the Account that created the Role resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

service_sidSID<IS>

The SID of the Service the Role resource is associated with.

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

friendly_namestring

PII MTL: 30 days

The string that you assigned to describe the resource.

typeenum<string>

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

Possible values:

channeldeployment

permissionsarray[string]

An array of the permissions the role has been granted.

date_createdstring<date-time>

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring<date-time>

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring<uri>

The absolute URL of the Role resource.

Create a Role resource

POST https://chat.twilio.com/v2/Services/{ServiceSid}/Roles

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<IS>required

The SID of the Service to create the Role resource under.

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Property nameTypeRequiredPIIDescription

FriendlyNamestringrequired

PII MTL: 30 days

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

Typeenum<string>required

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

Possible values:

channeldeployment

Permissionarray[string]required

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.

Create a Role resource

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_22// Download the helper library from https://www.twilio.com/docs/node/install
_22const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_22
_22// Find your Account SID and Auth Token at twilio.com/console
_22// and set the environment variables. See http://twil.io/secure
_22const accountSid = process.env.TWILIO_ACCOUNT_SID;
_22const authToken = process.env.TWILIO_AUTH_TOKEN;
_22const client = twilio(accountSid, authToken);
_22
_22async function createRole() {
_22  const role = await client.chat.v2
_22    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_22    .roles.create({
_22      friendlyName: "FriendlyName",
_22      permission: ["Permission"],
_22      type: "deployment",
_22    });
_22
_22  console.log(role.sid);
_22}
_22
_22createRole();

Output


_16{
_16  "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16  "friendly_name": "FriendlyName",
_16  "type": "deployment",
_16  "permissions": [
_16    "sendMessage",
_16    "leaveChannel",
_16    "editOwnMessage",
_16    "deleteOwnMessage"
_16  ],
_16  "date_created": "2016-03-03T19:47:15Z",
_16  "date_updated": "2016-03-03T19:47:15Z",
_16  "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_16}

Fetch a Role resource

GET https://chat.twilio.com/v2/Services/{ServiceSid}/Roles/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<IS>required

The SID of the Service to fetch the Role resource from.

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<RL>required

The SID of the Role resource to fetch.

Pattern: ^RL[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch a Role resource

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19
_19async function fetchRole() {
_19  const role = await client.chat.v2
_19    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19    .roles("RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19    .fetch();
_19
_19  console.log(role.sid);
_19}
_19
_19fetchRole();

Output


_16{
_16  "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16  "friendly_name": "channel user",
_16  "type": "channel",
_16  "permissions": [
_16    "sendMessage",
_16    "leaveChannel",
_16    "editOwnMessage",
_16    "deleteOwnMessage"
_16  ],
_16  "date_created": "2016-03-03T19:47:15Z",
_16  "date_updated": "2016-03-03T19:47:15Z",
_16  "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_16}

Read multiple Role resources

GET https://chat.twilio.com/v2/Services/{ServiceSid}/Roles

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<IS>required

The SID of the Service to read the Role resources from.

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

Read multiple Role resources

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18// Find your Account SID and Auth Token at twilio.com/console
_18// and set the environment variables. See http://twil.io/secure
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function listRole() {
_18  const roles = await client.chat.v2
_18    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .roles.list({ limit: 20 });
_18
_18  roles.forEach((r) => console.log(r.sid));
_18}
_18
_18listRole();

Output


_29{
_29  "meta": {
_29    "page": 0,
_29    "page_size": 50,
_29    "first_page_url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0",
_29    "previous_page_url": null,
_29    "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles?PageSize=50&Page=0",
_29    "next_page_url": null,
_29    "key": "roles"
_29  },
_29  "roles": [
_29    {
_29      "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29      "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_29      "friendly_name": "channel user",
_29      "type": "channel",
_29      "permissions": [
_29        "sendMessage",
_29        "leaveChannel",
_29        "editOwnMessage",
_29        "deleteOwnMessage"
_29      ],
_29      "date_created": "2016-03-03T19:47:15Z",
_29      "date_updated": "2016-03-03T19:47:15Z",
_29      "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_29    }
_29  ]
_29}

Update a Role resource

POST https://chat.twilio.com/v2/Services/{ServiceSid}/Roles/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<IS>required

The SID of the Service to update the Role resource in.

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<RL>required

The SID of the Role resource to update.

Pattern: ^RL[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Property nameTypeRequiredPIIDescription

Permissionarray[string]required

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. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's type.

Update a Role resource

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19// Find your Account SID and Auth Token at twilio.com/console
_19// and set the environment variables. See http://twil.io/secure
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19
_19async function updateRole() {
_19  const role = await client.chat.v2
_19    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19    .roles("RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19    .update({ permission: ["Permission"] });
_19
_19  console.log(role.sid);
_19}
_19
_19updateRole();

Output


_16{
_16  "sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_16  "friendly_name": "channel user",
_16  "type": "channel",
_16  "permissions": [
_16    "sendMessage",
_16    "leaveChannel",
_16    "editOwnMessage",
_16    "deleteOwnMessage"
_16  ],
_16  "date_created": "2016-03-03T19:47:15Z",
_16  "date_updated": "2016-03-03T19:47:15Z",
_16  "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles/RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
_16}

Delete a Role resource

DELETE https://chat.twilio.com/v2/Services/{ServiceSid}/Roles/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<IS>required

The SID of the Service to delete the Role resource from.

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<RL>required

The SID of the Role resource to delete.

Pattern: ^RL[0-9a-fA-F]{32}$Min length: 34Max length: 34

Delete a Role resource

Node.js

Python

C#

Java

Go

PHP

Ruby

twilio-cli

curl


_17// Download the helper library from https://www.twilio.com/docs/node/install
_17const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_17
_17// Find your Account SID and Auth Token at twilio.com/console
_17// and set the environment variables. See http://twil.io/secure
_17const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17const authToken = process.env.TWILIO_AUTH_TOKEN;
_17const client = twilio(accountSid, authToken);
_17
_17async function deleteRole() {
_17  await client.chat.v2
_17    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_17    .roles("RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_17    .remove();
_17}
_17
_17deleteRole();

Permission Values

Service scope permissions

These are the available permissions entries for roles where type = deployment.

Permission	Enables the user to:
`addMember`	Add other users as members of a channel
`createChannel`	Create new channels
`deleteAnyMessage`	Delete any message in the Service
`destroyChannel`	Delete channels
`editAnyMessage`	Edit any message in the Service
`editAnyMessageAttributes`	Edit any message attributes in the Service
`editAnyUserInfo`	Edit other User's User Info properties
`editChannelAttributes`	Update the optional `attributes` metadata field on a channel
`editChannelName`	Change the name of a channel
`editOwnMessage`	Edit their own messages in the Service
`editOwnMessageAttributes`	Edit the own message attributes in the Service
`editOwnUserInfo`	Edit their own User Info properties
`inviteMember`	Invite other users to be members of a channel
`joinChannel`	Join channels
`removeMember`	Remove members from a channel

Channel scope permissions

These are the available permissions entries for roles where type = channel.

Permission	Enables the user to:
`addMember`	Add other users as members of a channel
`deleteAnyMessage`	Delete any message in the channel
`deleteOwnMessage`	Delete their own messages in the channel
`destroyChannel`	Delete channels
`editAnyMessage`	Edit any message in the channel
`editAnyMessageAttributes`	Edit any message attributes in the channel
`editChannelAttributes`	Update the optional `attributes` metadata field on a channel
`editChannelName`	Change the name of a channel
`editOwnMessage`	Edit their own messages in the channel
`editOwnMessageAttributes`	Edit the own message attributes in the channel
`editOwnUserInfo`	Edit their own User Info properties
`inviteMember`	Invite other users to be members of a channel
`leaveChannel`	Leave a channel
`removeMember`	Remove members from a channel
`sendMediaMessage`	Send media messages to channels
`sendMessage`	Send messages to channels