com.twilio.sdk

Class TwilioTaskRouterClient

java.lang.Object

com.twilio.sdk.TwilioClient

com.twilio.sdk.TwilioTaskRouterClient

public class TwilioTaskRouterClient
extends TwilioClient

The client class that access http://taskrouter.twilio.com.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VERSION

Constructor Summary

Constructors

Constructor and Description
TwilioTaskRouterClient(String accountSid, String authToken)
TwilioTaskRouterClient(String accountSid, String authToken, String endpoint)

Method Summary

Modifier and Type	Method and Description
Activity	createActivity(String workspaceSid, Map<String,String> properties) Create an Activity.
Task	createTask(String workspaceSid, Map<String,String> properties) Create an Task.
TaskQueue	createTaskQueue(String workspaceSid, Map<String,String> properties) Create an TaskQueue.
Worker	createWorker(String workspaceSid, Map<String,String> properties) Create an Worker.
Workflow	createWorkflow(String workspaceSid, Map<String,String> properties) Create an Workflow.
Workspace	createWorkspace(Map<String,String> properties) Create a Workspace.
boolean	deleteActivity(String workspaceSid, String activitySid) Deletes an activity.
boolean	deleteTask(String workspaceSid, String taskSid) Deletes a task.
boolean	deleteTaskQueue(String workspaceSid, String queueSid) Deletes a queue.
boolean	deleteWorker(String workspaceSid, String workerSid) Deletes a worker.
boolean	deleteWorkflow(String workspaceSid, String workflowSid) Deletes a workflow.
boolean	deleteWorkspace(String sid) Deletes a workspace.
ActivityList	getActivities(String workspaceSid) Get the activities.
ActivityList	getActivities(String workspaceSid, Map<String,String> filters) Get the activities.
Activity	getActivity(String workspaceSid, String activitySid) Get an activity instance by sid.
Event	getEvent(String workspaceSid, String eventSid) Get an event instance by sid.
EventList	getEvents(String workspaceSid) Get the events.
EventList	getEvents(String workspaceSid, Map<String,String> filters) Get the events.
TaskQueueListStatistics	getQueuesStatistics(String workspaceSid) Get queues statistics.
TaskQueueListStatistics	getQueuesStatistics(String workspaceSid, Map<String,String> filters) Get queues statistics.
TaskQueueStatistics	getQueueStatistics(String workspaceSid, String queueSid) Get a queue statistics.
TaskQueueStatistics	getQueueStatistics(String workspaceSid, String queueSid, Map<String,String> filters) Get a queue statistics.
Reservation	getReservation(String workspaceSid, String taskSid, String reservationSid) Get a reservation instance by sid.
ReservationList	getReservations(String workspaceSid, String taskSid) Get the reservations.
ReservationList	getReservations(String workspaceSid, String taskSid, Map<String,String> filters) Get the reservations.
Task	getTask(String workspaceSid, String taskSid) Get a task instance by sid.
TaskQueue	getTaskQueue(String workspaceSid, String queueSid) Get a queue instance by sid.
TaskQueueList	getTaskQueues(String workspaceSid) Get the queues.
TaskQueueList	getTaskQueues(String workspaceSid, Map<String,String> filters) Get the queues.
TaskList	getTasks(String workspaceSid) Get the tasks.
TaskList	getTasks(String workspaceSid, Map<String,String> filters) Get the tasks.
Worker	getWorker(String workspaceSid, String workerSid) Get a worker instance by sid.
WorkerList	getWorkers(String workspaceSid) Get the workers.
WorkerList	getWorkers(String workspaceSid, Map<String,String> filters) Get the workers.
WorkersStatistics	getWorkersStatistics(String workspaceSid) Get workers statistics.
WorkersStatistics	getWorkersStatistics(String workspaceSid, Map<String,String> filters) Get workers statistics.
WorkerStatistics	getWorkerStatistics(String workspaceSid, String workerSid) Get worker statistics.
WorkerStatistics	getWorkerStatistics(String workspaceSid, String workerSid, Map<String,String> filters) Get worker statistics.
Workflow	getWorkflow(String workspaceSid, String workflowSid) Get a workflow instance by sid.
WorkflowList	getWorkflows(String workspaceSid) Get the workflows.
WorkflowList	getWorkflows(String workspaceSid, Map<String,String> filters) Get the workflows.
WorkflowStatistics	getWorkflowStatistics(String workspaceSid, String workflowSid) Get workflow statistics.
WorkflowStatistics	getWorkflowStatistics(String workspaceSid, String workflowSid, Map<String,String> filters) Get workflow statistics.
Workspace	getWorkspace(String sid) Get a workspace instance by sid
WorkspaceList	getWorkspaces() Get the workspaces.
WorkspaceList	getWorkspaces(Map<String,String> filters) Get the workspaces.
WorkspaceStatistics	getWorkspaceStatistics(String workspaceSid) Get workspace statistics.
WorkspaceStatistics	getWorkspaceStatistics(String workspaceSid, Map<String,String> filters) Get workspace statistics.

