All URIs are relative to https://taskrouter.twilio.com
| Method | HTTP request | Description |
|---|---|---|
| CreateTaskQueue | Post /v1/Workspaces/{WorkspaceSid}/TaskQueues | |
| DeleteTaskQueue | Delete /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid} | |
| FetchTaskQueue | Get /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid} | |
| ListTaskQueue | Get /v1/Workspaces/{WorkspaceSid}/TaskQueues | |
| UpdateTaskQueue | Post /v1/Workspaces/{WorkspaceSid}/TaskQueues/{Sid} |
TaskrouterV1TaskQueue CreateTaskQueue(ctx, WorkspaceSidoptional)
| Name | Type | Description |
|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. |
| WorkspaceSid | string | The SID of the Workspace that the new TaskQueue belongs to. |
Other parameters are passed through a pointer to a CreateTaskQueueParams struct
| Name | Type | Description |
|---|---|---|
| FriendlyName | string | A descriptive string that you create to describe the TaskQueue. For example Support-Tier 1, Sales, or Escalation. |
| TargetWorkers | string | 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. |
| MaxReservedWorkers | int | 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 | string | |
| ReservationActivitySid | string | The SID of the Activity to assign Workers when a task is reserved for them. |
| AssignmentActivitySid | string | The SID of the Activity to assign Workers when a task is assigned to them. |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteTaskQueue(ctx, WorkspaceSidSid)
| Name | Type | Description |
|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. |
| WorkspaceSid | string | The SID of the Workspace with the TaskQueue to delete. |
| Sid | string | The SID of the TaskQueue resource to delete. |
Other parameters are passed through a pointer to a DeleteTaskQueueParams struct
| Name | Type | Description |
|---|
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskrouterV1TaskQueue FetchTaskQueue(ctx, WorkspaceSidSid)
| Name | Type | Description |
|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. |
| WorkspaceSid | string | The SID of the Workspace with the TaskQueue to fetch. |
| Sid | string | The SID of the TaskQueue resource to fetch. |
Other parameters are passed through a pointer to a FetchTaskQueueParams struct
| Name | Type | Description |
|---|
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]TaskrouterV1TaskQueue ListTaskQueue(ctx, WorkspaceSidoptional)
| Name | Type | Description |
|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. |
| WorkspaceSid | string | The SID of the Workspace with the TaskQueue to read. |
Other parameters are passed through a pointer to a ListTaskQueueParams struct
| Name | Type | Description |
|---|---|---|
| FriendlyName | string | The friendly_name of the TaskQueue resources to read. |
| EvaluateWorkerAttributes | string | The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter. |
| WorkerSid | string | The SID of the Worker with the TaskQueue resources to read. |
| Ordering | string | Sorting parameter for TaskQueues |
| PageSize | int | How many resources to return in each list page. The default is 50, and the maximum is 1000. |
| Limit | int | Max number of records to return. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TaskrouterV1TaskQueue UpdateTaskQueue(ctx, WorkspaceSidSidoptional)
| Name | Type | Description |
|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. |
| WorkspaceSid | string | The SID of the Workspace with the TaskQueue to update. |
| Sid | string | The SID of the TaskQueue resource to update. |
Other parameters are passed through a pointer to a UpdateTaskQueueParams struct
| Name | Type | Description |
|---|---|---|
| FriendlyName | string | A descriptive string that you create to describe the TaskQueue. For example Support-Tier 1, Sales, or Escalation. |
| TargetWorkers | string | 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 queue until they are either deleted or moved to another queue. Additional examples on how to describing Worker selection criteria below. |
| ReservationActivitySid | string | The SID of the Activity to assign Workers when a task is reserved for them. |
| AssignmentActivitySid | string | The SID of the Activity to assign Workers when a task is assigned for them. |
| MaxReservedWorkers | int | The maximum number of Workers to create reservations for the assignment of a task while in the queue. Maximum of 50. |
| TaskOrder | string |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]