summaryrefslogtreecommitdiffstats
path: root/docs/usage/taskrouter
diff options
context:
space:
mode:
authorCarlos Diaz-Padron <cdpadron@twilio.com>2016-02-23 11:45:23 -0800
committerCarlos Diaz-Padron <cdpadron@twilio.com>2016-02-23 11:45:23 -0800
commit17ef4e9dc24ea4707cc88708e2485ac28d30b5e7 (patch)
treeee2807d76cf1f5e83aff9b2ab1c51f07bafb943b /docs/usage/taskrouter
parent8ca9d0b6ad0fe8b602d9144a28aa116c42b2b138 (diff)
downloadtwilio-php-17ef4e9dc24ea4707cc88708e2485ac28d30b5e7.zip
twilio-php-17ef4e9dc24ea4707cc88708e2485ac28d30b5e7.tar.gz
twilio-php-17ef4e9dc24ea4707cc88708e2485ac28d30b5e7.tar.bz2
Remove old docs
Diffstat (limited to 'docs/usage/taskrouter')
-rw-r--r--docs/usage/taskrouter/activities.rst82
-rw-r--r--docs/usage/taskrouter/events.rst39
-rw-r--r--docs/usage/taskrouter/reservations.rst29
-rw-r--r--docs/usage/taskrouter/statistics.rst104
-rw-r--r--docs/usage/taskrouter/task-queues.rst86
-rw-r--r--docs/usage/taskrouter/tasks.rst86
-rw-r--r--docs/usage/taskrouter/workers.rst81
-rw-r--r--docs/usage/taskrouter/workflows.rst87
-rw-r--r--docs/usage/taskrouter/workspaces.rst77
9 files changed, 0 insertions, 671 deletions
diff --git a/docs/usage/taskrouter/activities.rst b/docs/usage/taskrouter/activities.rst
deleted file mode 100644
index bdafba1..0000000
--- a/docs/usage/taskrouter/activities.rst
+++ /dev/null
@@ -1,82 +0,0 @@
-===========
-Activities
-===========
-
-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.
-
-Creating an Activity
-==============================
-
-You can create a new activity by specifying its friendly name and availability.
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // set activity parameters
- $friendlyName = 'New Activity';
- $activityAvailability = 'false';
-
- // create an activity
- $activity = $taskrouterClient->workspace->activities->create(
- $friendlyName,
- $activityAvailability
- );
-
- // confirm activity created
- echo "Created Activity: ".$activity->sid;
-
-Updating an Activity
-==============================
-
-Updates to an activity are restricted to only the FriendlyName
-
-.. code-block:: php
-
- $activitySid = 'YOUR_ACTIVITY_SID';
-
- // updated activity parameters
- $updatedActivityFriendlyName = "Updated Activity Name";
-
- // updated activity
- $taskrouterClient->workspace->activities->get($activitySid)->update(
- array(
- 'FriendlyName' => $updatedActivityFriendlyName
- )
- );
-
- echo 'Updated Activity: '.$activitySid;
-
-Deleting an Activity
-==============================
-
-Deleting an activity is just as easy as creating an activity. Simple make a call to delete and pass in the sid of the activity.
-
-.. code-block:: php
-
- $activitySid = 'YOUR_ACTIVITY_SID';
-
- $taskrouterClient->workspace->activities->delete($activitySid);
-
- echo 'Deleted Activity: '.$activitySid;
-
-Get a List of all Activities
-==============================
-
-You can also loop through the list of all activities in a workspace.
-
-.. code-block:: php
-
- foreach($taskrouterClient->workspace->activities as $activity)
- {
- echo $activity->sid;
- }
-
- \ No newline at end of file
diff --git a/docs/usage/taskrouter/events.rst b/docs/usage/taskrouter/events.rst
deleted file mode 100644
index 3f2b302..0000000
--- a/docs/usage/taskrouter/events.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-===========
-Events
-===========
-
-TaskRouter logs Events for each state change in the Workspace for the purpose of historical reporting and auditing. TaskRouter will also make an HTTP request containing the Event details to the Workspace's EventCallbackURL each time one these Events takes place.
-
-Get an Event
-=====================
-
-You can get details on a specific event by doing the following:
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- $eventSid = 'YOUR_EVENT_SID';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // fetch workspace statistics
- $event = taskrouterClient->workspace->events->get($eventSid);
-
-
-Get a List of all Events
-==============================
-
-You can also loop through the list of all events in a workspace.
-
-.. code-block:: php
-
- foreach($taskrouterClient->workspace->events as $event)
- {
- echo $event->sid;
- } \ No newline at end of file
diff --git a/docs/usage/taskrouter/reservations.rst b/docs/usage/taskrouter/reservations.rst
deleted file mode 100644
index 7114e9d..0000000
--- a/docs/usage/taskrouter/reservations.rst
+++ /dev/null
@@ -1,29 +0,0 @@
-=============
-Reservations
-=============
-
-TaskRouter creates a Task Reservation subresource whenever a Task is assigned to a Worker. TaskRouter will provide the details of this Reservation Instance subresource in the Assignment Callback HTTP request it makes to your application server. You must POST **ReservationStatus=accepted** or **ReservationStatus=rejected** to this resource within the reservation timeout to claim or reject this task.
-
-
-Update a Reservation
-=======================
-
-TO indicate that a Worker has accepted or rejected a Task, you can:
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
- $workspaceSid = 'YOUR_WORKSPACE_SID';
- $taskSid = 'YOUR_TASK_SID';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // set reservation parameters
- $reservationStatus = 'accepted';
-
- // update the reservation status
- $taskrouterClient->workspace->tasks->get($taskSid)->reservations->get($reservationSid)->update('ReservationStatus', $reservationStatus); \ No newline at end of file
diff --git a/docs/usage/taskrouter/statistics.rst b/docs/usage/taskrouter/statistics.rst
deleted file mode 100644
index 4494deb..0000000
--- a/docs/usage/taskrouter/statistics.rst
+++ /dev/null
@@ -1,104 +0,0 @@
-===========
-Statistics
-===========
-
-TaskRouter provides real time and historical statistics for each Workspace subresource. Real time statistics allow you to check the current state of the system (tasks, workers, queues). Historical statistics allow you to analyze the efficiency of your Workflows, TaskQueues and Workers.
-
-
-Workspace Statistics
-=====================
-
-You can get workspace statistics by doing the following:
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // fetch workspace statistics
- $stats = taskrouterClient->getWorkspaceStatistics(array('Minutes' => 60));
-
- // confirm stats
- echo $stats->account_sid;
-
-
-Workflow Statistics
-=====================
-
-You can get workflow statistics by doing the following:
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- $workflowSid = 'YOUR_WORKFLOW_SID';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // fetch workspace statistics
- $stats = taskrouterClient->getWorkflowStatistics($workflowSid, array('Minutes' => 60));
-
- // confirm stats
- echo $stats->account_sid;
-
-
-Worker Statistics
-=====================
-
-You can get worker statistics by doing the following:
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- $workerSid = 'YOUR_WORKER_SID';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // fetch workspace statistics
- $stats = $taskrouterClient->getWorkerStatistics($workerSid, array('Minutes' => 60));
-
- // confirm stats
- echo $stats->account_sid;
-
-
-TaskQueue Statistics
-=====================
-
-You can get task queue statistics by doing the following:
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- $taskQueueSid = 'YOUR_TASK_QUEUE_SID';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // fetch workspace statistics
- $stats = $taskrouterClient->getTaskQueueStatistics($taskQueueSid, array('Minutes' => 60));
-
- // confirm stats
- echo $stats->account_sid;
-
diff --git a/docs/usage/taskrouter/task-queues.rst b/docs/usage/taskrouter/task-queues.rst
deleted file mode 100644
index 69f3d9f..0000000
--- a/docs/usage/taskrouter/task-queues.rst
+++ /dev/null
@@ -1,86 +0,0 @@
-===========
-Task Queues
-===========
-
-TaskQueues are the resource you use to categorize Tasks and describe which Workers are eligible to handle those Tasks. As your Workflows process Tasks, those Tasks will pass through one or more TaskQueues until the Task is assigned and accepted by an eligible Worker.
-
-Creating a Task Queue
-==============================
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // set taskQ parameters
- $friendlyName = "FrenchQ";
- $assignmentActivitySid = 'YOUR_ASSIGNMENT_ACTIVITY_SID';
- $reservationActivitySid = 'YOUR_RESERVATION_ACTIVITY_SID';
- $targetWorkers = 'languages HAS "fr"';
-
- $taskQ = $taskrouterClient->workspace->task_queues->create(
- $friendlyName,
- $assignmentActivitySid,
- $reservationActivitySid,
- array(
- "TargetWorkers" => $targetWorkers
- )
- );
-
- // confirm task queue created
- echo 'Created TaskQ: '.$taskQ->sid;
-
-Updating a Task Queue
-==============================
-
-In this example, we update the above task queue to now accept tasks which have a language attribute of french or swedish, or both.
-
-
-.. code-block:: php
-
- $taskQSid = 'YOUR_TASK_QUEUE_SID';
-
- // updated taskQ parameters
- $updatedFriendlyName = "French and Swedish Q";
- $updatedTargetWorkers = 'languages HAS "fr" and languages has "sv"';
-
- //update taskQ
- $taskrouterClient->workspace->task_queues->get($taskQSid)->update(
- array(
- 'FriendlyName'=> $updatedFriendlyName,
- 'TargetWorkers'=> $updatedTargetWorkers
- )
- );
-
- echo 'Updated Task Queue: '.$taskQSid;
-
-
-Deleting a Task Queue
-==============================
-
-.. code-block:: php
-
- $taskQSid = 'YOUR_TASK_QUEUE_SID';
-
- $taskrouterClient->workspace->task_queues->delete($taskQSid);
-
- echo 'Deleted Task Queue: '.$taskQSid;
-
-
-Get a List of all Task Queues
-==============================
-
-.. code-block:: php
-
- foreach($taskrouterClient->workspace->task_queues as $taskQ)
- {
- echo $taskQ->sid;
- }
-
- \ No newline at end of file
diff --git a/docs/usage/taskrouter/tasks.rst b/docs/usage/taskrouter/tasks.rst
deleted file mode 100644
index e3720b1..0000000
--- a/docs/usage/taskrouter/tasks.rst
+++ /dev/null
@@ -1,86 +0,0 @@
-===========
-Tasks
-===========
-
-A Task instance resource represents a single item of work waiting to be processed. Tasks can represent whatever type of work is important for your team. Twilio applications can create tasks from phone calls or SMS messages.
-
-Creating a Task
-==============================
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // set task parameters
- $workflowSid = 'YOUR_WORKFLOW_SID';
- $taskAttributes = '{"selected_language": "fr"}';
- $prioity = 10;
- $timeout = 100;
-
- // create task
- $task = $taskrouterClient->workspace->tasks->create(
- $taskAttributes,
- $workflowSid,
- array(
- 'Priority' => $priority,
- 'Timeout' => $timeout
- )
- );
-
- // confirm task created
- echo "Created Task: ".$task->sid;
-
-Updating a Task
-==============================
-
-Here, we modify the above created task to have an updated priority of 20 and contains Swedish instead of French.
-
-.. code-block:: php
-
- $taskSid = 'YOUR_TASK_SID';
-
- // update task parameters
- $updatedTaskAttributes = '{"languages":"sv"}';
- $updatedPriority = 20;
-
- // update task
- $taskrouterClient->workspace->tasks->get($taskSid)->update(
- array(
- 'Attributes'=> $updatedTaskAttributes,
- 'Priority'=> $updatedPriority
- )
- );
-
- echo 'Updated Task: '.$taskSid;
-
-
-Deleting a Task
-==============================
-
-.. code-block:: php
-
- $taskSid = 'YOUR_TASK_SID';
-
- $taskrouterClient->workspace->tasks->delete($taskSid);
-
- echo 'Deleted Task: '.$taskSid;
-
-
-Get a List of all Tasks
-==============================
-
-.. code-block:: php
-
- foreach($taskrouterClient->workspace->tasks as $task)
- {
- echo $task->sid;
- }
-
- \ No newline at end of file
diff --git a/docs/usage/taskrouter/workers.rst b/docs/usage/taskrouter/workers.rst
deleted file mode 100644
index 4e61a6b..0000000
--- a/docs/usage/taskrouter/workers.rst
+++ /dev/null
@@ -1,81 +0,0 @@
-===========
-Workers
-===========
-
-Workers represent an entity that is able to perform tasks, such as an agent working in a call center, or a salesperson handling leads.
-
-Creating a Worker
-==============================
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // set worker parameters
- $friendlyName = 'Bob';
- $activitySid = 'YOUR_ACTIVITY_SID';
- $workerAttributes = '{"languages":"fr"}';
-
- $worker = $taskrouterClient->workspace->workers->create(
- $friendlyName,
- array(
- 'Attributes' => $workerAttributes,
- 'ActivitySid' => $idleActivitySid
- )
- );
-
- // confirm worker created
- echo "Created Worker: ".$worker.sid;
-
-Updating a Worker
-==============================
-
-This update changes the worker above to now be able to handle additional tasks, specfically, tasks that have a language attribute = "sv".
-
-.. code-block:: php
-
- $workerSid = 'YOUR_WORKER_SID';
-
- // set updated worker parameters
- $updatedWorkerAttributes = '{"language": ["fr", "sv"]}';
-
- // update worker
- $taskrouterClient->workspace->workers->get($workerSid)->update(
- array(
- 'Attributes' => $updatedWorkerAttributes
- )
- );
-
- echo 'Updated Worker: '.$workerSid;
-
-
-Deleting a Worker
-==============================
-
-.. code-block:: php
-
- $workerSid = 'YOUR_WORKER_SID';
-
- $taskrouterClient->workspace->workers->delete($workerSid);
-
- echo 'Deleted Worker: '.$workerSid;
-
-
-Get a List of all Workers
-==============================
-
-.. code-block:: php
-
- foreach($taskrouterClient->workspace->workers as $worker)
- {
- echo $worker->sid;
- }
-
- \ No newline at end of file
diff --git a/docs/usage/taskrouter/workflows.rst b/docs/usage/taskrouter/workflows.rst
deleted file mode 100644
index ea0a5d1..0000000
--- a/docs/usage/taskrouter/workflows.rst
+++ /dev/null
@@ -1,87 +0,0 @@
-===========
-Workflows
-===========
-
-Workflows control how tasks will be prioritized and routed into Queues, and how Tasks should escalate in priority or move across queues over time. Workflows are described in a simple JSON format and can be modified through the REST API or through the account portal.
-
-Creating a Workflow
-==============================
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // set workflow parameters
- $friendlyName = 'Example Workflow';
- $configuration = '{"task_routing":{"default_filter":{"task_queue_sid":"YOUR_TASK_QUEUE_SID"}}}';
- $assignmentCallbackUrl = 'http://exampleCallbackUrl.org';
- $fallbackAssignmentCallbackUrl = 'http://exampleFallbackUrl.org';
- $taskReservationTimeout = 50;
-
- // create a Workflow
- $workflow = $taskrouterClient->workspace->workflows->create(
- $friendlyName,
- $configuration,
- $assignmentCallbackUrl,
- array(
- 'FallbackAssignmentCallbackUrl' => $fallbackAssignmentCallbackUrl,
- 'TaskReservationTimeout' => $taskReservationTimeout
- )
- );
-
- // confirm workflow created
- echo 'Created Workflow: '.$workflow->sid;
-
-Updating a Workflow
-==============================
-
-This example updates the above workflow's configuration and task reservation timeout.
-
-.. code-block:: php
-
- $workflowSid = 'YOUR_WORKFLOW_SID';
-
- // updated workflow parameters
- $updatedConfiguration = '{"task_routing":{"default_filter":{"task_queue_sid" : "YOUR_UPDATED_TASK_QUEUE_SID"}}}';
- $updatedFallbackAssignmentUrl = 'http://updatedFallbackAssignmentUrl.org';
- $updatedTaskReservationTimeout = 150;
-
- // update workflow
- $taskrouterClient->workspace->workflows->get($workflowSid)->update(
- array(
- 'Configuration' => $updatedConfiguration,
- 'TaskReservationTimeout' => $updatedTaskReservationTimeout
- )
- );
-
- echo 'Updated Workflow: '.$workflowSid;
-
-
-Deleting a Workflow
-==============================
-
-.. code-block:: php
-
- $workflowSid = 'YOUR_WORKFLOW_SID';
- $taskrouterClient->workspace->workflows->delete($workflowSid);
- echo 'Deleted Workflow: '.$workflowSid;
-
-
-Get a List of all Workflows
-==============================
-
-.. code-block:: php
-
- foreach($taskrouterClient->workspace->workflows as $workflow)
- {
- echo $workflow->sid;
- }
-
- \ No newline at end of file
diff --git a/docs/usage/taskrouter/workspaces.rst b/docs/usage/taskrouter/workspaces.rst
deleted file mode 100644
index 18f01c1..0000000
--- a/docs/usage/taskrouter/workspaces.rst
+++ /dev/null
@@ -1,77 +0,0 @@
-===========
-Workspaces
-===========
-
-A Workspace is a container for your Tasks, Workers, TaskQueues, Workflows and Activities. Each of these items exists within a single Workspace and will not be shared across Workspaces.
-
-Creating a Workspace
-==============================
-
-.. code-block:: php
-
- require 'Services/Twilio.php';
-
- // set account parameters
- $accountSid = 'YOUR_ACCOUNT_SID';
- $authToken = 'YOUR_AUTH_TOKEN';
-
- // instantiate a Twilio TaskRouter Client
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, null);
-
- // create a workspace
- $workspace = $taskrouterClient->createWorkspace(
- $accountSid, // AccountSid
- $authToken, // AuthToken
- $friendlyName // name for workspace
- );
-
- // confirm workspace created
- echo 'Created Workspace: '.$workspace->sid;
-
-Updating a Workspace
-==============================
-
-This update below alters the workspace to a new FriendlyName and EventCallbackUrl.
-
-.. code-block:: php
-
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- $taskrouterClient = new TaskRouter_Services_Twilio($accountSid, $authToken, $workspaceSid);
-
- // updated workspace parameters
- $updatedFriendlyName = 'My Updated Workspace';
- $updatedEventCallbackUrl = 'http://updatedEventCallbackUrl.org';
-
- // update workspace
- $taskrouterClient->workspace->update(
- array(
- 'FriendlyName' => $updatedFriendlyName,
- 'EventCallbackUrl' => $updatedEventCallbackUrl
- )
- );
-
- echo 'Updated Workspace: '.$workspaceSid;
-
-
-Deleting a Workspace
-==============================
-
-.. code-block:: php
-
- $workspaceSid = 'YOUR_WORKSPACE_SID';
-
- $taskrouterClient->workspaces->delete($workspaceSid);
-
- echo 'Deleted Workspace: '.$workspaceSid;
-
-
-Get a List of all Workspaces
-==============================
-
-.. code-block:: php
-
- foreach($taskrouterClient->workspaces as $workspace)
- {
- echo $workspace->sid;
- }