Create task channel

POST /v1/Workspaces/{WorkspaceSid}/TaskChannels

Account sid auth token

Types of tasks

Path parameters

WorkspaceSid string Required

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

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

application/x-www-form-urlencoded

Body

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.
ChannelOptimizedRouting boolean

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

Responses

201 application/json

Created
Hide headers attributes Show headers attributes
- X-Rate-Limit-Limit string
- X-Rate-Limit-Remaining string
- X-Rate-Limit-Config string
- Access-Control-Allow-Origin string
  
  Specify the origin(s) allowed to access the resource
- Access-Control-Allow-Methods string
  
  Specify the HTTP methods allowed when accessing the resource
- Access-Control-Allow-Headers string
  
  Specify the headers allowed when accessing the resource
- Access-Control-Allow-Credentials boolean
  
  Indicates whether the browser should include credentials
- Access-Control-Expose-Headers string
  
  Headers exposed to the client
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that created the Task Channel resource.
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- date_created string(date-time) | null
  
  The date and time in GMT when the resource was created specified in ISO 8601 format.
- date_updated string(date-time) | null
  
  The date and time in GMT when the resource was last updated specified in ISO 8601 format.
- friendly_name string | null
  
  The string that you assigned to describe the resource.
- sid string | null
  
  The unique string that we created to identify the Task Channel 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, such as voice or sms.
- 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}$.
- channel_optimized_routing boolean | null
  
  Whether the Task Channel will prioritize Workers that have been idle. When true, Workers that have been idle the longest are prioritized.
- url string(uri) | null
  
  The absolute URL of the Task Channel resource.
- links object(uri-map) | null
  
  The URLs of related resources.

POST /v1/Workspaces/{WorkspaceSid}/TaskChannels

curl \
 --request POST 'https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/TaskChannels' \
 --user "username:password" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'UniqueName=ovoice&FriendlyName=Outbound+Voice&RequiredAttention=0'

Request example

{"UniqueName"=>"ovoice", "FriendlyName"=>"Outbound Voice", "RequiredAttention"=>0}

Response examples (201)

{
  "sid": "TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskChannels/TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "links": {
    "workspace": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "unique_name": "ovoice",
  "date_created": "2016-04-14T17:35:54Z",
  "date_updated": "2016-04-14T17:35:54Z",
  "friendly_name": "Outbound Voice",
  "workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "channel_optimized_routing": true
}