Skip to content
This repository was archived by the owner on Aug 15, 2024. It is now read-only.

Create example snippets for bulk get endpoint #1044

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Download the Node helper library from twilio.com/docs/node/install
// These consts are your accountSid and authToken from https://www.twilio.com/console
// To set up environmental variables, see http://twil.io/secure
const accountSid = process.env.TWILIO_ACCOUNT_SID;
const authToken = process.env.TWILIO_AUTH_TOKEN;
const workspaceSid = 'WSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
const taskQueueSid = 'WQXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
const client = require('twilio')(accountSid, authToken);

client.taskrouter.v1
.workspaces(workspaceSid)
.taskQueues(taskQueueSid)
.realTimeStatistics()
.create({
"queueSids": [taskQueueSid]
})
.then(responseData => {
console.log(responseData.taskQueueData);
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Download the twilio-csharp library from
// https://www.twilio.com/docs/libraries/csharp#installation
using Newtonsoft.Json.Linq;
using System;
using Twilio;
using Twilio.Rest.Taskrouter.V1.Workspace.TaskQueue;

class Example
{
static void Main(string[] args)
{
// Find your Account Sid and Auth Token at twilio.com/console
// To set up environmental variables, see http://twil.io/secure
const string accountSid = Environment.GetEnvironmentVariable("TWILIO_ACCOUNT_SID");
const string authToken = Environment.GetEnvironmentVariable("TWILIO_AUTH_TOKEN");
const string workspaceSid = "WSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
const string taskQueueSid = "WQXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";

TwilioClient.Init(accountSid, authToken);

var stats = TaskQueueRealTimeStatisticsResource.create(
workspaceSid, queueSids: new List<string> {taskQueueSid});

Console.WriteLine(stats.TaskQueueData);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Get twilio-ruby from twilio.com/docs/ruby/install
require 'twilio-ruby'

# Get your Account SID and Auth Token from twilio.com/console
# To set up environmental variables, see http://twil.io/secure
account_sid = ENV['TWILIO_ACCOUNT_SID']
auth_token = ENV['TWILIO_AUTH_TOKEN']
workspace_sid = 'WSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
taskqueue_sid = 'WQXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'

client = Twilio::REST::Client.new(account_sid, auth_token)

statistics = client.taskrouter.v1.workspaces(workspace_sid)
.task_queues.real_time_statistics.create(queueSids: Array.[](taskqueue_sid));

puts statistics.task_queue_data
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?php
// Get the PHP helper library from https://twilio.com/docs/libraries/php
require_once '/path/to/vendor/autoload.php'; // Loads the library

use Twilio\Rest\Client;

// Your Account Sid and Auth Token from twilio.com/user/account
// To set up environmental variables, see http://twil.io/secure
$accountSid = getenv('TWILIO_ACCOUNT_SID');
$authToken = getenv('TWILIO_AUTH_TOKEN');
$workspaceSid = "WSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
$taskQueueSid = "WQXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";

$client = new Client($accountSid, $authToken);

$statistics = $client->taskrouter
->workspaces($workspaceSid)
->taskQueues()
->realTimeStatistics()
->create(
array(
'queueSids' => $taskQueueSid
)
);

echo $statistics->taskQueueData;
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Download the Python helper library from twilio.com/docs/python/install
import os
from twilio.rest import Client

# Your Account Sid and Auth Token from twilio.com/user/account
# To set up environmental variables, see http://twil.io/secure
account_sid = os.environ['TWILIO_ACCOUNT_SID']
auth_token = os.environ['TWILIO_AUTH_TOKEN']
workspace_sid = "WSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
taskqueue_sid = "WQXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

client = Client(account_sid, auth_token)

statistics = client.taskrouter.workspaces(workspace_sid) \
.task_queues() \
.real_time_statistics().create(queue_sids=[taskqueue_sid])

print(statistics.task_queue_data)
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Install the Java helper library from twilio.com/docs/java/install
import com.twilio.Twilio;
import com.twilio.rest.taskrouter.v1.workspace.taskqueue.TaskQueueStatistics;
import com.twilio.rest.taskrouter.v1.workspace.taskqueue.TaskQueueRealTimeStatistics;

public class Example {
private static final String ACCOUNT_SID = System.getenv("TWILIO_ACCOUNT_SID");
private static final String AUTH_TOKEN = System.getenv("TWILIO_AUTH_TOKEN");
private static final String WORKSPACE_SID = "WSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";
private static final String TASKQUEUE_SID = "WQXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX";

public static void main(String[] args) {
Twilio.init(ACCOUNT_SID, AUTH_TOKEN);

List<String> taskQueueSids = new ArrayList<>();
taskQueueSids.add(TASKQUEUE_SID);
TaskQueueRealTimeStatistics statistics =
TaskQueueRealTimeStatistics.creator(WORKSPACE_SID).setQueueSids(taskQueueSids).create();

System.out.println(
"TaskQueueData: " + statistics.getTaskQueueData()
);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
curl https://taskrouter.twilio.com/v1/Workspaces/WSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/TaskQueues/RealTimeStatistics \
--header 'Content-Type: application/json' \
--data-raw '{
"queueSids" : [
"WQXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"WQYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY",
"WQZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
]
}' \
-u '{account_sid}:{auth_token}'
4 changes: 4 additions & 0 deletions rest/taskrouter/statistics/taskqueue/realtime_bulk/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Bulk retrieval of TaskQueue RealTime Statistics",
"type": "server"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"workspace_sid": "WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"url": "https://taskrouter.twilio.com/v1/Workspaces/WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/TaskQueues/RealTimeStatistics",
"task_queue_data": [
{
"task_queue_sid": "WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"longest_task_waiting_age": 100,
"longest_task_waiting_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"total_tasks": 100,
"total_eligible_workers": 100,
"total_available_workers": 100,
"tasks_by_status": {
"reserved": 0,
"pending": 0,
"assigned": 0,
"wrapping": 0
},
"tasks_by_priority": {},
"activity_statistics": [
{
"friendly_name": "Idle",
"workers": 0,
"sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
{
"friendly_name": "Busy",
"workers": 9,
"sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
{
"friendly_name": "Offline",
"workers": 6,
"sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
},
{
"friendly_name": "Reserved",
"workers": 0,
"sid": "WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
]
}
],
"task_queue_response_count": 100
}