Skip to content Skip to navigation Skip to topbar

On this page

Task Channel Resource

Task Channels provide a mechanism to separate tasks of different types.

You can specify different concurrent capacity for tasks of each type. For example, one Worker might be able to handle 10 SMS Tasks at any given time, but only a single phone call Task. When MultiTasking is enabled, you can specify the task type by passing the Unique Name or SID of the Task Channel. For details on limitations around the Task Channel Unique Name, see the FAQ on the Multitasking page.

TaskChannel Properties

(warning)

Warning

Task Channel friendlyName and uniqueName values do not support hyphens. Using hyphens may cause a parsing error.

(warning)

Warning

Pagination is not supported under this resource. Please avoid usage of the page query parameter.

Property nameTypeRequiredDescriptionChild properties

accountSidSID<AC>

Optional

The SID of the Account that created the Task Channel resource.

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

dateCreatedstring<date-time>

Optional

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

dateUpdatedstring<date-time>

Optional

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

friendlyNamestring

Optional

The string that you assigned to describe the resource.

sidSID<TC>

Optional

The unique string that we created to identify the Task Channel resource.

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

uniqueNamestring

Optional

An application-defined string that uniquely identifies the Task Channel, such as voice or sms.

workspaceSidSID<WS>

Optional

The SID of the Workspace that contains the Task Channel.

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

channelOptimizedRoutingboolean

Optional

Whether the Task Channel will prioritize Workers that have been idle. When true, Workers that have been idle the longest are prioritized.

urlstring<uri>

Optional

The absolute URL of the Task Channel resource.

linksobject<uri-map>

Optional

The URLs of related resources.

Create a TaskChannel resource

POST https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/TaskChannels

Path parameters

Property nameTypeRequiredPIIDescription

workspaceSidSID<WS>

required

The SID of the Workspace that the new Task Channel belongs to.

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

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

friendlyNamestring

required

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

uniqueNamestring

required

An application-defined string that uniquely identifies the Task Channel, such as voice or sms.

channelOptimizedRoutingboolean

Optional

Whether the Task Channel should prioritize Workers that have been idle. If true, Workers that have been idle the longest are prioritized.

Create a TaskChannel

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createTaskChannel() {
11  const taskChannel = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .taskChannels.create({
14      friendlyName: "FriendlyName",
15      uniqueName: "UniqueName",
16    });
17
18  console.log(taskChannel.accountSid);
19}
20
21createTaskChannel();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "friendly_name": "FriendlyName",
6  "unique_name": "UniqueName",
7  "date_created": "2016-04-14T17:35:54Z",
8  "date_updated": "2016-04-14T17:35:54Z",
9  "channel_optimized_routing": true,
10  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
11  "links": {
12    "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
13  }
14}

Fetch a TaskChannel resource

GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

workspaceSidSID<WS>

required

The SID of the Workspace with the Task Channel to fetch.

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

sidstring

required

The SID of the Task Channel resource to fetch.

Fetch a TaskChannel

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchTaskChannel() {
11  const taskChannel = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .taskChannels("Sid")
14    .fetch();
15
16  console.log(taskChannel.accountSid);
17}
18
19fetchTaskChannel();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "date_created": "2016-04-14T17:35:54Z",
4  "date_updated": "2016-04-14T17:35:54Z",
5  "friendly_name": "Default",
6  "sid": "Sid",
7  "unique_name": "default",
8  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
10  "channel_optimized_routing": true,
11  "links": {
12    "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
13  }
14}

Read multiple TaskChannel resources

GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/TaskChannels

Path parameters

Property nameTypeRequiredPIIDescription

workspaceSidSID<WS>

required

The SID of the Workspace with the Task Channel to read.

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

Query parameters

Property nameTypeRequiredPIIDescription

pageSizeinteger<int64>

Optional

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

Minimum: 1Maximum: 1000

pageinteger

Optional

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

Minimum: 0

pageTokenstring

Optional

The page token. This is provided by the API.

List multiple TaskChannels

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listTaskChannel() {
11  const taskChannels = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .taskChannels.list({ limit: 20 });
14
15  taskChannels.forEach((t) => console.log(t.accountSid));
16}
17
18listTaskChannel();

Response

1{
2  "channels": [
3    {
4      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "date_created": "2016-04-14T17:35:54Z",
6      "date_updated": "2016-04-14T17:35:54Z",
7      "friendly_name": "Default",
8      "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9      "unique_name": "default",
10      "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
11      "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12      "channel_optimized_routing": true,
13      "links": {
14        "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
15      }
16    }
17  ],
18  "meta": {
19    "first_page_url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0",
20    "key": "channels",
21    "next_page_url": null,
22    "page": 0,
23    "page_size": 50,
24    "previous_page_url": null,
25    "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels?PageSize=50&Page=0"
26  }
27}

Update a TaskChannel resource

POST https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

workspaceSidSID<WS>

required

The SID of the Workspace with the Task Channel to update.

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

sidstring

required

The SID of the Task Channel resource to update.

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

friendlyNamestring

Optional

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

channelOptimizedRoutingboolean

Optional

Whether the TaskChannel should prioritize Workers that have been idle. If true, Workers that have been idle the longest are prioritized.

Update a TaskChannel

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateTaskChannel() {
11  const taskChannel = await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .taskChannels("Sid")
14    .update({ friendlyName: "FriendlyName" });
15
16  console.log(taskChannel.accountSid);
17}
18
19updateTaskChannel();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "sid": "Sid",
5  "friendly_name": "FriendlyName",
6  "unique_name": "default",
7  "date_created": "2016-04-14T17:35:54Z",
8  "date_updated": "2016-04-14T17:35:54Z",
9  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
10  "channel_optimized_routing": true,
11  "links": {
12    "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
13  }
14}

Delete a TaskChannel resource

DELETE https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/TaskChannels/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

workspaceSidSID<WS>

required

The SID of the Workspace with the Task Channel to delete.

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

sidstring

required

The SID of the Task Channel resource to delete.

Delete a TaskChannel

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteTaskChannel() {
11  await client.taskrouter.v1
12    .workspaces("WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .taskChannels("Sid")
14    .remove();
15}
16
17deleteTaskChannel();