Methods inherited from class com.twilio.sdk.TwilioClient

get, getAccountSid, getEndpoint, getHttpClient, getNumRetries, request, request, requestStream, requestStream, safeRequest, safeRequest, setHttpClient, setNumRetries

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_VERSION

public static final String DEFAULT_VERSION

See Also:

Constant Field Values

Constructor Detail

TwilioTaskRouterClient

public TwilioTaskRouterClient(String accountSid,
                              String authToken)

TwilioTaskRouterClient

public TwilioTaskRouterClient(String accountSid,
                              String authToken,
                              String endpoint)

Method Detail

createActivity

public Activity createActivity(String workspaceSid,
                               Map<String,String> properties)
                        throws TwilioRestException

Create an Activity.

Parameters:

properties - activity properties

Returns:

created activity

Throws:

TwilioRestException

createTaskQueue

public TaskQueue createTaskQueue(String workspaceSid,
                                 Map<String,String> properties)
                          throws TwilioRestException

Create an TaskQueue.

Parameters:

properties - queue properties

Returns:

created queue

Throws:

TwilioRestException

createTask

public Task createTask(String workspaceSid,
                       Map<String,String> properties)
                throws TwilioRestException

Create an Task.

Parameters:

properties - task properties

Returns:

created task

Throws:

TwilioRestException

createWorker

public Worker createWorker(String workspaceSid,
                           Map<String,String> properties)
                    throws TwilioRestException

Create an Worker.

Parameters:

properties - task properties

Returns:

created worker

Throws:

TwilioRestException

createWorkflow

public Workflow createWorkflow(String workspaceSid,
                               Map<String,String> properties)
                        throws TwilioRestException

Create an Workflow.

Parameters:

properties - task properties

Returns:

created workflow

Throws:

TwilioRestException

createWorkspace

public Workspace createWorkspace(Map<String,String> properties)
                          throws TwilioRestException

Create a Workspace.

Parameters:

properties - workspace properties

Returns:

created workspace

Throws:

TwilioRestException

deleteActivity

public boolean deleteActivity(String workspaceSid,
                              String activitySid)
                       throws TwilioRestException

Deletes an activity.

Parameters:

workspaceSid - the workspace sid

activitySid - the activity sid

Returns:

true, if successful

Throws:

TwilioRestException - the twilio rest exception

deleteTaskQueue

public boolean deleteTaskQueue(String workspaceSid,
                               String queueSid)
                        throws TwilioRestException

Deletes a queue.

Parameters:

workspaceSid - the workspace sid

queueSid - the queue sid

Returns:

true, if successful

Throws:

TwilioRestException - the twilio rest exception

deleteTask

public boolean deleteTask(String workspaceSid,
                          String taskSid)
                   throws TwilioRestException

Deletes a task.

Parameters:

workspaceSid - the workspace sid

taskSid - the task sid

Returns:

true, if successful

Throws:

TwilioRestException - the twilio rest exception

deleteWorker

public boolean deleteWorker(String workspaceSid,
                            String workerSid)
                     throws TwilioRestException

Deletes a worker.

Parameters:

workspaceSid - the workspace sid

workerSid - the worker sid

Returns:

true, if successful

Throws:

TwilioRestException - the twilio rest exception

deleteWorkflow

public boolean deleteWorkflow(String workspaceSid,
                              String workflowSid)
                       throws TwilioRestException

Deletes a workflow.

Parameters:

workspaceSid - the workspace sid

workflowSid - the workflow sid

Returns:

true, if successful

Throws:

TwilioRestException - the twilio rest exception

deleteWorkspace

public boolean deleteWorkspace(String sid)
                        throws TwilioRestException

Deletes a workspace.

Parameters:

sid - the workspace sid

Returns:

true, if successful

Throws:

TwilioRestException - the twilio rest exception

getActivities

public ActivityList getActivities(String workspaceSid)

Get the activities.

Returns:

the activities

getActivities

public ActivityList getActivities(String workspaceSid,
                                  Map<String,String> filters)

Get the activities.

Parameters:

workspaceSid - the workspace sid

filters - the filters

Returns:

activities matching the filters

getActivity

public Activity getActivity(String workspaceSid,
                            String activitySid)

Get an activity instance by sid.

Parameters:

workspaceSid - The 34 character sid starting with WS

activitySid - The 34 character sid starting with WA

getEvent

public Event getEvent(String workspaceSid,
                      String eventSid)

Get an event instance by sid.

Parameters:

workspaceSid - The 34 character sid starting with WS

eventSid - The 34 character sid starting with EV

getEvents

public EventList getEvents(String workspaceSid)

Get the events.

Returns:

the events

getEvents

public EventList getEvents(String workspaceSid,
                           Map<String,String> filters)

Get the events.

Parameters:

workspaceSid - the workspace sid

filters - the filters

Returns:

events matching the filters

getReservation

public Reservation getReservation(String workspaceSid,
                                  String taskSid,
                                  String reservationSid)

Get a reservation instance by sid.

Parameters:

workspaceSid - The 34 character sid starting with WS

taskSid - The 34 character sid starting with WT

reservationSid - The 34 character sid starting with WR

getReservations

public ReservationList getReservations(String workspaceSid,
                                       String taskSid)

Get the reservations.

Returns:

the reservations

getReservations

public ReservationList getReservations(String workspaceSid,
                                       String taskSid,
                                       Map<String,String> filters)

Get the reservations.

Parameters:

workspaceSid - the workspace sid

filters - the filters

Returns:

tasks matching the filters

getTaskQueue

public TaskQueue getTaskQueue(String workspaceSid,
                              String queueSid)

Get a queue instance by sid.

Parameters:

workspaceSid - The 34 character sid starting with WS

queueSid - The 34 character sid starting with WQ

getTaskQueues

public TaskQueueList getTaskQueues(String workspaceSid)

Get the queues.

Returns:

the queues

getTaskQueues

public TaskQueueList getTaskQueues(String workspaceSid,
                                   Map<String,String> filters)

Get the queues.

Parameters:

workspaceSid - the workspace sid

filters - the filters

Returns:

queues matching the filters

getQueuesStatistics

public TaskQueueListStatistics getQueuesStatistics(String workspaceSid)

Get queues statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

Returns:

queues statistics

getQueuesStatistics

public TaskQueueListStatistics getQueuesStatistics(String workspaceSid,
                                                   Map<String,String> filters)

Get queues statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

filters - the filters

Returns:

queues statistics

getQueueStatistics

public TaskQueueStatistics getQueueStatistics(String workspaceSid,
                                              String queueSid)

Get a queue statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

queueSid - The 34 character sid starting with WQ

Returns:

queue statistics

getQueueStatistics

public TaskQueueStatistics getQueueStatistics(String workspaceSid,
                                              String queueSid,
                                              Map<String,String> filters)

Get a queue statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

