Activities describe the current status of your Workers, which determines whether they are eligible to receive task assignments. Workers are always set to a single Activity.
TaskRouter pre-populates new Workspaces with "Offline", "Unavailable", and "Available" Activities. Add your own Activities to the list to get a more granular understanding of the way your Workers are spending their time!
Each Activity has:
A FriendlyName, which describes the Worker's state in human-readable terms, and
An Availability, which is a boolean that determines whether Workers are available for task assignment. The value cannot be changed after the Activity is created.
If a Worker is performing an Activity that has an availability of "true", it means that Worker is ready to have Tasks assigned to it. If a Worker is set to an Activity with an availability of "false", it means the Worker is not able to accept new Tasks and will not be considered for assignment.
By moving Workers from unavailable to available Activities you signal to TaskRouter that the Worker can be assigned new Tasks. When TaskRouter assigns the Worker a Task, it will automatically move the Worker to an unavailable Activity, so that the Worker is not assigned new Tasks while they are occupied. On completion of their work, the Worker can be moved to an available Activity to begin accepting new Tasks again.
The current Activity for a given Worker is changed in the following operations:
TimeoutActivity
identified by the Workspace. By default this is
Offline
.
DefaultActivity
identified by the Workspace, unless a specific ActivitySid is passed. By default, this is
Offline
.
In addition, a single-tasking Workspace supports two additional automatic state transitions:
ReservationActivity
identified by the TaskQueue that assigns the Worker the Task. By default this is the
Reserved
Activity.
AssignmentActivity
identified by the TaskQueue that assigns the Worker the Task. By default this is the
Busy
Activity.
In a multitasking Workspace, a Worker's state does not automatically update when a Task is assigned or accepted.
Pagination is not supported under this resource. Please avoid usage of the page
query parameter.
account_sid
type: SID<AC>The SID of the Account that created the Activity resource.
^AC[0-9a-fA-F]{32}$
34
34
available
type: booleanWhether 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<date-time>The date and time in GMT when the resource was created specified in ISO 8601 format.
date_updated
type: string<date-time>The date and time in GMT when the resource was last updated specified in ISO 8601 format.
sid
type: SID<WA>The unique string that we created to identify the Activity resource.
^WA[0-9a-fA-F]{32}$
34
34
workspace_sid
type: SID<WS>The SID of the Workspace that contains the Activity.
^WS[0-9a-fA-F]{32}$
34
34
links
type: object<uri-map>POST https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Activities
The maximum amount of Activities allowed for any given Workspace is 100.
WorkspaceSid
type: SID<WS>The SID of the Workspace that the new Activity belongs to.
^WS[0-9a-fA-F]{32}$
34
34
FriendlyName
type: stringRequiredA descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: on-call
, break
, and email
.
Available
type: booleanWhether the Worker should be eligible to receive a Task when it occupies the Activity. A value of true
, 1
, or yes
specifies the Activity is available. All other values specify that it is not. The value cannot be changed after the Activity is created.
GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Activities/{Sid}
WorkspaceSid
type: SID<WS>The SID of the Workspace with the Activity resources to fetch.
^WS[0-9a-fA-F]{32}$
34
34
Sid
type: SID<WA>The SID of the Activity resource to fetch.
^WA[0-9a-fA-F]{32}$
34
34
GET https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Activities
By default, this will return the first 50 Activities. Supply a PageSize parameter to fetch more than 50 Activities. See paging for more information.
WorkspaceSid
type: SID<WS>The SID of the Workspace with the Activity resources to read.
^WS[0-9a-fA-F]{32}$
34
34
Available
type: stringWhether return only Activity resources that are available or unavailable. A value of true
returns only available activities. Values of '1' or yes
also indicate true
. All other values represent false
and return activities that are unavailable.
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0
POST https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Activities/{Sid}
WorkspaceSid
type: SID<WS>The SID of the Workspace with the Activity resources to update.
^WS[0-9a-fA-F]{32}$
34
34
Sid
type: SID<WA>The SID of the Activity resource to update.
^WA[0-9a-fA-F]{32}$
34
34
FriendlyName
type: stringA descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: on-call
, break
, and email
.
DELETE https://taskrouter.twilio.com/v1/Workspaces/{WorkspaceSid}/Activities/{Sid}
WorkspaceSid
type: SID<WS>The SID of the Workspace with the Activity resources to delete.
^WS[0-9a-fA-F]{32}$
34
34
Sid
type: SID<WA>The SID of the Activity resource to delete.
^WA[0-9a-fA-F]{32}$
34
34