TWtwilio
TaskrouterV1TaskQueue

Changed on
post/v1/Workspaces/{WorkspaceSid}/TaskQueues

Request

  • Base URL
    https://taskrouter.twilio.com
  • URL
    https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/TaskQueues
  • Auth
    HTTP basic

Path parameters

WorkspaceSidstring required

The SID of the Workspace that the new TaskQueue belongs to.

Request body application/x-www-form-urlencoded

FriendlyNamestring required

A descriptive string that you create to describe the TaskQueue. For example Support-Tier 1, Sales, or Escalation.

TargetWorkersstring

A string that describes the Worker selection criteria for any Tasks that enter the TaskQueue. For example, '"language" == "spanish"'. The default value is 1==1. If this value is empty, Tasks will wait in the TaskQueue until they are deleted or moved to another TaskQueue. For more information about Worker selection, see Describing Worker selection criteria.

MaxReservedWorkersinteger

The maximum number of Workers to reserve for the assignment of a Task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.

TaskOrder'FIFO' | 'LIFO'

How Tasks will be assigned to Workers. Set this parameter to LIFO to assign most recently created Task first or FIFO to assign the oldest Task. Default is FIFO. Click here to learn more.

ReservationActivitySidstring

The SID of the Activity to assign Workers when a task is reserved for them.

AssignmentActivitySidstring

The SID of the Activity to assign Workers when a task is assigned to them.

Response

Created

account_sidstring nullable

The SID of the Account that created the TaskQueue resource.

assignment_activity_sidstring nullable

The SID of the Activity to assign Workers when a task is assigned for them.

assignment_activity_namestring nullable

The name of the Activity to assign Workers when a task is assigned for them.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in RFC 2822 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

friendly_namestring nullable

The string that you assigned to describe the resource.

max_reserved_workersinteger

The maximum number of Workers to reserve for the assignment of a task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.

reservation_activity_sidstring nullable

The SID of the Activity to assign Workers once a task is reserved for them.

reservation_activity_namestring nullable

The name of the Activity to assign Workers once a task is reserved for them.

sidstring nullable

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

target_workersstring nullable

A string describing the Worker selection criteria for any Tasks that enter the TaskQueue. For example '"language" == "spanish"' If no TargetWorkers parameter is provided, Tasks will wait in the TaskQueue until they are either deleted or moved to another TaskQueue. Additional examples on how to describing Worker selection criteria below. Defaults to 1==1.

task_order'FIFO' | 'LIFO'

How Tasks will be assigned to Workers. Set this parameter to LIFO to assign most recently created Task first or FIFO to assign the oldest Task. Default is FIFO. Click here to learn more.

urlstring uri nullable

The absolute URL of the TaskQueue resource.

workspace_sidstring nullable

The SID of the Workspace that contains the TaskQueue.

linksobject nullable

The URLs of related resources.

Changes