Control Worker Activities using Worker.js: Add an Agent UI to our Project

Let's get started on our agent UI. Assuming you've followed the conventions so far in this tutorial, the UI we create will be accessible using your web browser at:

http://localhost:8080/agents?WorkerSid=WK01234012340123401234 (substitute your Alice's WorkerSid)

We pass the WorkerSid in the URL to avoid implementing complex user management in our demo. In reality, you are likely to store a user's WorkerSid in your database alongside other User attributes.

Let's add on our to our run.py file to add an endpoint to generate a page based on a template.

run.py

1# -*- coding: latin-1 -*-
2
3from flask import Flask, request, Response, render_template
4from twilio.rest import Client
5from twilio.jwt.taskrouter.capabilities import WorkerCapabilityToken
6from twilio.twiml.voice_response import VoiceResponse
7
8app = Flask(__name__)
9
10# Your Account Sid and Auth Token from twilio.com/user/account
11account_sid = "{{ account_sid }}"
12auth_token  = "{{ auth_token }}"
13workspace_sid = "{{ workspace_sid }}"
14workflow_sid = "{{ workflow_sid }}"
15
16client = Client(account_sid, auth_token)
17
18@app.route("/assignment_callback", methods=['GET', 'POST'])
19def assignment_callback():
20    """Respond to assignment callbacks with an acceptance and 200 response"""
21
22    ret = '{"instruction": "dequeue", "from"="+15556667777"}' # a verified phone number from your twilio account
23    resp = Response(response=ret, status=200, mimetype='application/json')
24    return resp
25
26@app.route("/create_task", methods=['GET', 'POST'])
27def create_task():
28    """Creating a Task"""
29    task = client.taskrouter.workspaces(workspace_sid) \
30                 .tasks.create(workflow_sid=workflow_sid, attributes='{"type":"support"}')
31
32    print(task.attributes)
33    resp = Response({}, status=200, mimetype='application/json')
34    return resp
35
36@app.route("/accept_reservation", methods=['GET', 'POST'])
37def accept_reservation():
38    """Accepting a Reservation"""
39    task_sid = request.args.get('task_sid')
40    reservation_sid = request.args.get('reservation_sid')
41
42    reservation = client.taskrouter.workspaces(workspace_sid) \
43                        .tasks(task_sid) \
44                        .reservations(reservation_sid) \
45                        .update(reservation_status='accepted')
46
47    print(reservation.reservation_status)
48    print(reservation.worker_name)
49
50    resp = Response({}, status=200, mimetype='application/json')
51    return resp
52
53@app.route("/incoming_call", methods=['GET', 'POST'])
54def incoming_call():
55    """Respond to incoming requests."""
56
57    resp = VoiceResponse()
58    with resp.gather(numDigits=1, action="/enqueue_call", method="POST", timeout=5) as g:
59        g.say("Para Español oprime el uno.".decode("utf8"), language='es')
60        g.say("For English, please hold or press two.", language='en')
61
62    return str(resp)
63
64@app.route("/enqueue_call", methods=['GET', 'POST'])
65def enqueue_call():
66    digit_pressed = request.args.get('Digits')
67    if digit_pressed == 1 :
68        language = "es"
69    else:
70        language = "en"
71
72    resp = VoiceResponse()
73    with resp.enqueue(None, workflowSid=workflow_sid) as e:
74        e.task('{"selected_language":"' + language + '"}')
75
76    return str(resp)
77
78@app.route("/agents", methods=['GET'])
79def generate_view():
80    worker_sid = request.args.get('WorkerSid')
81
82    worker_capability = WorkerCapabilityToken(account_sid, auth_token, workspace_sid, worker_sid)
83    worker_capability.allow_update_activities()
84    worker_capability.allow_update_reservations()
85
86    worker_token = worker_capability.to_jwt().decode('utf-8')
87
88    return render_template('agent.html', worker_token=worker_token)
89
90if __name__ == "__main__":
91    app.run(debug=True)

Now create a folder called templates. Inside that folder, create a template file that will be rendered when the URL is requested:

templates/agent.html