queueSid - The 34 character sid starting with WQ

filters - the filters

Returns:

queue statistics

getTask

public Task getTask(String workspaceSid,
                    String taskSid)

Get a task instance by sid.

Parameters:

workspaceSid - The 34 character sid starting with WS

taskSid - The 34 character sid starting with WT

getTasks

public TaskList getTasks(String workspaceSid)

Get the tasks.

Returns:

the tasks

getTasks

public TaskList getTasks(String workspaceSid,
                         Map<String,String> filters)

Get the tasks.

Parameters:

workspaceSid - the workspace sid

filters - the filters

Returns:

tasks matching the filters

getWorker

public Worker getWorker(String workspaceSid,
                        String workerSid)

Get a worker instance by sid.

Parameters:

workspaceSid - The 34 character sid starting with WS

workerSid - The 34 character sid starting with WT

getWorkers

public WorkerList getWorkers(String workspaceSid)

Get the workers.

Returns:

the workers

getWorkers

public WorkerList getWorkers(String workspaceSid,
                             Map<String,String> filters)

Get the workers.

Parameters:

workspaceSid - the workspace sid

filters - the filters

Returns:

tasks matching the filters

getWorkersStatistics

public WorkersStatistics getWorkersStatistics(String workspaceSid)

Get workers statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

Returns:

queues statistics

getWorkersStatistics

public WorkersStatistics getWorkersStatistics(String workspaceSid,
                                              Map<String,String> filters)

Get workers statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

filters - the filters

Returns:

queues statistics

getWorkerStatistics

public WorkerStatistics getWorkerStatistics(String workspaceSid,
                                            String workerSid)

Get worker statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

workerSid - The 34 character sid starting with WW

Returns:

queues statistics

getWorkerStatistics

public WorkerStatistics getWorkerStatistics(String workspaceSid,
                                            String workerSid,
                                            Map<String,String> filters)

Get worker statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

workerSid - The 34 character sid starting with WW

filters - the filters

Returns:

queues statistics

getWorkflow

public Workflow getWorkflow(String workspaceSid,
                            String workflowSid)

Get a workflow instance by sid.

Parameters:

workspaceSid - The 34 character sid starting with WS

workflowSid - The 34 character sid starting with WF

getWorkflows

public WorkflowList getWorkflows(String workspaceSid)

Get the workflows.

Returns:

the workflows

getWorkflows

public WorkflowList getWorkflows(String workspaceSid,
                                 Map<String,String> filters)

Get the workflows.

Parameters:

workspaceSid - the workspace sid

filters - the filters

Returns:

tasks matching the filters

getWorkflowStatistics

public WorkflowStatistics getWorkflowStatistics(String workspaceSid,
                                                String workflowSid)

Get workflow statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

workflowSid - The 34 character sid starting with WF

Returns:

queues statistics

getWorkflowStatistics

public WorkflowStatistics getWorkflowStatistics(String workspaceSid,
                                                String workflowSid,
                                                Map<String,String> filters)

Get workflow statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

workflowSid - The 34 character sid starting with WF

filters - the filters

Returns:

queues statistics

getWorkspace

public Workspace getWorkspace(String sid)

Get a workspace instance by sid

Parameters:

sid - The 34 character sid starting with WS

getWorkspaces

public WorkspaceList getWorkspaces()

Get the workspaces.

Returns:

the workspaces

getWorkspaces

public WorkspaceList getWorkspaces(Map<String,String> filters)

Get the workspaces.

Parameters:

filters - the filters

Returns:

workspaces matching the filters

getWorkspaceStatistics

public WorkspaceStatistics getWorkspaceStatistics(String workspaceSid)

Get workspace statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

Returns:

queues statistics

getWorkspaceStatistics

public WorkspaceStatistics getWorkspaceStatistics(String workspaceSid,
                                                  Map<String,String> filters)

Get workspace statistics.

Parameters:

workspaceSid - The 34 character sid starting with WS

filters - the filters

Returns:

queues statistics