Sure! Twilio Task Router API is a powerful tool that helps companies efficiently distribute and manage tasks among their workforce. This API enables businesses to create customized workflows, assign tasks to the appropriate individuals based on their skills or availability, and track the progress of each task in real-time. By using Task Router API, companies can improve operational efficiency, increase productivity, and deliver better customer experiences.
components:
schemas:
taskrouter.v1.workspace.activity:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Activity resource.
available:
type: boolean
nullable: true
description: >-
Whether the Worker is eligible to receive a Task when it occupies
the Activity. A value of `true`, `1`, or `yes` indicates the
Activity is available. All other values indicate that it is not. The
value cannot be changed after the Activity is created.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the Activity resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WA[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Activity resource.
workspace_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Workspace that contains the Activity.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Activity resource.
links:
type: object
format: uri-map
nullable: true
taskrouter.v1.workspace.event:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Event resource.
actor_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$
nullable: true
description: The SID of the resource that triggered the event.
actor_type:
type: string
nullable: true
description: The type of resource that triggered the event.
actor_url:
type: string
format: uri
nullable: true
description: The absolute URL of the resource that triggered the event.
description:
type: string
nullable: true
description: A description of the event.
event_data:
nullable: true
description: >-
Data about the event. For more information, see [Event
types](https://www.twilio.com/docs/taskrouter/api/event#event-types).
event_date:
type: string
format: date-time
nullable: true
description: >-
The time the event was sent, specified in [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format.
event_date_ms:
type: integer
format: int64
nullable: true
description: The time the event was sent in milliseconds.
event_type:
type: string
nullable: true
description: The identifier for the event.
resource_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the object the event is most relevant to, such as a
TaskSid, ReservationSid, or a WorkerSid.
resource_type:
type: string
nullable: true
description: >-
The type of object the event is most relevant to, such as a Task,
Reservation, or a Worker).
resource_url:
type: string
format: uri
nullable: true
description: The URL of the resource the event is most relevant to.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^EV[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Event resource.
source:
type: string
nullable: true
description: Where the Event originated.
source_ip_address:
type: string
nullable: true
description: The IP from which the Event originated.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Event resource.
workspace_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Workspace that contains the Event.
taskrouter.v1.workspace.task:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Task resource.
age:
type: integer
nullable: true
description: The number of seconds since the Task was created.
assignment_status:
type: string
$ref: '#/components/schemas/task_enum_status'
nullable: true
description: >-
The current status of the Task's assignment. Can be: `pending`,
`reserved`, `assigned`, `canceled`, `wrapping`, or `completed`.
attributes:
type: string
nullable: true
description: >-
The JSON string with custom attributes of the work. **Note** If this
property has been assigned a value, it will only be displayed in
FETCH action that returns a single resource. Otherwise, it will be
null.
x-twilio:
pii:
handling: sensitive
deleteSla: 30
addons:
type: string
nullable: true
description: >-
An object that contains the
[Add-on](https://www.twilio.com/docs/add-ons) data for all installed
Add-ons.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
task_queue_entered_date:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the Task entered the TaskQueue,
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
priority:
type: integer
nullable: true
description: >-
The current priority score of the Task as assigned to a Worker by
the workflow. Tasks with higher priority values will be assigned
before Tasks with lower values.
reason:
type: string
nullable: true
description: The reason the Task was canceled or completed, if applicable.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WT[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Task resource.
task_queue_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WQ[0-9a-fA-F]{32}$
nullable: true
description: The SID of the TaskQueue.
task_queue_friendly_name:
type: string
nullable: true
description: The friendly name of the TaskQueue.
task_channel_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^TC[0-9a-fA-F]{32}$
nullable: true
description: The SID of the TaskChannel.
task_channel_unique_name:
type: string
nullable: true
description: The unique name of the TaskChannel.
timeout:
type: integer
nullable: true
description: >-
The amount of time in seconds that the Task can live before being
assigned.
workflow_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WW[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Workflow that is controlling the Task.
workflow_friendly_name:
type: string
nullable: true
description: The friendly name of the Workflow that is controlling the Task.
workspace_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Workspace that contains the Task.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Task resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of related resources.
virtual_start_time:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT indicating the ordering for routing of the
Task specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
task_enum_status:
type: string
enum:
- pending
- reserved
- assigned
- canceled
- completed
- wrapping
taskrouter.v1.workspace.task_channel:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the Task Channel resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^TC[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the Task Channel
resource.
unique_name:
type: string
nullable: true
description: >-
An application-defined string that uniquely identifies the Task
Channel, such as `voice` or `sms`.
workspace_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Workspace that contains the Task Channel.
channel_optimized_routing:
type: boolean
nullable: true
description: >-
Whether the Task Channel will prioritize Workers that have been
idle. When `true`, Workers that have been idle the longest are
prioritized.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Task Channel resource.
links:
type: object
format: uri-map
nullable: true
description: The URLs of related resources.
taskrouter.v1.workspace.task_queue:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the TaskQueue resource.
assignment_activity_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Activity to assign Workers when a task is assigned
for them.
assignment_activity_name:
type: string
nullable: true
description: >-
The name of the Activity to assign Workers when a task is assigned
for them.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt)
format.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
x-twilio:
pii:
handling: standard
deleteSla: 30
max_reserved_workers:
type: integer
nullable: true
description: >-
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_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WA[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the Activity to assign Workers once a task is reserved
for them.
reservation_activity_name:
type: string
nullable: true
description: >-
The name of the Activity to assign Workers once a task is reserved
for them.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WQ[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the TaskQueue
resource.
target_workers:
type: string
nullable: true
description: >-
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:
type: string
$ref: '#/components/schemas/task_queue_enum_task_order'
nullable: true
description: >-
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](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo)
to learn more.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the TaskQueue resource.
workspace_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Workspace that contains the TaskQueue.
links:
type: object
format: uri-map
nullable: true
description: The URLs of related resources.
task_queue_enum_task_order:
type: string
enum:
- FIFO
- LIFO
taskrouter.v1.workspace.task_queue.task_queue_bulk_real_time_statistics:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the TaskQueue resource.
workspace_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Workspace that contains the TaskQueue.
task_queue_data:
type: array
items: {}
nullable: true
description: >
The real-time statistics for each requested TaskQueue SID.
`task_queue_data` returns the following attributes:
`task_queue_sid`: The SID of the TaskQueue from which these
statistics were calculated.
`total_available_workers`: The total number of Workers available for
Tasks in the TaskQueue.
`total_eligible_workers`: The total number of Workers eligible for
Tasks in the TaskQueue, regardless of their Activity state.
`total_tasks`: The total number of Tasks.
`longest_task_waiting_age`: The age of the longest waiting Task.
`longest_task_waiting_sid`: The SID of the longest waiting Task.
`tasks_by_status`: The number of Tasks grouped by their current
status.
`tasks_by_priority`: The number of Tasks grouped by priority.
`activity_statistics`: The number of current Workers grouped by
Activity.
task_queue_response_count:
type: integer
nullable: true
description: The number of TaskQueue statistics received in task_queue_data.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the TaskQueue statistics resource.
taskrouter.v1.workspace.task_queue.task_queue_cumulative_statistics:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the TaskQueue resource.
avg_task_acceptance_time:
type: integer
nullable: true
description: The average time in seconds between Task creation and acceptance.
start_time:
type: string
format: date-time
nullable: true
description: >-
The beginning of the interval during which these statistics were
calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
end_time:
type: string
format: date-time
nullable: true
description: >-
The end of the interval during which these statistics were
calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
reservations_created:
type: integer
nullable: true
description: The total number of Reservations created for Tasks in the TaskQueue.
reservations_accepted:
type: integer
nullable: true
description: >-
The total number of Reservations accepted for Tasks in the
TaskQueue.
reservations_rejected:
type: integer
nullable: true
description: >-
The total number of Reservations rejected for Tasks in the
TaskQueue.
reservations_timed_out:
type: integer
nullable: true
description: >-
The total number of Reservations that timed out for Tasks in the
TaskQueue.
reservations_canceled:
type: integer
nullable: true
description: >-
The total number of Reservations canceled for Tasks in the
TaskQueue.
reservations_rescinded:
type: integer
nullable: true
description: The total number of Reservations rescinded.
split_by_wait_time:
nullable: true
description: >-
A list of objects that describe the number of Tasks canceled and
reservations accepted above and below the thresholds specified in
seconds.
task_queue_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WQ[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the TaskQueue from which these statistics were
calculated.
wait_duration_until_accepted:
nullable: true
description: >-
The wait duration statistics (`avg`, `min`, `max`, `total`) for
Tasks accepted while in the TaskQueue. Calculation is based on the
time when the Tasks were created. For transfers, the wait duration
is counted from the moment ***the Task was created***, and not from
when the transfer was initiated.
wait_duration_until_canceled:
nullable: true
description: >-
The wait duration statistics (`avg`, `min`, `max`, `total`) for
Tasks canceled while in the TaskQueue.
wait_duration_in_queue_until_accepted:
nullable: true
description: >-
The relative wait duration statistics (`avg`, `min`, `max`, `total`)
for Tasks accepted while in the TaskQueue. Calculation is based on
the time when the Tasks entered the TaskQueue.
tasks_canceled:
type: integer
nullable: true
description: The total number of Tasks canceled in the TaskQueue.
tasks_completed:
type: integer
nullable: true
description: The total number of Tasks completed in the TaskQueue.
tasks_deleted:
type: integer
nullable: true
description: The total number of Tasks deleted in the TaskQueue.
tasks_entered:
type: integer
nullable: true
description: The total number of Tasks entered into the TaskQueue.
tasks_moved:
type: integer
nullable: true
description: The total number of Tasks that were moved from one queue to another.
workspace_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Workspace that contains the TaskQueue.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the TaskQueue statistics resource.
taskrouter.v1.workspace.task_queue.task_queue_real_time_statistics:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the TaskQueue resource.
activity_statistics:
type: array
items: {}
nullable: true
description: The number of current Workers by Activity.
longest_task_waiting_age:
type: integer
nullable: true
description: The age of the longest waiting Task.
longest_task_waiting_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WT[0-9a-fA-F]{32}$
nullable: true
description: The SID of the longest waiting Task.
longest_relative_task_age_in_queue:
type: integer
nullable: true
description: >-
The relative age in the TaskQueue for the longest waiting Task.
Calculation is based on the time when the Task entered the
TaskQueue.
longest_relative_task_sid_in_queue:
type: string
minLength: 34
maxLength: 34
pattern: ^WT[0-9a-fA-F]{32}$
nullable: true
description: >-
The Task SID of the Task waiting in the TaskQueue the longest.
Calculation is based on the time when the Task entered the
TaskQueue.
task_queue_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WQ[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the TaskQueue from which these statistics were
calculated.
tasks_by_priority:
nullable: true
description: >-
The number of Tasks by priority. For example: `{"0": "10", "99":
"5"}` shows 10 Tasks at priority 0 and 5 at priority 99.
tasks_by_status:
nullable: true
description: >-
The number of Tasks by their current status. For example:
`{"pending": "1", "reserved": "3", "assigned": "2", "completed":
"5"}`.
total_available_workers:
type: integer
nullable: true
description: The total number of Workers available for Tasks in the TaskQueue.
total_eligible_workers:
type: integer
nullable: true
description: >-
The total number of Workers eligible for Tasks in the TaskQueue,
independent of their Activity state.
total_tasks:
type: integer
nullable: true
description: The total number of Tasks.
workspace_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Workspace that contains the TaskQueue.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the TaskQueue statistics resource.
taskrouter.v1.workspace.task_queue.task_queue_statistics:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the TaskQueue resource.
cumulative:
nullable: true
description: An object that contains the cumulative statistics for the TaskQueue.
realtime:
nullable: true
description: An object that contains the real-time statistics for the TaskQueue.
task_queue_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WQ[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the TaskQueue from which these statistics were
calculated.
workspace_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Workspace that contains the TaskQueue.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the TaskQueue statistics resource.
taskrouter.v1.workspace.task_queue.task_queues_statistics:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the TaskQueue resource.
cumulative:
nullable: true
description: >-
An object that contains the cumulative statistics for the
TaskQueues.
realtime:
nullable: true
description: An object that contains the real-time statistics for the TaskQueues.
task_queue_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WQ[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the TaskQueue from which these statistics were
calculated.
workspace_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Workspace that contains the TaskQueues.
taskrouter.v1.workspace.task.task_reservation:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: >-
The SID of the
[Account](https://www.twilio.com/docs/iam/api/account) that created
the TaskReservation resource.
date_created:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was created specified in
[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: >-
The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
reservation_status:
type: string
$ref: '#/components/schemas/task_reservation_enum_status'
nullable: true
description: >-
The current status of the reservation. Can be: `pending`,
`accepted`, `rejected`, or `timeout`.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WR[0-9a-fA-F]{32}$
nullable: true
description: >-
The unique string that we created to identify the TaskReservation
resource.
task_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WT[0-9a-fA-F]{32}$
nullable: true
description: The SID of the reserved Task resource.
worker_name:
type: string
nullable: true
description: The `friendly_name` of the Worker that is reserv
# --- truncated at 32 KB (243 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/task-router-openapi-original.yml