1<!DOCTYPE html>
2<html>
3<head>
4    <title>Customer Care - Voice Agent Screen</title>
5    <link rel="stylesheet" href="//media.twiliocdn.com/taskrouter/quickstart/agent.css"/>
6    <script src="https://sdk.twilio.com/js/taskrouter/v1.21/taskrouter.min.js" integrity="sha384-5fq+0qjayReAreRyHy38VpD3Gr9R2OYIzonwIkoGI4M9dhfKW6RWeRnZjfwSrpN8" crossorigin="anonymous"></script>
7    <script type="text/javascript">
8        /* Subscribe to a subset of the available TaskRouter.js events for a worker */
9        function registerTaskRouterCallbacks() {
10            worker.on('ready', function(worker) {
11                agentActivityChanged(worker.activityName);
12                logger("Successfully registered as: " + worker.friendlyName)
13                logger("Current activity is: " + worker.activityName);
14            });
15
16            worker.on('activity.update', function(worker) {
17                agentActivityChanged(worker.activityName);
18                logger("Worker activity changed to: " + worker.activityName);
19            });
20
21            worker.on("reservation.created", function(reservation) {
22                logger("-----");
23                logger("You have been reserved to handle a call!");
24                logger("Call from: " + reservation.task.attributes.from);
25                logger("Selected language: " + reservation.task.attributes.selected_language);
26                logger("-----");
27            });
28
29            worker.on("reservation.accepted", function(reservation) {
30                logger("Reservation " + reservation.sid + " accepted!");
31            });
32
33            worker.on("reservation.rejected", function(reservation) {
34                logger("Reservation " + reservation.sid + " rejected!");
35            });
36
37            worker.on("reservation.timeout", function(reservation) {
38                logger("Reservation " + reservation.sid + " timed out!");
39            });
40
41            worker.on("reservation.canceled", function(reservation) {
42                logger("Reservation " + reservation.sid + " canceled!");
43            });
44        }
45
46        /* Hook up the agent Activity buttons to TaskRouter.js */
47
48        function bindAgentActivityButtons() {
49            // Fetch the full list of available Activities from TaskRouter. Store each
50            // ActivitySid against the matching Friendly Name
51            var activitySids = {};
52            worker.activities.fetch(function(error, activityList) {
53                var activities = activityList.data;
54                var i = activities.length;
55                while (i--) {
56                    activitySids[activities[i].friendlyName] = activities[i].sid;
57                }
58            });
59
60            /* For each button of class 'change-activity' in our Agent UI, look up the
61             ActivitySid corresponding to the Friendly Name in the button's next-activity
62             data attribute. Use Worker.js to transition the agent to that ActivitySid
63             when the button is clicked.*/
64            var elements = document.getElementsByClassName('change-activity');
65            var i = elements.length;
66            while (i--) {
67                elements[i].onclick = function() {
68                    var nextActivity = this.dataset.nextActivity;
69                    var nextActivitySid = activitySids[nextActivity];
70                    worker.update({"ActivitySid":nextActivitySid});
71                }
72            }
73        }
74
75        /* Update the UI to reflect a change in Activity */
76
77        function agentActivityChanged(activity) {
78            hideAgentActivities();
79            showAgentActivity(activity);
80        }
81
82        function hideAgentActivities() {
83            var elements = document.getElementsByClassName('agent-activity');
84            var i = elements.length;
85            while (i--) {
86                elements[i].style.display = 'none';
87            }
88        }
89
90        function showAgentActivity(activity) {
91            activity = activity.toLowerCase();
92            var elements = document.getElementsByClassName(('agent-activity ' + activity));
93            elements.item(0).style.display = 'block';
94        }
95
96        /* Other stuff */
97
98        function logger(message) {
99            var log = document.getElementById('log');
100            log.value += "\n> " + message;
101            log.scrollTop = log.scrollHeight;
102        }
103
104        window.onload = function() {
105            // Initialize TaskRouter.js on page load using window.workerToken -
106            // a Twilio Capability token that was set from rendering the template with agents endpoint
107            logger("Initializing...");
108            window.worker = new Twilio.TaskRouter.Worker("{{ worker_token }}");
109
110            registerTaskRouterCallbacks();
111            bindAgentActivityButtons();
112        };
113    </script>
114</head>
115<body>
116<div class="content">
117    <section class="agent-activity offline">
118        <p class="activity">Offline</p>
119        <button class="change-activity" data-next-activity="Idle">Go Available</button>
120    </section>
121    <section class="agent-activity idle">
122        <p class="activity"><span>Available</span></p>
123        <button class="change-activity" data-next-activity="Offline">Go Offline</button>
124    </section>
125    <section class="agent-activity reserved">
126        <p class="activity">Reserved</p>
127    </section>
128    <section class="agent-activity busy">
129        <p class="activity">Busy</p>
130    </section>
131    <section class="agent-activity wrapup">
132        <p class="activity">Wrap-Up</p>
133        <button class="change-activity" data-next-activity="Idle">Go Available</button>
134        <button class="change-activity" data-next-activity="Offline">Go Offline</button>
135    </section>
136    <section class="log">
137      <textarea id="log" readonly="true"></textarea>
138    </section>
139</div>
140</body>
141</html>

You'll notice that we included two external files:

taskrouter.min.js is the primary TaskRouter.js JavaScript file that communicates with TaskRouter's infrastructure on our behalf. You can use this URL to include Worker.js in your production application, but first check the reference documentation to ensure that you include the latest version number.
agent.css is a simple CSS file created for the purpose of this Quickstart. It saves us having to type out some simple pre-defined styles.

And that's it! Open http://localhost:8080/agents?WorkerSid=WK012340123401234 in your browser and you should see the screen below. If you make the same phone call as we made in Part 3, you should see Alice's Activity transition on screen as she is reserved and assigned to handle the Task.

If you see "Initializing..." and no progress, make sure that you have included the correct WorkerSid in the "WorkerSid" request parameter of the URL.

For more details, refer to the TaskRouter JavaScript SDK documentation.

Completed Agent UI

This simple PoC has been tested in the latest version of popular browsers, including IE 11. *