/
telephony.yml
1112 lines (1108 loc) · 31.5 KB
/
telephony.yml
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
openapi: 3.0.0
info:
title: Telephony
description:
The Vonage Business Telephony API enables you to manage calls and retrieve device registration information.
version: 1.0.1
servers:
- url: https://api.vonage.com/t/vbc.prod/telephony/v3
paths:
/cc/accounts/{account_id}/calls:
get:
operationId: GetCalls
tags:
- Call
summary: Get list of active calls for a given account (paginated). Please use Reports API to get list of completed calls.
parameters:
- name: extension
in: query
schema:
type: string
example: 1234
- name: page_size
in: query
description:
Return max this amount of calls in the response.
schema:
type: string
example: 100
default: 100
- name: order
in: query
description:
Either ascending or descending order.<br/>Must be one of `asc` or `desc`.
schema:
type: string
example: asc
- name: start_time
in: query
description:
Return the calls that occurred after this point in time.<br/>Should be of type `epoch` with seconds precision.
schema:
type: string
example: 1595955770
- name: end_time
in: query
description:
Return the calls that occurred before this point in time.<br/>Should be of type `epoch` with seconds precision.
schema:
type: integer
example: 1595955770
- name: account_id
in: path
required: true
schema:
type: string
example: 1234
responses:
"200":
description: 200 response
content:
application/json:
schema:
$ref: "#/components/schemas/CallsPaginated"
text/plain:
schema:
$ref: "#/components/schemas/CallsPaginated"
"401":
description: 401 response
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
text/plain:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
"404":
description: 404 response
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundMessage"
text/plain:
schema:
$ref: "#/components/schemas/NotFoundMessage"
security:
- bearerAuth: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
post:
operationId: postCalls
tags:
- Call
summary: Create a new call
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 1234
requestBody:
description: Request body description
content:
application/json:
schema:
$ref: "#/components/schemas/CallPostRequestBody"
required: true
responses:
"200":
description: 200 response
content:
text/plain:
schema:
$ref: "#/components/schemas/StatusMessage"
application/json:
schema:
$ref: "#/components/schemas/StatusMessage"
"400":
description: 400 response
content:
text/plain:
schema:
$ref: "#/components/schemas/ValidationErrorMessage"
application/json:
schema:
$ref: "#/components/schemas/ValidationErrorMessage"
"401":
description: 401 response
content:
text/plain:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
application/json:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
security:
- bearerAuth: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
x-codegen-request-body-name: body
/cc/accounts/{account_id}/calls/{call_id}:
get:
operationId: getCallsByCallId
tags:
- Call
summary: Get details for a specific active call.
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 1234
- name: call_id
in: path
required: true
schema:
type: string
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
responses:
"200":
description: 200 response
content:
application/json:
schema:
$ref: "#/components/schemas/Call"
text/plain:
schema:
$ref: "#/components/schemas/Call"
"401":
description: 401 response
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
text/plain:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
"404":
description: 404 response
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundMessage"
text/plain:
schema:
$ref: "#/components/schemas/NotFoundMessage"
security:
- bearerAuth: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
put:
operationId: putCallsByCallId
tags:
- Call
summary: Update an existing call
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 12345
- name: call_id
in: path
required: true
schema:
type: string
example: c91150a6-8cc4-4e73-9fef-17fd925c6448
requestBody:
description: |-
To answer a call: 'state' should be 'active', and 'to' should include the VH id of the device answering the call. To transfer a call: 'state' should not be specified. Both 'to' and 'from' should be specified. To park a call: 'state' should be 'parked', and 'from' should be specified.
<br>
content:
application/json:
schema:
$ref: "#/components/schemas/CallPutRequestBody"
required: true
responses:
"200":
description: 200 response
content:
application/json:
schema:
$ref: "#/components/schemas/ModifyCallResponse"
"400":
description: 400 response
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationErrorMessage"
"401":
description: 401 response
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
"404":
description: 404 response
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundMessage"
security:
- bearerAuth: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
x-codegen-request-body-name: body
delete:
operationId: deleteCallByCallId
tags:
- Call
summary: Delete a call resource
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 1234
- name: call_id
in: path
required: true
schema:
type: string
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
responses:
"200":
description: 200 response
content:
application/json:
schema:
$ref: "#/components/schemas/ModifyCallResponse"
text/plain:
schema:
$ref: "#/components/schemas/ModifyCallResponse"
"401":
description: 401 response
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
text/plain:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
"404":
description: 404 response
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundMessage"
text/plain:
schema:
$ref: "#/components/schemas/NotFoundMessage"
security:
- bearerAuth: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
/cc/accounts/{account_id}/calls/{call_id}/legs:
get:
operationId: getCallLegs
tags:
- Call Leg
summary: Get list of legs for a given active call
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 1234
- name: call_id
in: path
required: true
schema:
type: string
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
responses:
"200":
description: 200 response
content:
application/json:
schema:
$ref: "#/components/schemas/CallLegList"
text/plain:
schema:
$ref: "#/components/schemas/CallLegList"
"401":
description: 401 response
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
text/plain:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
security:
- bearerAuth: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
/cc/accounts/{account_id}/calls/{call_id}/legs/{leg_id}:
get:
operationId: getCallLegByLegId
tags:
- Call Leg
summary: Get details for a specific active call leg
parameters:
- name: leg_id
in: path
required: true
schema:
type: string
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
- name: account_id
in: path
required: true
schema:
type: string
example: 1234
- name: call_id
in: path
required: true
schema:
type: string
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
responses:
"200":
description: 200 response
content:
application/json:
schema:
$ref: "#/components/schemas/CallLeg"
text/plain:
schema:
$ref: "#/components/schemas/CallLeg"
"401":
description: 401 response
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
text/plain:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
security:
- bearerAuth: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
put:
operationId: updateCallLegByLegId
tags:
- Call Leg
summary: Modify a call leg.
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 1234
- name: call_id
in: path
required: true
schema:
type: string
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
- name: leg_id
in: path
required: true
schema:
type: string
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
requestBody:
description:
"Perform hold or unhold or send dtmf or transfer on the call leg."
content:
application/json:
schema:
oneOf:
- title: Hold
x-tab-id: Hold
oneOf:
- title: Held
x-tab-id: Held
type: object
properties:
state:
type: string
example: held
- title: Unhold
x-tab-id: Unhold
type: object
properties:
state:
type: string
example: active
- title: DTMF
x-tab-id: DTMF
type: object
properties:
dtmf:
type: string
example: "*123#"
- title: Play Sound
x-tab-id: Play Sound
type: object
properties:
stream:
type: boolean
example: true
stream_url:
type: string
example: "https://example.com/recorded_message.wav"
- title: Stop Sound
x-tab-id: Stop Sound
type: object
properties:
stream:
type: boolean
example: false
- title: Blind XFER
x-tab-id: Blind XFER
type: object
properties:
state:
type: string
example: "active"
to:
type: object
example: "{'destination': Contact, 'type': ttype}"
- title: ATT XFER
x-tab-id: ATT XFER
type: object
properties:
state:
type: string
example: "active"
to:
type: object
example: "{'destination': leg_id,'type': 'leg'}"
- title: Active
x-tab-id: Active
type: object
properties:
state:
type: string
example: "active"
- title: Record
x-tab-id: Record
oneOf:
- title: CCR Start
x-tab-id: CCR Start
type: object
properties:
recording:
type: string
example: start
service:
type: string
example: ccr
- title: CCR Stop
x-tab-id: CCR Stop
type: object
properties:
recording:
type: string
example: stop
service:
type: string
example: ccr
- title: OCR Start
x-tab-id: OCR Start
type: object
properties:
recording:
type: string
example: start
service:
type: string
example: ocr
- title: OCR Stop
x-tab-id: OCR Stop
type: object
properties:
recording:
type: string
example: stop
service:
type: string
example: ocr
required: true
responses:
"200":
description: 200 response
content:
application/json:
schema:
$ref: "#/components/schemas/ModifyLegResponse"
"400":
description: 400 response
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationErrorMessage"
"401":
description: 401 response
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
"404":
description: 404 response
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundMessage"
"409":
description: 409 response if conflict while changing state of a leg
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationErrorMessage"
security:
- bearerAuth: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
x-codegen-request-body-name: body
delete:
operationId: updateCallLeg
tags:
- Call Leg
summary: Delete a call leg.
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 1234
- name: call_id
in: path
required: true
schema:
type: string
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
- name: leg_id
in: path
required: true
schema:
type: string
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
responses:
"204":
description: 204 response
content: {}
"400":
description: 400 response
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationErrorMessage"
"401":
description: 401 response
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
"404":
description: 404 response
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundMessage"
"409":
description: 409 response if conflict while changing state of a leg
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationErrorMessage"
security:
- bearerAuth: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
/registration/accounts/{account_id}/devices:
get:
operationId: getDevices
tags:
- Device registration
summary: Get account device's registration info
parameters:
- name: page_size
in: query
description:
Return max this number of devices in the response.
schema:
type: string
default: 100
example: 10
- name: order
in: query
description:
Either ascending or descending order.<br/>Must be one of `asc` or `desc`.
schema:
type: string
example: "asc"
- name: start_time
in: query
description:
Return the devices that were registered after this point in time.<br/>Should be of type `epoch` with seconds precision.
schema:
type: string
example: 1595955770
- name: end_time
in: query
description:
Return the devices that were registered before this point in time.<br/>Should be of type `epoch` with seconds precision.
schema:
type: integer
example: 1595955770
- name: account_id
in: path
required: true
schema:
type: string
example: 1234
responses:
"200":
description: 200 response
content:
application/json:
schema:
$ref: "#/components/schemas/AccountsRegPaginated"
text/plain:
schema:
$ref: "#/components/schemas/AccountsRegPaginated"
"401":
description: 401 response
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
text/plain:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
security:
- bearerAuth: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
/registration/accounts/{account_id}/devices/{device_id}:
get:
operationId: getDeviceByDeviceId
tags:
- Device registration
summary: Get device registration info
parameters:
- name: account_id
in: path
required: true
schema:
type: string
example: 1234
- name: device_id
in: path
description: Mac address of device
required: true
schema:
type: string
example: 38-99-62-93-E2-A9
responses:
"200":
description: 200 response
content:
application/json:
schema:
$ref: "#/components/schemas/RegistrationInfo"
text/plain:
schema:
$ref: "#/components/schemas/RegistrationInfo"
"401":
description: 401 response
content:
application/json:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
text/plain:
schema:
$ref: "#/components/schemas/AuthorizationErrorMessage"
"404":
description: 404 response
content:
application/json:
schema:
$ref: "#/components/schemas/NotFoundMessage"
text/plain:
schema:
$ref: "#/components/schemas/NotFoundMessage"
security:
- bearerAuth: []
x-auth-type: Application & Application User
x-throttling-tier: Unlimited
components:
schemas:
AccountsRegPaginated:
type: object
properties:
current_page:
type: string
example: 1
devices:
type: array
items:
$ref: "#/components/schemas/RegistrationInfo"
first_page_uri:
type: string
example: /registration/accounts/1234/devices?page_size=100&order=desc
next_page:
type: string
next_page_uri:
type: string
example: /registration/accounts/1234/devices?page_size=100&order=desc
order:
type: string
example: desc
page_size:
type: string
example: 10
pages:
type: string
example: 2
previous_page_uri:
type: string
example: /registration/accounts/1234/devices?page_size=100&order=desc
AuthorizationErrorMessage:
type: object
properties:
code:
type: integer
example: 401
message:
type: string
example: User is not permitted to make a request against this account
Call:
type: object
properties:
account_id:
type: string
example: 1234
call_id:
type: string
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
direction:
type: string
enum:
- inbound
- outbound
example: inbound
end_time:
type: string
format: date-time
example: 1595959736
from:
type: string
example: 1235551111
legs:
type: array
items:
$ref: "#/components/schemas/CallLeg"
start_time:
type: string
format: date-time
example: 1595959736
status:
type: string
enum:
- busy
- failed
- unanswered
- ringing
- on-call
example: busy
to:
type: string
example: 1234567890
CallLeg:
type: object
properties:
account_id:
type: string
description: Account that this call leg belongs to
example: 1234
call_id:
type: string
description: Call Id this call belongs to
format: uuid
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
direction:
type: string
description: Leg direction - either "inbound" or "outbound"
enum:
- inbound
- outbound
example: inbound
end_time:
type: string
description: Call end time (if applicable)
format: date-time
example: 1595959736
from:
type: string
description: The "from" DID or extension
example: 1231112222
leg_id:
type: string
description: Globally unique leg Id
format: uuid
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
start_time:
type: string
description: Call start time
format: date-time
example: 1595959736
status:
type: string
description: current leg status
enum:
- busy
- failed
- unanswered
- ringing
- on-call
example: busy
to:
type: string
description: The "to" DID or extension
example: 1234567890
description: Object representation of a call leg
CallLegList:
type: array
items:
$ref: "#/components/schemas/CallLeg"
CallList:
type: array
items:
$ref: "#/components/schemas/Call"
CallPostRequestBody:
type: object
properties:
from:
$ref: "#/components/schemas/CreateCallContactFrom"
to:
$ref: "#/components/schemas/CreateCallContact"
type:
type: string
enum:
- click2dial
- click2dialme
- odr
- default
example: click2dial
CallPutRequestBody:
type: object
properties:
from:
$ref: "#/components/schemas/Contact"
state:
type: string
enum:
- active
- parked
to:
$ref: "#/components/schemas/Contact"
CallsPaginated:
type: object
properties:
calls:
$ref: "#/components/schemas/CallList"
current_page:
type: string
example: 0
first_page_uri:
type: string
example: /cc/accounts/1234/calls?page_size=0&order=desc
next_page:
type: string
example: 1
next_page_uri:
type: string
example: /cc/accounts/1234/calls?page_size=0&order=desc
order:
type: string
example: desc
page_size:
type: string
example: 1
pages:
type: string
example: 1
previous_page_uri:
type: string
example: /cc/accounts/1234/calls?page_size=0&order=desc
Contact:
type: object
properties:
destination:
type: string
example: 1234567890
type:
type: string
enum:
- device
- extension
- pstn
example: pstn
CreateCallContact:
type: object
properties:
destination:
type: string
example: 1234567890
type:
type: string
enum:
- device
- extension
- pstn
- feature_code
example: pstn
CreateCallContactFrom:
type: object
properties:
destination:
type: string
example: 1234
type:
type: string
enum:
- device
- extension
- feature_code
example: extension
LegAttTransferRequestBody:
type: object
properties:
to:
type: string
format: uuid
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
LegBlindTransferRequestBody:
type: object
properties:
to:
$ref: "#/components/schemas/Contact"
LegDTMFRequestBody:
type: object
properties:
dtmf:
type: string
LegHoldRequestBody: