-
Notifications
You must be signed in to change notification settings - Fork 13
/
swagger_spec.yaml
21690 lines (21690 loc) · 767 KB
/
swagger_spec.yaml
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
---
swagger: "2.0"
info:
description: "<p>This is a beta interactive API explorer for the RingCentral Connect Platform. To use this service, you will need to have an account with the proper credentials to generate an OAuth2 access token.</p><p><h2>Quick Start</h2></p><ol><li>1) Go to <b>Authentication > /oauth/token</b></li><li>2) Enter <b>app_key, app_secret, username, password</b> fields and then click \"Try it out!\"</li><li>3) Upon success, your access_token is loaded and you can access any form requiring authorization.</li></ol><h2>Links</h2><ul><li><a href=\"https://github.com/ringcentral\" target=\"_blank\">RingCentral SDKs on Github</a></li><li><a href=\"mailto:devsupport@ringcentral.com\">RingCentral Developer Support Email</a></li></ul>"
version: "1.0"
title: "RingCentral Connect Platform API Explorer"
termsOfService: "https://developer.ringcentral.com"
host: "platform.devtest.ringcentral.com"
basePath: "/"
tags:
-
name: "Overview"
description: " "
-
name: "OAuth 2.0 Authentication & Authorization"
description: " "
-
name: "API Info"
description: " "
-
name: "Call Log"
description: " "
-
name: "Phone Numbers"
description: " "
-
name: "Messages"
description: " "
-
name: "RingOut"
description: " "
-
name: "User Contacts"
description: " "
-
name: "Company Contacts"
description: " "
-
name: "Presence"
description: " "
-
name: "Glip"
description: " "
-
name: "Meetings"
description: " "
-
name: "Push Notifications"
description: " "
-
name: "Roles and Permissions"
description: " "
-
name: "Call Handling Settings"
description: " "
-
name: "Application Settings"
description: " "
-
name: "User Settings"
description: " "
-
name: "Company Settings"
description: " "
-
name: "Regional Settings"
description: " "
-
name: "Account Provisioning"
description: " "
-
name: "SCIM"
description: " "
-
name: "Reporting"
description: " "
schemes:
- "https"
securityDefinitions:
OAuth2:
type: "oauth2"
flow: "accessCode"
authorizationUrl: "https://platform.devtest.ringcentral.com/restapi/oauth/authorize"
tokenUrl: "https://platform.devtest.ringcentral.com/restapi/oauth/token"
scopes: {}
security:
- OAuth2: []
paths:
/restapi:
get:
tags:
- "API Info"
summary: "Get API Versions"
description: "<p style='font-style:italic;'>Since 1.0.0</p><p>Returns current API version(s) and server info.</p><h4>Usage Plan Group</h4><p>Light</p>"
operationId: "getAPIVersion"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
default:
description: "Success"
schema:
$ref: "#/definitions/GetVersionsResponse"
x-api-group: "restapi"
x-auth-required: false
x-throttling-group: "NoThrottling"
x-metered-api: true
x-metering-group: "Free"
x-access-level: "Public"
/restapi/{apiVersion}:
get:
tags:
- "API Info"
summary: "Get Version Info"
description: "<p style='font-style:italic;'>Since 1.0.0</p><p>Returns current API version info by apiVersion.</p><h4>Usage Plan Group</h4><p>Light</p>"
operationId: "getVersionInfo"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "apiVersion"
in: "path"
description: "API version to be requested, for example 'v1.0'"
required: true
type: "string"
responses:
default:
description: "Success"
schema:
$ref: "#/definitions/GetVersionResponse"
x-api-group: "restapi/version"
x-auth-required: false
x-throttling-group: "NoThrottling"
x-metered-api: true
x-metering-group: "Free"
x-access-level: "Public"
/restapi/v1.0/status:
get:
tags:
- "API Info"
summary: "Get Status"
description: "<p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Returns the API status; status '200' means the API is working fine, and '503' means it is temporary unavailable.</p><h4>API Group</h4><p>Light</p>"
operationId: "loadAPIStatus"
consumes:
- "application/json"
produces:
- "application/json"
parameters: []
responses:
default:
description: "Success"
x-api-group: "restapi/status"
x-auth-required: false
x-throttling-group: "NoThrottling"
x-metered-api: true
x-metering-group: "Free"
x-access-level: "Public"
/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log:
get:
tags:
- "Call Log"
summary: "Get Call Log Records by Filter"
description: "<p style='font-style:italic;'>Since 1.0.3 (Release 5.11)</p><p>Returns call log records filtered by the specified parameters.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
operationId: "loadExtensionCallLog"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "accountId"
in: "path"
description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "extensionId"
in: "path"
description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "extensionNumber"
in: "query"
description: "Extension number of a user. If specified, returns call log for a particular extension only. Cannot be specified together with the phoneNumber filter"
required: false
type: "string"
-
name: "showBlocked"
in: "query"
type: "boolean"
description: "If 'True' then calls from/to blocked numbers are returned. The default value is 'True'"
required: false
-
name: "phoneNumber"
in: "query"
description: "Phone number of a caller/call recipient. If specified, returns all calls (both incoming and outcoming) with the mentioned phone number. Cannot be specified together with the extensionNumber filter"
required: false
type: "string"
-
name: "direction"
in: "query"
description: "The direction for the result records. It is allowed to specify more than one direction. If not specified, both inbound and outbound records are returned. Multiple values are accepted"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Inbound"
- "Outbound"
-
name: "sessionId"
in: "query"
required: false
type: "string"
-
name: "type"
in: "query"
description: "Call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned. Multiple values are accepted"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Voice"
- "Fax"
-
name: "transport"
in: "query"
description: "Call transport type. 'PSTN' specifies that a call leg is initiated from the PSTN network provider; 'VoIP' - from an RC phone. By default this filter is disabled"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "PSTN"
- "VoIP"
-
name: "view"
in: "query"
description: "The default value is 'Simple' for both account and extension call log"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Simple"
- "Detailed"
-
name: "withRecording"
in: "query"
description: "'True' if only recorded calls have to be returned"
required: false
type: "boolean"
-
name: "dateTo"
in: "query"
description: "The end datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time"
required: false
type: "string"
format: "date-time"
-
name: "dateFrom"
in: "query"
description: "The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours"
required: false
type: "string"
format: "date-time"
-
name: "page"
in: "query"
description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
required: false
type: "integer"
-
name: "perPage"
in: "query"
description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
required: false
type: "integer"
responses:
default:
description: "Success"
schema:
$ref: "#/definitions/ExtensionCallLogResponse"
x-api-group: "extension/call-log"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "ReadCallLog"
x-user-permission: "ReadCallLog"
x-access-level: "Public"
delete:
tags:
- "Call Log"
summary: "Delete Call Log Records by Filter"
description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCallLog</td><td>Viewing and updating user call logs</td></tr><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
operationId: "deleteExtensionCallLog"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "accountId"
in: "path"
description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "extensionId"
in: "path"
description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "dateTo"
in: "query"
description: "The end datetime for records deletion in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time"
required: false
type: "string"
-
name: "phoneNumber"
in: "query"
required: false
type: "string"
-
name: "extensionNumber"
in: "query"
required: false
type: "string"
-
name: "type"
in: "query"
required: false
type: "array"
items:
type: "string"
enum:
- "Voice"
- "Fax"
collectionFormat: "multi"
-
name: "direction"
in: "query"
required: false
type: "array"
items:
type: "string"
enum:
- "Inbound"
- "Outbound"
collectionFormat: "multi"
-
name: "dateFrom"
in: "query"
required: false
type: "string"
format: "date-time"
responses:
default:
description: "Success"
x-api-group: "extension/call-log"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "EditCallLog"
x-user-permission: "EditCallLog"
x-access-level: "Advanced"
/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log-sync:
get:
tags:
- "Call Log"
summary: "Call Log Synchronization"
description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
operationId: "syncExtensionCallLog"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "accountId"
in: "path"
description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "extensionId"
in: "path"
description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "syncType"
in: "query"
description: "Type of synchronization. 'FSync' is a default value"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "FSync"
- "ISync"
-
name: "syncToken"
in: "query"
description: "Value of syncToken property of last sync request response"
required: false
type: "string"
-
name: "dateFrom"
in: "query"
description: "The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment"
required: false
type: "string"
-
name: "recordCount"
in: "query"
description: "ForT?FSync the parameter is mandatory, it limits the number of records to be returned in response. For ISync it specifies with how many records to extend sync Frame to the past, the maximum number of records is 250"
required: false
type: "integer"
-
name: "statusGroup"
in: "query"
description: "Type of calls to be returned. The default value is 'All'"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Missed"
- "All"
responses:
default:
description: "Success"
schema:
$ref: "#/definitions/CallLogSync"
x-api-group: "extension/call-log-sync"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "ReadCallLog"
x-user-permission: "ReadCallLog"
x-access-level: "Advanced"
/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log/{callRecordId}:
get:
tags:
- "Call Log"
summary: "Get Call Records by ID"
operationId: "getCallRecords"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "callRecordId"
in: "path"
required: true
type: "array"
items:
type: "string"
collectionFormat: "csv"
-
name: "view"
in: "query"
required: false
type: "string"
enum:
- "Simple"
- "Detailed"
-
name: "extensionId"
in: "path"
required: true
type: "string"
-
name: "accountId"
in: "path"
required: true
type: "string"
responses:
default:
description: "successful operation"
schema:
$ref: "#/definitions/UserCallLogRecord"
x-api-group: "extension/call-log"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "ReadCallLog"
x-user-permission: "ReadCallLog"
x-access-level: "Public"
/restapi/v1.0/account/{accountId}/extension/{extensionId}/active-calls:
get:
tags:
- "Call Log"
summary: "Get User Active Calls"
description: "<p style='font-style:italic;'>Since 1.0.13 (Release 6.5)</p><p>Returns records of all extension calls that are in progress, ordered by start time in descending order.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
operationId: "listExtensionActiveCalls"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "accountId"
in: "path"
description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "extensionId"
in: "path"
description: "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "direction"
in: "query"
description: "The direction for the result records. It is allowed to specify more than one direction. If not specified, both inbound and outbound records are returned. Multiple values are accepted"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Inbound"
- "Outbound"
-
name: "type"
in: "query"
description: "Call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned. Multiple values are accepted"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Voice"
- "Fax"
-
name: "page"
in: "query"
description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
required: false
type: "integer"
-
name: "perPage"
in: "query"
description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
required: false
type: "integer"
responses:
default:
description: "Success"
schema:
$ref: "#/definitions/ExtensionActiveCallsResponse"
x-api-group: "extension/active-calls"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "ReadCallLog"
x-user-permission: "ReadCallLog"
x-access-level: "Public"
/restapi/v1.0/account/{accountId}/call-log:
get:
tags:
- "Call Log"
summary: "Get Call Log Records by Filter"
description: "<p style='font-style:italic;'>Since 1.0.3 (Release 5.11)</p><p>Returns call log records filtered by the specified parameters.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
operationId: "loadAccountCallLog"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "accountId"
in: "path"
description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "extensionNumber"
in: "query"
description: "Extension number of a user. If specified, returns call log for a particular extension only. Cannot be specified together with the phoneNumber filter"
required: false
type: "string"
-
name: "phoneNumber"
in: "query"
description: "Phone number of a caller/call recipient. If specified, returns all calls (both incoming and outcoming) with the mentioned phone number. Cannot be specified together with the extensionNumber filter"
required: false
type: "string"
-
name: "direction"
in: "query"
description: "The direction for the result records. It is allowed to specify more than one direction. If not specified, both inbound and outbound records are returned. Multiple values are accepted"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Inbound"
- "Outbound"
-
name: "type"
in: "query"
description: "Call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned. Multiple values are accepted"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Voice"
- "Fax"
-
name: "view"
in: "query"
description: "The default value is 'Simple' for both account and extension call log"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Simple"
- "Detailed"
-
name: "withRecording"
in: "query"
description: "'True' if only recorded calls have to be returned"
required: false
type: "boolean"
-
name: "dateFrom"
in: "query"
description: "The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours"
required: false
type: "string"
format: "date-time"
-
name: "dateTo"
in: "query"
description: "The end datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time"
required: false
type: "string"
format: "date-time"
-
name: "page"
in: "query"
description: "Indicates the page number to retrieve. Only positive number values are allowed. The default value is '1'"
required: false
type: "integer"
-
name: "perPage"
in: "query"
description: "Indicates the page size (number of items). If not specified, the value is '100' by default."
required: false
type: "integer"
-
name: "sessionId"
in: "query"
required: false
type: "string"
responses:
default:
description: "Success"
schema:
$ref: "#/definitions/AccountCallLogResponse"
x-api-group: "account/call-log"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "ReadCallLog"
x-user-permission: "FullCompanyCallLog"
x-access-level: "Public"
delete:
tags:
- "Call Log"
summary: "Delete Call Log Records by Filter"
description: "<p style='font-style:italic;'></p><p></p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>EditCallLog</td><td>Viewing and updating user call logs</td></tr><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
operationId: "deleteAccountCallLog"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "accountId"
in: "path"
description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "dateTo"
in: "query"
description: "The end datetime for records deletion in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time"
required: false
type: "string"
responses:
default:
description: "Success"
x-api-group: "account/call-log"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "EditCallLog"
x-user-permission: "FullCompanyCallLog"
x-access-level: "Internal"
/restapi/v1.0/account/{accountId}/call-log-sync:
get:
tags:
- "Call Log"
summary: "Call Log Synchronization"
operationId: "syncAccountCallLog"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "accountId"
in: "path"
description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "syncType"
in: "query"
description: "Type of synchronization. 'FSync' is a default value"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "FSync"
- "ISync"
-
name: "syncToken"
in: "query"
description: "Value of syncToken property of last sync request response"
required: false
type: "string"
-
name: "dateFrom"
in: "query"
description: "The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment"
required: false
type: "string"
-
name: "recordCount"
in: "query"
description: "ForT?FSync the parameter is mandatory, it limits the number of records to be returned in response. For ISync it specifies with how many records to extend sync Frame to the past, the maximum number of records is 250"
required: false
type: "integer"
-
name: "statusGroup"
in: "query"
description: "Type of calls to be returned. The default value is 'All'"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Missed"
- "All"
responses:
default:
description: "Success"
x-api-group: "account/call-log-sync"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "ReadCallLog"
x-user-permission: "ReadCallLog"
x-access-level: "Internal"
/restapi/v1.0/account/{accountId}/call-log/{callRecordId}:
get:
tags:
- "Call Log"
summary: "Get Account Call Log Record(s) by ID"
description: "<p style='font-style:italic;'>Since 1.0.3 (Release 5.11)</p><p>Returns individual call log record(s) by ID(s). Batch request is supported, see Batch Requests for details.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
operationId: "loadAccountCallLogRecord"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "accountId"
in: "path"
description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "callRecordId"
in: "path"
description: "Internal identifier of a call log record"
required: true
type: "integer"
responses:
default:
description: "Success"
schema:
$ref: "#/definitions/GetAccountCallLogRecordResponse"
x-api-group: "account/call-log"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "ReadCallLog"
x-user-permission: "FullCompanyCallLog"
x-access-level: "Advanced"
delete:
tags:
- "Call Log"
summary: "Delete Account Call Log Record(s) by ID"
operationId: "deleteAccountCallLogRecord"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "accountId"
in: "path"
description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "callRecordId"
in: "path"
description: "Internal identifier of a call log record"
required: true
type: "integer"
responses:
default:
description: "Success"
x-api-group: "account/call-log"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "EditCallLog"
x-user-permission: "FullCompanyCallLog"
/restapi/v1.0/account/{accountId}/active-calls:
get:
tags:
- "Call Log"
summary: "Get User Active Calls"
description: "<p style='font-style:italic;'>Since 1.0.13 (Release 6.5)</p><p>Returns records of all calls that are in progress, ordered by start time in descending order</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallLog</td><td>Viewing user call logs</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
operationId: "listCompanyActiveCalls"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "accountId"
in: "path"
description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "direction"
in: "query"
description: "The direction for the result records. It is allowed to specify more than one direction. If not specified, both inbound and outbound records are returned. Multiple values are accepted"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Inbound"
- "Outbound"
-
name: "type"
in: "query"
description: "Call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned. Multiple values are accepted"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "Voice"
- "Fax"
-
name: "transport"
in: "query"
description: "Call transport type. 'PSTN' specifies that a call leg is initiated from the PSTN network provider; 'VoIP' - from an RC phone. By default this filter is disabled"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
enum:
- "PSTN"
- "VoIP"
-
name: "page"
in: "query"
description: "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'"
required: false
type: "integer"
-
name: "perPage"
in: "query"
description: "Indicates the page size (number of items). If not specified, the value is '100' by default"
required: false
type: "integer"
responses:
default:
description: "Success"
schema:
$ref: "#/definitions/ExtensionActiveCallsResponse"
x-api-group: "company/active-calls"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "ReadCallLog"
x-user-permission: "ReadCallLog"
x-access-level: "Advanced"
/restapi/v1.0/account/{accountId}/recording/{recordingId}:
get:
tags:
- "Call Log"
summary: "Get Call Recordings"
description: "<p style='font-style:italic;'>Since 1.0.18 (Release 6.5)</p><p>Returns call recording metadata.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallRecording</td><td>Downloading call recording content</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
operationId: "listCallRecordings"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
-
name: "accountId"
in: "path"
description: "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session"
required: true
type: "string"
default: "~"
-
name: "recordingId"
in: "path"
description: "Internal identifier of a recording (returned in Call Log)"
required: true
type: "string"
responses:
default:
description: "Success"
schema:
$ref: "#/definitions/GetCallRecordingResponse"
x-api-group: "account/recordings"
x-throttling-group: "Heavy"
x-metered-api: true
x-metering-group: "System"
x-app-permission: "ReadCallRecording"
x-user-permission: "ReadCallRecording"
x-access-level: "Public"
/restapi/v1.0/account/{accountId}/recording/{recordingId}/content:
get:
tags:
- "Call Log"
summary: "Get Call Recordings Data"
description: "<p style='font-style:italic;'>Since 1.0.16 (Release 7.1)</p><p>Returns call recording metadata.</p><h4>Required Permissions</h4><table class='fullwidth'><thead><tr><th>Permission</th><th>Description</th></tr></thead><tbody><tr><td class='code'>ReadCallRecording</td><td>Downloading call recording content</td></tr></tbody></table><h4>Usage Plan Group</h4><p>Heavy</p>"
operationId: "listCallRecordingData"
consumes:
- "application/json"
produces:
- "application/json"