Create task channel

POST /v1/Workspaces/{WorkspaceSid}/TaskChannels

Types of tasks

Path parameters

  • WorkspaceSid string Required

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

Body

  • ChannelOptimizedRouting boolean

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

  • FriendlyName string Required

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

  • UniqueName string Required

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

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • channel_optimized_routing boolean | null

      Whether the Task Channel will prioritize Workers that have been idle

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • friendly_name string | null

      The string that you assigned to describe the resource

    • links object(uri-map) | null

      The URLs of related resources

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^TC[0-9a-fA-F]{32}$.

    • unique_name string | null

      An application-defined string that uniquely identifies the Task Channel

    • url string(uri) | null

      The absolute URL of the Task Channel resource

    • workspace_sid string | null

      The SID of the Workspace that contains the Task Channel

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.
POST /v1/Workspaces/{WorkspaceSid}/TaskChannels 
curl \
 -X POST https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/TaskChannels \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'ChannelOptimizedRouting=true&FriendlyName=string&UniqueName=string'
Request example 
{
  "ChannelOptimizedRouting": true,
  "FriendlyName": "string",
  "UniqueName": "string"
}
Request examples 
{
  "ChannelOptimizedRouting": true,
  "FriendlyName": "string",
  "UniqueName": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "channel_optimized_routing": true,
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com",
  "workspace_sid": "string"
}
Response examples (201) 
{
  "account_sid": "string",
  "channel_optimized_routing": true,
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "friendly_name": "string",
  "links": {},
  "sid": "string",
  "unique_name": "string",
  "url": "https://example.com",
  "workspace_sid": "string"
}