-
Notifications
You must be signed in to change notification settings - Fork 75
/
twilio_taskrouter_v1.json
9937 lines (9937 loc) · 338 KB
/
twilio_taskrouter_v1.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"components": {
"schemas": {
"taskrouter.v1.workspace.activity": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Activity resource."
},
"available": {
"type": "boolean",
"nullable": true,
"description": "Whether the Worker is eligible to receive a Task when it occupies the Activity. A value of `true`, `1`, or `yes` indicates the Activity is available. All other values indicate that it is not. The value cannot be changed after the Activity is created."
},
"date_created": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"date_updated": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"friendly_name": {
"type": "string",
"nullable": true,
"description": "The string that you assigned to describe the Activity resource."
},
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WA[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique string that we created to identify the Activity resource."
},
"workspace_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WS[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workspace that contains the Activity."
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The absolute URL of the Activity resource."
},
"links": {
"type": "object",
"format": "uri-map",
"nullable": true
}
}
},
"taskrouter.v1.workspace.event": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Event resource."
},
"actor_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the resource that triggered the event."
},
"actor_type": {
"type": "string",
"nullable": true,
"description": "The type of resource that triggered the event."
},
"actor_url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The absolute URL of the resource that triggered the event."
},
"description": {
"type": "string",
"nullable": true,
"description": "A description of the event."
},
"event_data": {
"nullable": true,
"description": "Data about the event. For more information, see [Event types](https://www.twilio.com/docs/taskrouter/api/event#event-types)."
},
"event_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The time the event was sent, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"event_date_ms": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "The time the event was sent in milliseconds."
},
"event_type": {
"type": "string",
"nullable": true,
"description": "The identifier for the event."
},
"resource_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the object the event is most relevant to, such as a TaskSid, ReservationSid, or a WorkerSid."
},
"resource_type": {
"type": "string",
"nullable": true,
"description": "The type of object the event is most relevant to, such as a Task, Reservation, or a Worker)."
},
"resource_url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The URL of the resource the event is most relevant to."
},
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^EV[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique string that we created to identify the Event resource."
},
"source": {
"type": "string",
"nullable": true,
"description": "Where the Event originated."
},
"source_ip_address": {
"type": "string",
"nullable": true,
"description": "The IP from which the Event originated."
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The absolute URL of the Event resource."
},
"workspace_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WS[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workspace that contains the Event."
}
}
},
"taskrouter.v1.workspace.task": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Task resource."
},
"age": {
"type": "integer",
"nullable": true,
"description": "The number of seconds since the Task was created."
},
"assignment_status": {
"type": "string",
"$ref": "#/components/schemas/task_enum_status",
"nullable": true,
"description": "The current status of the Task's assignment. Can be: `pending`, `reserved`, `assigned`, `canceled`, `wrapping`, or `completed`."
},
"attributes": {
"type": "string",
"nullable": true,
"description": "The JSON string with custom attributes of the work. **Note** If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null.",
"x-twilio": {
"pii": {
"handling": "sensitive",
"deleteSla": 30
}
}
},
"addons": {
"type": "string",
"nullable": true,
"description": "An object that contains the [Add-on](https://www.twilio.com/docs/add-ons) data for all installed Add-ons."
},
"date_created": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"date_updated": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"task_queue_entered_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT when the Task entered the TaskQueue, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"priority": {
"type": "integer",
"nullable": true,
"description": "The current priority score of the Task as assigned to a Worker by the workflow. Tasks with higher priority values will be assigned before Tasks with lower values."
},
"reason": {
"type": "string",
"nullable": true,
"description": "The reason the Task was canceled or completed, if applicable."
},
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WT[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique string that we created to identify the Task resource."
},
"task_queue_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WQ[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the TaskQueue."
},
"task_queue_friendly_name": {
"type": "string",
"nullable": true,
"description": "The friendly name of the TaskQueue."
},
"task_channel_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^TC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the TaskChannel."
},
"task_channel_unique_name": {
"type": "string",
"nullable": true,
"description": "The unique name of the TaskChannel."
},
"timeout": {
"type": "integer",
"nullable": true,
"description": "The amount of time in seconds that the Task can live before being assigned."
},
"workflow_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WW[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workflow that is controlling the Task."
},
"workflow_friendly_name": {
"type": "string",
"nullable": true,
"description": "The friendly name of the Workflow that is controlling the Task."
},
"workspace_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WS[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workspace that contains the Task."
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The absolute URL of the Task resource."
},
"links": {
"type": "object",
"format": "uri-map",
"nullable": true,
"description": "The URLs of related resources."
},
"virtual_start_time": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT indicating the ordering for routing of the Task specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"ignore_capacity": {
"type": "boolean",
"nullable": true,
"description": "A boolean indicating if a new task should respect a worker's capacity during assignment"
},
"routing_target": {
"type": "string",
"nullable": true,
"description": "A SID of a Worker, Queue, or Workflow to route a Task to"
}
}
},
"task_enum_status": {
"type": "string",
"enum": [
"pending",
"reserved",
"assigned",
"canceled",
"completed",
"wrapping"
]
},
"taskrouter.v1.workspace.task_channel": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Task Channel resource."
},
"date_created": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"date_updated": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"friendly_name": {
"type": "string",
"nullable": true,
"description": "The string that you assigned to describe the resource."
},
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^TC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique string that we created to identify the Task Channel resource."
},
"unique_name": {
"type": "string",
"nullable": true,
"description": "An application-defined string that uniquely identifies the Task Channel, such as `voice` or `sms`."
},
"workspace_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WS[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workspace that contains the Task Channel."
},
"channel_optimized_routing": {
"type": "boolean",
"nullable": true,
"description": "Whether the Task Channel will prioritize Workers that have been idle. When `true`, Workers that have been idle the longest are prioritized."
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The absolute URL of the Task Channel resource."
},
"links": {
"type": "object",
"format": "uri-map",
"nullable": true,
"description": "The URLs of related resources."
}
}
},
"taskrouter.v1.workspace.task_queue": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource."
},
"assignment_activity_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WA[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Activity to assign Workers when a task is assigned for them."
},
"assignment_activity_name": {
"type": "string",
"nullable": true,
"description": "The name of the Activity to assign Workers when a task is assigned for them."
},
"date_created": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
},
"date_updated": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
},
"friendly_name": {
"type": "string",
"nullable": true,
"description": "The string that you assigned to describe the resource.",
"x-twilio": {
"pii": {
"handling": "standard",
"deleteSla": 30
}
}
},
"max_reserved_workers": {
"type": "integer",
"nullable": true,
"description": "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."
},
"reservation_activity_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WA[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Activity to assign Workers once a task is reserved for them."
},
"reservation_activity_name": {
"type": "string",
"nullable": true,
"description": "The name of the Activity to assign Workers once a task is reserved for them."
},
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WQ[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique string that we created to identify the TaskQueue resource."
},
"target_workers": {
"type": "string",
"nullable": true,
"description": "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 TaskQueue until they are either deleted or moved to another TaskQueue. Additional examples on how to describing Worker selection criteria below. Defaults to 1==1."
},
"task_order": {
"type": "string",
"$ref": "#/components/schemas/task_queue_enum_task_order",
"nullable": true,
"description": "How Tasks will be assigned to Workers. Set this parameter to `LIFO` to assign most recently created Task first or `FIFO` to assign the oldest Task. Default is FIFO. [Click here](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo) to learn more."
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The absolute URL of the TaskQueue resource."
},
"workspace_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WS[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workspace that contains the TaskQueue."
},
"links": {
"type": "object",
"format": "uri-map",
"nullable": true,
"description": "The URLs of related resources."
}
}
},
"task_queue_enum_task_order": {
"type": "string",
"enum": [
"FIFO",
"LIFO"
]
},
"taskrouter.v1.workspace.task_queue.task_queue_bulk_real_time_statistics": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource."
},
"workspace_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WS[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workspace that contains the TaskQueue."
},
"task_queue_data": {
"type": "array",
"items": {},
"nullable": true,
"description": "The real-time statistics for each requested TaskQueue SID. `task_queue_data` returns the following attributes:\n\n`task_queue_sid`: The SID of the TaskQueue from which these statistics were calculated.\n\n`total_available_workers`: The total number of Workers available for Tasks in the TaskQueue.\n\n`total_eligible_workers`: The total number of Workers eligible for Tasks in the TaskQueue, regardless of their Activity state.\n\n`total_tasks`: The total number of Tasks.\n\n`longest_task_waiting_age`: The age of the longest waiting Task.\n\n`longest_task_waiting_sid`: The SID of the longest waiting Task.\n\n`tasks_by_status`: The number of Tasks grouped by their current status.\n\n`tasks_by_priority`: The number of Tasks grouped by priority.\n\n`activity_statistics`: The number of current Workers grouped by Activity.\n"
},
"task_queue_response_count": {
"type": "integer",
"nullable": true,
"description": "The number of TaskQueue statistics received in task_queue_data."
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The absolute URL of the TaskQueue statistics resource."
}
}
},
"taskrouter.v1.workspace.task_queue.task_queue_cumulative_statistics": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource."
},
"avg_task_acceptance_time": {
"type": "integer",
"nullable": true,
"description": "The average time in seconds between Task creation and acceptance."
},
"start_time": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The beginning of the interval during which these statistics were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"end_time": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The end of the interval during which these statistics were calculated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"reservations_created": {
"type": "integer",
"nullable": true,
"description": "The total number of Reservations created for Tasks in the TaskQueue."
},
"reservations_accepted": {
"type": "integer",
"nullable": true,
"description": "The total number of Reservations accepted for Tasks in the TaskQueue."
},
"reservations_rejected": {
"type": "integer",
"nullable": true,
"description": "The total number of Reservations rejected for Tasks in the TaskQueue."
},
"reservations_timed_out": {
"type": "integer",
"nullable": true,
"description": "The total number of Reservations that timed out for Tasks in the TaskQueue."
},
"reservations_canceled": {
"type": "integer",
"nullable": true,
"description": "The total number of Reservations canceled for Tasks in the TaskQueue."
},
"reservations_rescinded": {
"type": "integer",
"nullable": true,
"description": "The total number of Reservations rescinded."
},
"split_by_wait_time": {
"nullable": true,
"description": "A list of objects that describe the number of Tasks canceled and reservations accepted above and below the thresholds specified in seconds."
},
"task_queue_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WQ[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the TaskQueue from which these statistics were calculated."
},
"wait_duration_until_accepted": {
"nullable": true,
"description": "The wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks accepted while in the TaskQueue. Calculation is based on the time when the Tasks were created. For transfers, the wait duration is counted from the moment ***the Task was created***, and not from when the transfer was initiated."
},
"wait_duration_until_canceled": {
"nullable": true,
"description": "The wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks canceled while in the TaskQueue."
},
"wait_duration_in_queue_until_accepted": {
"nullable": true,
"description": "The relative wait duration statistics (`avg`, `min`, `max`, `total`) for Tasks accepted while in the TaskQueue. Calculation is based on the time when the Tasks entered the TaskQueue."
},
"tasks_canceled": {
"type": "integer",
"nullable": true,
"description": "The total number of Tasks canceled in the TaskQueue."
},
"tasks_completed": {
"type": "integer",
"nullable": true,
"description": "The total number of Tasks completed in the TaskQueue."
},
"tasks_deleted": {
"type": "integer",
"nullable": true,
"description": "The total number of Tasks deleted in the TaskQueue."
},
"tasks_entered": {
"type": "integer",
"nullable": true,
"description": "The total number of Tasks entered into the TaskQueue."
},
"tasks_moved": {
"type": "integer",
"nullable": true,
"description": "The total number of Tasks that were moved from one queue to another."
},
"workspace_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WS[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workspace that contains the TaskQueue."
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The absolute URL of the TaskQueue statistics resource."
}
}
},
"taskrouter.v1.workspace.task_queue.task_queue_real_time_statistics": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource."
},
"activity_statistics": {
"type": "array",
"items": {},
"nullable": true,
"description": "The number of current Workers by Activity."
},
"longest_task_waiting_age": {
"type": "integer",
"nullable": true,
"description": "The age of the longest waiting Task."
},
"longest_task_waiting_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WT[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the longest waiting Task."
},
"longest_relative_task_age_in_queue": {
"type": "integer",
"nullable": true,
"description": "The relative age in the TaskQueue for the longest waiting Task. Calculation is based on the time when the Task entered the TaskQueue."
},
"longest_relative_task_sid_in_queue": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WT[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The Task SID of the Task waiting in the TaskQueue the longest. Calculation is based on the time when the Task entered the TaskQueue."
},
"task_queue_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WQ[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the TaskQueue from which these statistics were calculated."
},
"tasks_by_priority": {
"nullable": true,
"description": "The number of Tasks by priority. For example: `{\"0\": \"10\", \"99\": \"5\"}` shows 10 Tasks at priority 0 and 5 at priority 99."
},
"tasks_by_status": {
"nullable": true,
"description": "The number of Tasks by their current status. For example: `{\"pending\": \"1\", \"reserved\": \"3\", \"assigned\": \"2\", \"completed\": \"5\"}`."
},
"total_available_workers": {
"type": "integer",
"nullable": true,
"description": "The total number of Workers available for Tasks in the TaskQueue."
},
"total_eligible_workers": {
"type": "integer",
"nullable": true,
"description": "The total number of Workers eligible for Tasks in the TaskQueue, independent of their Activity state."
},
"total_tasks": {
"type": "integer",
"nullable": true,
"description": "The total number of Tasks."
},
"workspace_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WS[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workspace that contains the TaskQueue."
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The absolute URL of the TaskQueue statistics resource."
}
}
},
"taskrouter.v1.workspace.task_queue.task_queue_statistics": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource."
},
"cumulative": {
"nullable": true,
"description": "An object that contains the cumulative statistics for the TaskQueue."
},
"realtime": {
"nullable": true,
"description": "An object that contains the real-time statistics for the TaskQueue."
},
"task_queue_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WQ[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the TaskQueue from which these statistics were calculated."
},
"workspace_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WS[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workspace that contains the TaskQueue."
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The absolute URL of the TaskQueue statistics resource."
}
}
},
"taskrouter.v1.workspace.task_queue.task_queues_statistics": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource."
},
"cumulative": {
"nullable": true,
"description": "An object that contains the cumulative statistics for the TaskQueues."
},
"realtime": {
"nullable": true,
"description": "An object that contains the real-time statistics for the TaskQueues."
},
"task_queue_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WQ[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the TaskQueue from which these statistics were calculated."
},
"workspace_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WS[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workspace that contains the TaskQueues."
}
}
},
"taskrouter.v1.workspace.task.task_reservation": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskReservation resource."
},
"date_created": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"date_updated": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format."
},
"reservation_status": {
"type": "string",
"$ref": "#/components/schemas/task_reservation_enum_status",
"nullable": true,
"description": "The current status of the reservation. Can be: `pending`, `accepted`, `rejected`, or `timeout`."
},
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WR[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique string that we created to identify the TaskReservation resource."
},
"task_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WT[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the reserved Task resource."
},
"worker_name": {
"type": "string",
"nullable": true,
"description": "The `friendly_name` of the Worker that is reserved."
},
"worker_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WK[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the reserved Worker resource."
},
"workspace_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WS[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Workspace that this task is contained within."
},
"url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The absolute URL of the TaskReservation reservation."
},
"links": {
"type": "object",
"format": "uri-map",
"nullable": true,
"description": "The URLs of related resources."
}
}
},
"task_reservation_enum_status": {
"type": "string",
"enum": [
"pending",
"accepted",
"rejected",
"timeout",
"canceled",
"rescinded",
"wrapping",
"completed"
]
},
"task_reservation_enum_call_status": {
"type": "string",
"enum": [
"initiated",
"ringing",
"answered",
"completed"
]
},
"task_reservation_enum_conference_event": {
"type": "string",
"enum": [
"start",
"end",
"join",
"leave",
"mute",
"hold",
"speaker"
]
},
"task_reservation_enum_supervisor_mode": {
"type": "string",
"enum": [
"monitor",
"whisper",
"barge"
]
},
"taskrouter.v1.workspace.worker": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Worker resource."
},
"activity_name": {
"type": "string",
"nullable": true,
"description": "The `friendly_name` of the Worker's current Activity."
},
"activity_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^WA[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the Worker's current Activity."
},
"attributes": {