@stream-io/video-client 1.36.0 → 1.37.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/dist/index.browser.es.js +175 -113
- package/dist/index.browser.es.js.map +1 -1
- package/dist/index.cjs.js +175 -113
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.es.js +175 -113
- package/dist/index.es.js.map +1 -1
- package/dist/src/Call.d.ts +6 -4
- package/dist/src/gen/coordinator/index.d.ts +726 -16
- package/dist/src/rtc/BasePeerConnection.d.ts +4 -2
- package/dist/src/rtc/Publisher.d.ts +3 -3
- package/dist/src/rtc/codecs.d.ts +3 -1
- package/dist/src/rtc/helpers/sdp.d.ts +8 -0
- package/dist/src/rtc/types.d.ts +4 -5
- package/dist/src/types.d.ts +6 -0
- package/package.json +1 -1
- package/src/Call.ts +26 -26
- package/src/StreamVideoClient.ts +2 -9
- package/src/__tests__/StreamVideoClient.api.test.ts +5 -19
- package/src/__tests__/StreamVideoClient.ringing.test.ts +55 -6
- package/src/gen/coordinator/index.ts +708 -16
- package/src/rtc/BasePeerConnection.ts +7 -2
- package/src/rtc/Publisher.ts +13 -5
- package/src/rtc/Subscriber.ts +10 -1
- package/src/rtc/__tests__/Publisher.test.ts +12 -8
- package/src/rtc/codecs.ts +13 -2
- package/src/rtc/helpers/__tests__/sdp.codecs.test.ts +628 -0
- package/src/rtc/helpers/sdp.ts +82 -0
- package/src/rtc/types.ts +4 -4
- package/src/types.ts +6 -0
|
@@ -1207,7 +1207,7 @@ export interface CallMissedEvent {
|
|
|
1207
1207
|
user: UserResponse;
|
|
1208
1208
|
}
|
|
1209
1209
|
/**
|
|
1210
|
-
*
|
|
1210
|
+
* This event is sent when a moderation blur action is applied to a user's video stream
|
|
1211
1211
|
* @export
|
|
1212
1212
|
* @interface CallModerationBlurEvent
|
|
1213
1213
|
*/
|
|
@@ -1225,26 +1225,26 @@ export interface CallModerationBlurEvent {
|
|
|
1225
1225
|
*/
|
|
1226
1226
|
created_at: string;
|
|
1227
1227
|
/**
|
|
1228
|
-
*
|
|
1228
|
+
* Custom data associated with the moderation action
|
|
1229
1229
|
* @type {{ [key: string]: any; }}
|
|
1230
1230
|
* @memberof CallModerationBlurEvent
|
|
1231
1231
|
*/
|
|
1232
1232
|
custom: { [key: string]: any };
|
|
1233
1233
|
/**
|
|
1234
|
-
*
|
|
1234
|
+
* The type of event: "call.moderation_blur" in this case
|
|
1235
1235
|
* @type {string}
|
|
1236
1236
|
* @memberof CallModerationBlurEvent
|
|
1237
1237
|
*/
|
|
1238
1238
|
type: string;
|
|
1239
1239
|
/**
|
|
1240
|
-
*
|
|
1240
|
+
* The user ID whose video stream is being blurred
|
|
1241
1241
|
* @type {string}
|
|
1242
1242
|
* @memberof CallModerationBlurEvent
|
|
1243
1243
|
*/
|
|
1244
1244
|
user_id: string;
|
|
1245
1245
|
}
|
|
1246
1246
|
/**
|
|
1247
|
-
*
|
|
1247
|
+
* This event is sent when a moderation warning is issued to a user
|
|
1248
1248
|
* @export
|
|
1249
1249
|
* @interface CallModerationWarningEvent
|
|
1250
1250
|
*/
|
|
@@ -1262,25 +1262,25 @@ export interface CallModerationWarningEvent {
|
|
|
1262
1262
|
*/
|
|
1263
1263
|
created_at: string;
|
|
1264
1264
|
/**
|
|
1265
|
-
*
|
|
1265
|
+
* Custom data associated with the moderation action
|
|
1266
1266
|
* @type {{ [key: string]: any; }}
|
|
1267
1267
|
* @memberof CallModerationWarningEvent
|
|
1268
1268
|
*/
|
|
1269
1269
|
custom: { [key: string]: any };
|
|
1270
1270
|
/**
|
|
1271
|
-
*
|
|
1271
|
+
* The warning message
|
|
1272
1272
|
* @type {string}
|
|
1273
1273
|
* @memberof CallModerationWarningEvent
|
|
1274
1274
|
*/
|
|
1275
1275
|
message: string;
|
|
1276
1276
|
/**
|
|
1277
|
-
*
|
|
1277
|
+
* The type of event: "call.moderation_warning" in this case
|
|
1278
1278
|
* @type {string}
|
|
1279
1279
|
* @memberof CallModerationWarningEvent
|
|
1280
1280
|
*/
|
|
1281
1281
|
type: string;
|
|
1282
1282
|
/**
|
|
1283
|
-
*
|
|
1283
|
+
* The user ID who is receiving the warning
|
|
1284
1284
|
* @type {string}
|
|
1285
1285
|
* @memberof CallModerationWarningEvent
|
|
1286
1286
|
*/
|
|
@@ -2221,6 +2221,12 @@ export interface CallSessionResponse {
|
|
|
2221
2221
|
* @memberof CallSessionResponse
|
|
2222
2222
|
*/
|
|
2223
2223
|
anonymous_participant_count: number;
|
|
2224
|
+
/**
|
|
2225
|
+
*
|
|
2226
|
+
* @type {string}
|
|
2227
|
+
* @memberof CallSessionResponse
|
|
2228
|
+
*/
|
|
2229
|
+
created_at: string;
|
|
2224
2230
|
/**
|
|
2225
2231
|
*
|
|
2226
2232
|
* @type {string}
|
|
@@ -2532,6 +2538,55 @@ export interface CallStateResponseFields {
|
|
|
2532
2538
|
*/
|
|
2533
2539
|
own_capabilities: Array<OwnCapability>;
|
|
2534
2540
|
}
|
|
2541
|
+
/**
|
|
2542
|
+
*
|
|
2543
|
+
* @export
|
|
2544
|
+
* @interface CallStatsLocation
|
|
2545
|
+
*/
|
|
2546
|
+
export interface CallStatsLocation {
|
|
2547
|
+
/**
|
|
2548
|
+
*
|
|
2549
|
+
* @type {number}
|
|
2550
|
+
* @memberof CallStatsLocation
|
|
2551
|
+
*/
|
|
2552
|
+
accuracy_radius_meters?: number;
|
|
2553
|
+
/**
|
|
2554
|
+
*
|
|
2555
|
+
* @type {string}
|
|
2556
|
+
* @memberof CallStatsLocation
|
|
2557
|
+
*/
|
|
2558
|
+
city?: string;
|
|
2559
|
+
/**
|
|
2560
|
+
*
|
|
2561
|
+
* @type {string}
|
|
2562
|
+
* @memberof CallStatsLocation
|
|
2563
|
+
*/
|
|
2564
|
+
continent?: string;
|
|
2565
|
+
/**
|
|
2566
|
+
*
|
|
2567
|
+
* @type {string}
|
|
2568
|
+
* @memberof CallStatsLocation
|
|
2569
|
+
*/
|
|
2570
|
+
country?: string;
|
|
2571
|
+
/**
|
|
2572
|
+
*
|
|
2573
|
+
* @type {number}
|
|
2574
|
+
* @memberof CallStatsLocation
|
|
2575
|
+
*/
|
|
2576
|
+
latitude?: number;
|
|
2577
|
+
/**
|
|
2578
|
+
*
|
|
2579
|
+
* @type {number}
|
|
2580
|
+
* @memberof CallStatsLocation
|
|
2581
|
+
*/
|
|
2582
|
+
longitude?: number;
|
|
2583
|
+
/**
|
|
2584
|
+
*
|
|
2585
|
+
* @type {string}
|
|
2586
|
+
* @memberof CallStatsLocation
|
|
2587
|
+
*/
|
|
2588
|
+
subdivision?: string;
|
|
2589
|
+
}
|
|
2535
2590
|
/**
|
|
2536
2591
|
*
|
|
2537
2592
|
* @export
|
|
@@ -2587,6 +2642,18 @@ export interface CallStatsParticipantCounts {
|
|
|
2587
2642
|
* @memberof CallStatsParticipantCounts
|
|
2588
2643
|
*/
|
|
2589
2644
|
participants: number;
|
|
2645
|
+
/**
|
|
2646
|
+
*
|
|
2647
|
+
* @type {number}
|
|
2648
|
+
* @memberof CallStatsParticipantCounts
|
|
2649
|
+
*/
|
|
2650
|
+
peak_concurrent_sessions: number;
|
|
2651
|
+
/**
|
|
2652
|
+
*
|
|
2653
|
+
* @type {number}
|
|
2654
|
+
* @memberof CallStatsParticipantCounts
|
|
2655
|
+
*/
|
|
2656
|
+
peak_concurrent_users: number;
|
|
2590
2657
|
/**
|
|
2591
2658
|
*
|
|
2592
2659
|
* @type {number}
|
|
@@ -2606,12 +2673,42 @@ export interface CallStatsParticipantCounts {
|
|
|
2606
2673
|
* @interface CallStatsParticipantSession
|
|
2607
2674
|
*/
|
|
2608
2675
|
export interface CallStatsParticipantSession {
|
|
2676
|
+
/**
|
|
2677
|
+
*
|
|
2678
|
+
* @type {string}
|
|
2679
|
+
* @memberof CallStatsParticipantSession
|
|
2680
|
+
*/
|
|
2681
|
+
browser?: string;
|
|
2682
|
+
/**
|
|
2683
|
+
*
|
|
2684
|
+
* @type {string}
|
|
2685
|
+
* @memberof CallStatsParticipantSession
|
|
2686
|
+
*/
|
|
2687
|
+
browser_version?: string;
|
|
2609
2688
|
/**
|
|
2610
2689
|
*
|
|
2611
2690
|
* @type {number}
|
|
2612
2691
|
* @memberof CallStatsParticipantSession
|
|
2613
2692
|
*/
|
|
2614
2693
|
cq_score?: number;
|
|
2694
|
+
/**
|
|
2695
|
+
*
|
|
2696
|
+
* @type {string}
|
|
2697
|
+
* @memberof CallStatsParticipantSession
|
|
2698
|
+
*/
|
|
2699
|
+
current_ip?: string;
|
|
2700
|
+
/**
|
|
2701
|
+
*
|
|
2702
|
+
* @type {string}
|
|
2703
|
+
* @memberof CallStatsParticipantSession
|
|
2704
|
+
*/
|
|
2705
|
+
current_sfu?: string;
|
|
2706
|
+
/**
|
|
2707
|
+
*
|
|
2708
|
+
* @type {number}
|
|
2709
|
+
* @memberof CallStatsParticipantSession
|
|
2710
|
+
*/
|
|
2711
|
+
distance_to_sfu_kilometers?: number;
|
|
2615
2712
|
/**
|
|
2616
2713
|
*
|
|
2617
2714
|
* @type {string}
|
|
@@ -2624,6 +2721,18 @@ export interface CallStatsParticipantSession {
|
|
|
2624
2721
|
* @memberof CallStatsParticipantSession
|
|
2625
2722
|
*/
|
|
2626
2723
|
is_live: boolean;
|
|
2724
|
+
/**
|
|
2725
|
+
*
|
|
2726
|
+
* @type {CallStatsLocation}
|
|
2727
|
+
* @memberof CallStatsParticipantSession
|
|
2728
|
+
*/
|
|
2729
|
+
location?: CallStatsLocation;
|
|
2730
|
+
/**
|
|
2731
|
+
*
|
|
2732
|
+
* @type {string}
|
|
2733
|
+
* @memberof CallStatsParticipantSession
|
|
2734
|
+
*/
|
|
2735
|
+
os?: string;
|
|
2627
2736
|
/**
|
|
2628
2737
|
*
|
|
2629
2738
|
* @type {PublishedTrackFlags}
|
|
@@ -2636,6 +2745,18 @@ export interface CallStatsParticipantSession {
|
|
|
2636
2745
|
* @memberof CallStatsParticipantSession
|
|
2637
2746
|
*/
|
|
2638
2747
|
publisher_type?: string;
|
|
2748
|
+
/**
|
|
2749
|
+
*
|
|
2750
|
+
* @type {string}
|
|
2751
|
+
* @memberof CallStatsParticipantSession
|
|
2752
|
+
*/
|
|
2753
|
+
sdk?: string;
|
|
2754
|
+
/**
|
|
2755
|
+
*
|
|
2756
|
+
* @type {string}
|
|
2757
|
+
* @memberof CallStatsParticipantSession
|
|
2758
|
+
*/
|
|
2759
|
+
sdk_version?: string;
|
|
2639
2760
|
/**
|
|
2640
2761
|
*
|
|
2641
2762
|
* @type {string}
|
|
@@ -2654,6 +2775,12 @@ export interface CallStatsParticipantSession {
|
|
|
2654
2775
|
* @memberof CallStatsParticipantSession
|
|
2655
2776
|
*/
|
|
2656
2777
|
user_session_id: string;
|
|
2778
|
+
/**
|
|
2779
|
+
*
|
|
2780
|
+
* @type {string}
|
|
2781
|
+
* @memberof CallStatsParticipantSession
|
|
2782
|
+
*/
|
|
2783
|
+
webrtc_version?: string;
|
|
2657
2784
|
}
|
|
2658
2785
|
/**
|
|
2659
2786
|
* This event is sent when the insights report is ready
|
|
@@ -3915,7 +4042,6 @@ export const FrameRecordingSettingsRequestQualityEnum = {
|
|
|
3915
4042
|
_720P: '720p',
|
|
3916
4043
|
_1080P: '1080p',
|
|
3917
4044
|
_1440P: '1440p',
|
|
3918
|
-
_2160P: '2160p',
|
|
3919
4045
|
} as const;
|
|
3920
4046
|
export type FrameRecordingSettingsRequestQualityEnum =
|
|
3921
4047
|
(typeof FrameRecordingSettingsRequestQualityEnum)[keyof typeof FrameRecordingSettingsRequestQualityEnum];
|
|
@@ -5161,6 +5287,31 @@ export interface MessageStatsResponse {
|
|
|
5161
5287
|
*/
|
|
5162
5288
|
count_over_time?: Array<CountByMinuteResponse>;
|
|
5163
5289
|
}
|
|
5290
|
+
/**
|
|
5291
|
+
*
|
|
5292
|
+
* @export
|
|
5293
|
+
* @interface MetricDescriptor
|
|
5294
|
+
*/
|
|
5295
|
+
export interface MetricDescriptor {
|
|
5296
|
+
/**
|
|
5297
|
+
*
|
|
5298
|
+
* @type {string}
|
|
5299
|
+
* @memberof MetricDescriptor
|
|
5300
|
+
*/
|
|
5301
|
+
description?: string;
|
|
5302
|
+
/**
|
|
5303
|
+
*
|
|
5304
|
+
* @type {string}
|
|
5305
|
+
* @memberof MetricDescriptor
|
|
5306
|
+
*/
|
|
5307
|
+
label: string;
|
|
5308
|
+
/**
|
|
5309
|
+
*
|
|
5310
|
+
* @type {string}
|
|
5311
|
+
* @memberof MetricDescriptor
|
|
5312
|
+
*/
|
|
5313
|
+
unit?: string;
|
|
5314
|
+
}
|
|
5164
5315
|
/**
|
|
5165
5316
|
*
|
|
5166
5317
|
* @export
|
|
@@ -5600,6 +5751,18 @@ export interface ParticipantSeriesPublisherStats {
|
|
|
5600
5751
|
* @memberof ParticipantSeriesPublisherStats
|
|
5601
5752
|
*/
|
|
5602
5753
|
global?: { [key: string]: Array<Array<number>> };
|
|
5754
|
+
/**
|
|
5755
|
+
*
|
|
5756
|
+
* @type {{ [key: string]: MetricDescriptor; }}
|
|
5757
|
+
* @memberof ParticipantSeriesPublisherStats
|
|
5758
|
+
*/
|
|
5759
|
+
global_meta?: { [key: string]: MetricDescriptor };
|
|
5760
|
+
/**
|
|
5761
|
+
*
|
|
5762
|
+
* @type {Array<string>}
|
|
5763
|
+
* @memberof ParticipantSeriesPublisherStats
|
|
5764
|
+
*/
|
|
5765
|
+
global_metrics_order?: Array<string>;
|
|
5603
5766
|
/**
|
|
5604
5767
|
*
|
|
5605
5768
|
* @type {{ [key: string]: Array<MetricThreshold>; }}
|
|
@@ -5625,6 +5788,18 @@ export interface ParticipantSeriesSubscriberStats {
|
|
|
5625
5788
|
* @memberof ParticipantSeriesSubscriberStats
|
|
5626
5789
|
*/
|
|
5627
5790
|
global?: { [key: string]: Array<Array<number>> };
|
|
5791
|
+
/**
|
|
5792
|
+
*
|
|
5793
|
+
* @type {{ [key: string]: MetricDescriptor; }}
|
|
5794
|
+
* @memberof ParticipantSeriesSubscriberStats
|
|
5795
|
+
*/
|
|
5796
|
+
global_meta?: { [key: string]: MetricDescriptor };
|
|
5797
|
+
/**
|
|
5798
|
+
*
|
|
5799
|
+
* @type {Array<string>}
|
|
5800
|
+
* @memberof ParticipantSeriesSubscriberStats
|
|
5801
|
+
*/
|
|
5802
|
+
global_metrics_order?: Array<string>;
|
|
5628
5803
|
/**
|
|
5629
5804
|
*
|
|
5630
5805
|
* @type {{ [key: string]: Array<MetricThreshold>; }}
|
|
@@ -5724,6 +5899,18 @@ export interface ParticipantSeriesTrackMetrics {
|
|
|
5724
5899
|
* @memberof ParticipantSeriesTrackMetrics
|
|
5725
5900
|
*/
|
|
5726
5901
|
metrics?: { [key: string]: Array<Array<number>> };
|
|
5902
|
+
/**
|
|
5903
|
+
*
|
|
5904
|
+
* @type {{ [key: string]: MetricDescriptor; }}
|
|
5905
|
+
* @memberof ParticipantSeriesTrackMetrics
|
|
5906
|
+
*/
|
|
5907
|
+
metrics_meta?: { [key: string]: MetricDescriptor };
|
|
5908
|
+
/**
|
|
5909
|
+
*
|
|
5910
|
+
* @type {Array<string>}
|
|
5911
|
+
* @memberof ParticipantSeriesTrackMetrics
|
|
5912
|
+
*/
|
|
5913
|
+
metrics_order?: Array<string>;
|
|
5727
5914
|
/**
|
|
5728
5915
|
*
|
|
5729
5916
|
* @type {string}
|
|
@@ -5761,6 +5948,18 @@ export interface ParticipantSeriesUserStats {
|
|
|
5761
5948
|
* @memberof ParticipantSeriesUserStats
|
|
5762
5949
|
*/
|
|
5763
5950
|
metrics?: { [key: string]: Array<Array<number>> };
|
|
5951
|
+
/**
|
|
5952
|
+
*
|
|
5953
|
+
* @type {{ [key: string]: MetricDescriptor; }}
|
|
5954
|
+
* @memberof ParticipantSeriesUserStats
|
|
5955
|
+
*/
|
|
5956
|
+
metrics_meta?: { [key: string]: MetricDescriptor };
|
|
5957
|
+
/**
|
|
5958
|
+
*
|
|
5959
|
+
* @type {Array<string>}
|
|
5960
|
+
* @memberof ParticipantSeriesUserStats
|
|
5961
|
+
*/
|
|
5962
|
+
metrics_order?: Array<string>;
|
|
5764
5963
|
/**
|
|
5765
5964
|
*
|
|
5766
5965
|
* @type {{ [key: string]: Array<MetricThreshold>; }}
|
|
@@ -6497,13 +6696,11 @@ export const RTMPBroadcastRequestQualityEnum = {
|
|
|
6497
6696
|
_720P: '720p',
|
|
6498
6697
|
_1080P: '1080p',
|
|
6499
6698
|
_1440P: '1440p',
|
|
6500
|
-
_2160P: '2160p',
|
|
6501
6699
|
PORTRAIT_360X640: 'portrait-360x640',
|
|
6502
6700
|
PORTRAIT_480X854: 'portrait-480x854',
|
|
6503
6701
|
PORTRAIT_720X1280: 'portrait-720x1280',
|
|
6504
6702
|
PORTRAIT_1080X1920: 'portrait-1080x1920',
|
|
6505
6703
|
PORTRAIT_1440X2560: 'portrait-1440x2560',
|
|
6506
|
-
PORTRAIT_2160X3840: 'portrait-2160x3840',
|
|
6507
6704
|
} as const;
|
|
6508
6705
|
export type RTMPBroadcastRequestQualityEnum =
|
|
6509
6706
|
(typeof RTMPBroadcastRequestQualityEnum)[keyof typeof RTMPBroadcastRequestQualityEnum];
|
|
@@ -6550,13 +6747,11 @@ export const RTMPSettingsRequestQualityEnum = {
|
|
|
6550
6747
|
_720P: '720p',
|
|
6551
6748
|
_1080P: '1080p',
|
|
6552
6749
|
_1440P: '1440p',
|
|
6553
|
-
_2160P: '2160p',
|
|
6554
6750
|
PORTRAIT_360X640: 'portrait-360x640',
|
|
6555
6751
|
PORTRAIT_480X854: 'portrait-480x854',
|
|
6556
6752
|
PORTRAIT_720X1280: 'portrait-720x1280',
|
|
6557
6753
|
PORTRAIT_1080X1920: 'portrait-1080x1920',
|
|
6558
6754
|
PORTRAIT_1440X2560: 'portrait-1440x2560',
|
|
6559
|
-
PORTRAIT_2160X3840: 'portrait-2160x3840',
|
|
6560
6755
|
} as const;
|
|
6561
6756
|
export type RTMPSettingsRequestQualityEnum =
|
|
6562
6757
|
(typeof RTMPSettingsRequestQualityEnum)[keyof typeof RTMPSettingsRequestQualityEnum];
|
|
@@ -6657,13 +6852,11 @@ export const RecordSettingsRequestQualityEnum = {
|
|
|
6657
6852
|
_720P: '720p',
|
|
6658
6853
|
_1080P: '1080p',
|
|
6659
6854
|
_1440P: '1440p',
|
|
6660
|
-
_2160P: '2160p',
|
|
6661
6855
|
PORTRAIT_360X640: 'portrait-360x640',
|
|
6662
6856
|
PORTRAIT_480X854: 'portrait-480x854',
|
|
6663
6857
|
PORTRAIT_720X1280: 'portrait-720x1280',
|
|
6664
6858
|
PORTRAIT_1080X1920: 'portrait-1080x1920',
|
|
6665
6859
|
PORTRAIT_1440X2560: 'portrait-1440x2560',
|
|
6666
|
-
PORTRAIT_2160X3840: 'portrait-2160x3840',
|
|
6667
6860
|
} as const;
|
|
6668
6861
|
export type RecordSettingsRequestQualityEnum =
|
|
6669
6862
|
(typeof RecordSettingsRequestQualityEnum)[keyof typeof RecordSettingsRequestQualityEnum];
|
|
@@ -6807,6 +7000,68 @@ export interface RequestPermissionResponse {
|
|
|
6807
7000
|
*/
|
|
6808
7001
|
duration: string;
|
|
6809
7002
|
}
|
|
7003
|
+
/**
|
|
7004
|
+
* Request to resolve SIP inbound routing using challenge authentication
|
|
7005
|
+
* @export
|
|
7006
|
+
* @interface ResolveSipInboundRequest
|
|
7007
|
+
*/
|
|
7008
|
+
export interface ResolveSipInboundRequest {
|
|
7009
|
+
/**
|
|
7010
|
+
*
|
|
7011
|
+
* @type {SIPChallenge}
|
|
7012
|
+
* @memberof ResolveSipInboundRequest
|
|
7013
|
+
*/
|
|
7014
|
+
challenge: SIPChallenge;
|
|
7015
|
+
/**
|
|
7016
|
+
* SIP caller number
|
|
7017
|
+
* @type {string}
|
|
7018
|
+
* @memberof ResolveSipInboundRequest
|
|
7019
|
+
*/
|
|
7020
|
+
sip_caller_number: string;
|
|
7021
|
+
/**
|
|
7022
|
+
* Optional SIP headers as key-value pairs
|
|
7023
|
+
* @type {{ [key: string]: string; }}
|
|
7024
|
+
* @memberof ResolveSipInboundRequest
|
|
7025
|
+
*/
|
|
7026
|
+
sip_headers?: { [key: string]: string };
|
|
7027
|
+
/**
|
|
7028
|
+
* SIP trunk number to resolve
|
|
7029
|
+
* @type {string}
|
|
7030
|
+
* @memberof ResolveSipInboundRequest
|
|
7031
|
+
*/
|
|
7032
|
+
sip_trunk_number: string;
|
|
7033
|
+
}
|
|
7034
|
+
/**
|
|
7035
|
+
* Response containing resolved SIP inbound routing information
|
|
7036
|
+
* @export
|
|
7037
|
+
* @interface ResolveSipInboundResponse
|
|
7038
|
+
*/
|
|
7039
|
+
export interface ResolveSipInboundResponse {
|
|
7040
|
+
/**
|
|
7041
|
+
*
|
|
7042
|
+
* @type {SipInboundCredentials}
|
|
7043
|
+
* @memberof ResolveSipInboundResponse
|
|
7044
|
+
*/
|
|
7045
|
+
credentials: SipInboundCredentials;
|
|
7046
|
+
/**
|
|
7047
|
+
*
|
|
7048
|
+
* @type {string}
|
|
7049
|
+
* @memberof ResolveSipInboundResponse
|
|
7050
|
+
*/
|
|
7051
|
+
duration: string;
|
|
7052
|
+
/**
|
|
7053
|
+
*
|
|
7054
|
+
* @type {SIPInboundRoutingRuleResponse}
|
|
7055
|
+
* @memberof ResolveSipInboundResponse
|
|
7056
|
+
*/
|
|
7057
|
+
sip_routing_rule?: SIPInboundRoutingRuleResponse;
|
|
7058
|
+
/**
|
|
7059
|
+
*
|
|
7060
|
+
* @type {SIPTrunkResponse}
|
|
7061
|
+
* @memberof ResolveSipInboundResponse
|
|
7062
|
+
*/
|
|
7063
|
+
sip_trunk?: SIPTrunkResponse;
|
|
7064
|
+
}
|
|
6810
7065
|
/**
|
|
6811
7066
|
* Basic response information
|
|
6812
7067
|
* @export
|
|
@@ -6820,6 +7075,44 @@ export interface Response {
|
|
|
6820
7075
|
*/
|
|
6821
7076
|
duration: string;
|
|
6822
7077
|
}
|
|
7078
|
+
/**
|
|
7079
|
+
*
|
|
7080
|
+
* @export
|
|
7081
|
+
* @interface RingCallRequest
|
|
7082
|
+
*/
|
|
7083
|
+
export interface RingCallRequest {
|
|
7084
|
+
/**
|
|
7085
|
+
* Members that should receive the ring. If no ids are provided, all call members who are not already in the call will receive ring notifications.
|
|
7086
|
+
* @type {Array<string>}
|
|
7087
|
+
* @memberof RingCallRequest
|
|
7088
|
+
*/
|
|
7089
|
+
members_ids?: Array<string>;
|
|
7090
|
+
/**
|
|
7091
|
+
* Indicate if call should be video
|
|
7092
|
+
* @type {boolean}
|
|
7093
|
+
* @memberof RingCallRequest
|
|
7094
|
+
*/
|
|
7095
|
+
video?: boolean;
|
|
7096
|
+
}
|
|
7097
|
+
/**
|
|
7098
|
+
*
|
|
7099
|
+
* @export
|
|
7100
|
+
* @interface RingCallResponse
|
|
7101
|
+
*/
|
|
7102
|
+
export interface RingCallResponse {
|
|
7103
|
+
/**
|
|
7104
|
+
*
|
|
7105
|
+
* @type {string}
|
|
7106
|
+
* @memberof RingCallResponse
|
|
7107
|
+
*/
|
|
7108
|
+
duration: string;
|
|
7109
|
+
/**
|
|
7110
|
+
* List of members ringing notification was sent to
|
|
7111
|
+
* @type {Array<string>}
|
|
7112
|
+
* @memberof RingCallResponse
|
|
7113
|
+
*/
|
|
7114
|
+
members_ids: Array<string>;
|
|
7115
|
+
}
|
|
6823
7116
|
/**
|
|
6824
7117
|
*
|
|
6825
7118
|
* @export
|
|
@@ -6921,6 +7214,362 @@ export interface SFUResponse {
|
|
|
6921
7214
|
*/
|
|
6922
7215
|
ws_endpoint: string;
|
|
6923
7216
|
}
|
|
7217
|
+
/**
|
|
7218
|
+
* SIP call configuration response
|
|
7219
|
+
* @export
|
|
7220
|
+
* @interface SIPCallConfigsResponse
|
|
7221
|
+
*/
|
|
7222
|
+
export interface SIPCallConfigsResponse {
|
|
7223
|
+
/**
|
|
7224
|
+
* Custom data associated with the call
|
|
7225
|
+
* @type {{ [key: string]: any; }}
|
|
7226
|
+
* @memberof SIPCallConfigsResponse
|
|
7227
|
+
*/
|
|
7228
|
+
custom_data: { [key: string]: any };
|
|
7229
|
+
}
|
|
7230
|
+
/**
|
|
7231
|
+
* SIP caller configuration response
|
|
7232
|
+
* @export
|
|
7233
|
+
* @interface SIPCallerConfigsResponse
|
|
7234
|
+
*/
|
|
7235
|
+
export interface SIPCallerConfigsResponse {
|
|
7236
|
+
/**
|
|
7237
|
+
* Custom data associated with the caller
|
|
7238
|
+
* @type {{ [key: string]: any; }}
|
|
7239
|
+
* @memberof SIPCallerConfigsResponse
|
|
7240
|
+
*/
|
|
7241
|
+
custom_data: { [key: string]: any };
|
|
7242
|
+
/**
|
|
7243
|
+
* Unique identifier for the caller
|
|
7244
|
+
* @type {string}
|
|
7245
|
+
* @memberof SIPCallerConfigsResponse
|
|
7246
|
+
*/
|
|
7247
|
+
id: string;
|
|
7248
|
+
}
|
|
7249
|
+
/**
|
|
7250
|
+
*
|
|
7251
|
+
* @export
|
|
7252
|
+
* @interface SIPChallenge
|
|
7253
|
+
*/
|
|
7254
|
+
export interface SIPChallenge {
|
|
7255
|
+
/**
|
|
7256
|
+
*
|
|
7257
|
+
* @type {string}
|
|
7258
|
+
* @memberof SIPChallenge
|
|
7259
|
+
*/
|
|
7260
|
+
a1?: string;
|
|
7261
|
+
/**
|
|
7262
|
+
*
|
|
7263
|
+
* @type {string}
|
|
7264
|
+
* @memberof SIPChallenge
|
|
7265
|
+
*/
|
|
7266
|
+
algorithm?: string;
|
|
7267
|
+
/**
|
|
7268
|
+
*
|
|
7269
|
+
* @type {string}
|
|
7270
|
+
* @memberof SIPChallenge
|
|
7271
|
+
*/
|
|
7272
|
+
charset?: string;
|
|
7273
|
+
/**
|
|
7274
|
+
*
|
|
7275
|
+
* @type {string}
|
|
7276
|
+
* @memberof SIPChallenge
|
|
7277
|
+
*/
|
|
7278
|
+
cnonce?: string;
|
|
7279
|
+
/**
|
|
7280
|
+
*
|
|
7281
|
+
* @type {Array<string>}
|
|
7282
|
+
* @memberof SIPChallenge
|
|
7283
|
+
*/
|
|
7284
|
+
domain?: Array<string>;
|
|
7285
|
+
/**
|
|
7286
|
+
*
|
|
7287
|
+
* @type {string}
|
|
7288
|
+
* @memberof SIPChallenge
|
|
7289
|
+
*/
|
|
7290
|
+
method?: string;
|
|
7291
|
+
/**
|
|
7292
|
+
*
|
|
7293
|
+
* @type {string}
|
|
7294
|
+
* @memberof SIPChallenge
|
|
7295
|
+
*/
|
|
7296
|
+
nc?: string;
|
|
7297
|
+
/**
|
|
7298
|
+
*
|
|
7299
|
+
* @type {string}
|
|
7300
|
+
* @memberof SIPChallenge
|
|
7301
|
+
*/
|
|
7302
|
+
nonce?: string;
|
|
7303
|
+
/**
|
|
7304
|
+
*
|
|
7305
|
+
* @type {string}
|
|
7306
|
+
* @memberof SIPChallenge
|
|
7307
|
+
*/
|
|
7308
|
+
opaque?: string;
|
|
7309
|
+
/**
|
|
7310
|
+
*
|
|
7311
|
+
* @type {Array<string>}
|
|
7312
|
+
* @memberof SIPChallenge
|
|
7313
|
+
*/
|
|
7314
|
+
qop?: Array<string>;
|
|
7315
|
+
/**
|
|
7316
|
+
*
|
|
7317
|
+
* @type {string}
|
|
7318
|
+
* @memberof SIPChallenge
|
|
7319
|
+
*/
|
|
7320
|
+
realm?: string;
|
|
7321
|
+
/**
|
|
7322
|
+
*
|
|
7323
|
+
* @type {string}
|
|
7324
|
+
* @memberof SIPChallenge
|
|
7325
|
+
*/
|
|
7326
|
+
response?: string;
|
|
7327
|
+
/**
|
|
7328
|
+
*
|
|
7329
|
+
* @type {boolean}
|
|
7330
|
+
* @memberof SIPChallenge
|
|
7331
|
+
*/
|
|
7332
|
+
stale?: boolean;
|
|
7333
|
+
/**
|
|
7334
|
+
*
|
|
7335
|
+
* @type {string}
|
|
7336
|
+
* @memberof SIPChallenge
|
|
7337
|
+
*/
|
|
7338
|
+
uri?: string;
|
|
7339
|
+
/**
|
|
7340
|
+
*
|
|
7341
|
+
* @type {boolean}
|
|
7342
|
+
* @memberof SIPChallenge
|
|
7343
|
+
*/
|
|
7344
|
+
userhash?: boolean;
|
|
7345
|
+
/**
|
|
7346
|
+
*
|
|
7347
|
+
* @type {string}
|
|
7348
|
+
* @memberof SIPChallenge
|
|
7349
|
+
*/
|
|
7350
|
+
username?: string;
|
|
7351
|
+
}
|
|
7352
|
+
/**
|
|
7353
|
+
* Direct routing rule call configuration response
|
|
7354
|
+
* @export
|
|
7355
|
+
* @interface SIPDirectRoutingRuleCallConfigsResponse
|
|
7356
|
+
*/
|
|
7357
|
+
export interface SIPDirectRoutingRuleCallConfigsResponse {
|
|
7358
|
+
/**
|
|
7359
|
+
* ID of the call
|
|
7360
|
+
* @type {string}
|
|
7361
|
+
* @memberof SIPDirectRoutingRuleCallConfigsResponse
|
|
7362
|
+
*/
|
|
7363
|
+
call_id: string;
|
|
7364
|
+
/**
|
|
7365
|
+
* Type of the call
|
|
7366
|
+
* @type {string}
|
|
7367
|
+
* @memberof SIPDirectRoutingRuleCallConfigsResponse
|
|
7368
|
+
*/
|
|
7369
|
+
call_type: string;
|
|
7370
|
+
}
|
|
7371
|
+
/**
|
|
7372
|
+
* PIN routing rule call configuration response
|
|
7373
|
+
* @export
|
|
7374
|
+
* @interface SIPInboundRoutingRulePinConfigsResponse
|
|
7375
|
+
*/
|
|
7376
|
+
export interface SIPInboundRoutingRulePinConfigsResponse {
|
|
7377
|
+
/**
|
|
7378
|
+
* Optional webhook URL for custom PIN handling
|
|
7379
|
+
* @type {string}
|
|
7380
|
+
* @memberof SIPInboundRoutingRulePinConfigsResponse
|
|
7381
|
+
*/
|
|
7382
|
+
custom_webhook_url?: string;
|
|
7383
|
+
/**
|
|
7384
|
+
* Prompt message for failed PIN attempts
|
|
7385
|
+
* @type {string}
|
|
7386
|
+
* @memberof SIPInboundRoutingRulePinConfigsResponse
|
|
7387
|
+
*/
|
|
7388
|
+
pin_failed_attempt_prompt?: string;
|
|
7389
|
+
/**
|
|
7390
|
+
* Prompt message for hangup after PIN input
|
|
7391
|
+
* @type {string}
|
|
7392
|
+
* @memberof SIPInboundRoutingRulePinConfigsResponse
|
|
7393
|
+
*/
|
|
7394
|
+
pin_hangup_prompt?: string;
|
|
7395
|
+
/**
|
|
7396
|
+
* Prompt message for PIN input
|
|
7397
|
+
* @type {string}
|
|
7398
|
+
* @memberof SIPInboundRoutingRulePinConfigsResponse
|
|
7399
|
+
*/
|
|
7400
|
+
pin_prompt?: string;
|
|
7401
|
+
/**
|
|
7402
|
+
* Prompt message for successful PIN input
|
|
7403
|
+
* @type {string}
|
|
7404
|
+
* @memberof SIPInboundRoutingRulePinConfigsResponse
|
|
7405
|
+
*/
|
|
7406
|
+
pin_success_prompt?: string;
|
|
7407
|
+
}
|
|
7408
|
+
/**
|
|
7409
|
+
* SIP Inbound Routing Rule response
|
|
7410
|
+
* @export
|
|
7411
|
+
* @interface SIPInboundRoutingRuleResponse
|
|
7412
|
+
*/
|
|
7413
|
+
export interface SIPInboundRoutingRuleResponse {
|
|
7414
|
+
/**
|
|
7415
|
+
*
|
|
7416
|
+
* @type {SIPCallConfigsResponse}
|
|
7417
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7418
|
+
*/
|
|
7419
|
+
call_configs?: SIPCallConfigsResponse;
|
|
7420
|
+
/**
|
|
7421
|
+
* List of called numbers
|
|
7422
|
+
* @type {Array<string>}
|
|
7423
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7424
|
+
*/
|
|
7425
|
+
called_numbers: Array<string>;
|
|
7426
|
+
/**
|
|
7427
|
+
*
|
|
7428
|
+
* @type {SIPCallerConfigsResponse}
|
|
7429
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7430
|
+
*/
|
|
7431
|
+
caller_configs?: SIPCallerConfigsResponse;
|
|
7432
|
+
/**
|
|
7433
|
+
* List of caller numbers
|
|
7434
|
+
* @type {Array<string>}
|
|
7435
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7436
|
+
*/
|
|
7437
|
+
caller_numbers?: Array<string>;
|
|
7438
|
+
/**
|
|
7439
|
+
*
|
|
7440
|
+
* @type {SIPDirectRoutingRuleCallConfigsResponse}
|
|
7441
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7442
|
+
*/
|
|
7443
|
+
direct_routing_configs?: SIPDirectRoutingRuleCallConfigsResponse;
|
|
7444
|
+
/**
|
|
7445
|
+
*
|
|
7446
|
+
* @type {string}
|
|
7447
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7448
|
+
*/
|
|
7449
|
+
duration: string;
|
|
7450
|
+
/**
|
|
7451
|
+
* Unique identifier of the SIP Inbound Routing Rule
|
|
7452
|
+
* @type {string}
|
|
7453
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7454
|
+
*/
|
|
7455
|
+
id: string;
|
|
7456
|
+
/**
|
|
7457
|
+
* Name of the SIP Inbound Routing Rule
|
|
7458
|
+
* @type {string}
|
|
7459
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7460
|
+
*/
|
|
7461
|
+
name: string;
|
|
7462
|
+
/**
|
|
7463
|
+
*
|
|
7464
|
+
* @type {SIPPinProtectionConfigsResponse}
|
|
7465
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7466
|
+
*/
|
|
7467
|
+
pin_protection_configs?: SIPPinProtectionConfigsResponse;
|
|
7468
|
+
/**
|
|
7469
|
+
*
|
|
7470
|
+
* @type {SIPInboundRoutingRulePinConfigsResponse}
|
|
7471
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7472
|
+
*/
|
|
7473
|
+
pin_routing_configs?: SIPInboundRoutingRulePinConfigsResponse;
|
|
7474
|
+
/**
|
|
7475
|
+
* List of SIP trunk IDs
|
|
7476
|
+
* @type {Array<string>}
|
|
7477
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7478
|
+
*/
|
|
7479
|
+
trunk_ids: Array<string>;
|
|
7480
|
+
/**
|
|
7481
|
+
*
|
|
7482
|
+
* @type {object}
|
|
7483
|
+
* @memberof SIPInboundRoutingRuleResponse
|
|
7484
|
+
*/
|
|
7485
|
+
updated_at: object;
|
|
7486
|
+
}
|
|
7487
|
+
/**
|
|
7488
|
+
* PIN protection configuration response
|
|
7489
|
+
* @export
|
|
7490
|
+
* @interface SIPPinProtectionConfigsResponse
|
|
7491
|
+
*/
|
|
7492
|
+
export interface SIPPinProtectionConfigsResponse {
|
|
7493
|
+
/**
|
|
7494
|
+
* Default PIN to use if there is no PIN set on the call object
|
|
7495
|
+
* @type {string}
|
|
7496
|
+
* @memberof SIPPinProtectionConfigsResponse
|
|
7497
|
+
*/
|
|
7498
|
+
default_pin?: string;
|
|
7499
|
+
/**
|
|
7500
|
+
* Whether PIN protection is enabled
|
|
7501
|
+
* @type {boolean}
|
|
7502
|
+
* @memberof SIPPinProtectionConfigsResponse
|
|
7503
|
+
*/
|
|
7504
|
+
enabled: boolean;
|
|
7505
|
+
/**
|
|
7506
|
+
* Maximum number of PIN attempts allowed
|
|
7507
|
+
* @type {number}
|
|
7508
|
+
* @memberof SIPPinProtectionConfigsResponse
|
|
7509
|
+
*/
|
|
7510
|
+
max_attempts?: number;
|
|
7511
|
+
/**
|
|
7512
|
+
* Number of digits required for the PIN
|
|
7513
|
+
* @type {number}
|
|
7514
|
+
* @memberof SIPPinProtectionConfigsResponse
|
|
7515
|
+
*/
|
|
7516
|
+
required_pin_digits?: number;
|
|
7517
|
+
}
|
|
7518
|
+
/**
|
|
7519
|
+
* SIP trunk information
|
|
7520
|
+
* @export
|
|
7521
|
+
* @interface SIPTrunkResponse
|
|
7522
|
+
*/
|
|
7523
|
+
export interface SIPTrunkResponse {
|
|
7524
|
+
/**
|
|
7525
|
+
*
|
|
7526
|
+
* @type {object}
|
|
7527
|
+
* @memberof SIPTrunkResponse
|
|
7528
|
+
*/
|
|
7529
|
+
created_at: object;
|
|
7530
|
+
/**
|
|
7531
|
+
* Unique identifier for the SIP trunk
|
|
7532
|
+
* @type {string}
|
|
7533
|
+
* @memberof SIPTrunkResponse
|
|
7534
|
+
*/
|
|
7535
|
+
id: string;
|
|
7536
|
+
/**
|
|
7537
|
+
* Name of the SIP trunk
|
|
7538
|
+
* @type {string}
|
|
7539
|
+
* @memberof SIPTrunkResponse
|
|
7540
|
+
*/
|
|
7541
|
+
name: string;
|
|
7542
|
+
/**
|
|
7543
|
+
* Phone numbers associated with this SIP trunk
|
|
7544
|
+
* @type {Array<string>}
|
|
7545
|
+
* @memberof SIPTrunkResponse
|
|
7546
|
+
*/
|
|
7547
|
+
numbers: Array<string>;
|
|
7548
|
+
/**
|
|
7549
|
+
* Password for SIP trunk authentication
|
|
7550
|
+
* @type {string}
|
|
7551
|
+
* @memberof SIPTrunkResponse
|
|
7552
|
+
*/
|
|
7553
|
+
password: string;
|
|
7554
|
+
/**
|
|
7555
|
+
*
|
|
7556
|
+
* @type {object}
|
|
7557
|
+
* @memberof SIPTrunkResponse
|
|
7558
|
+
*/
|
|
7559
|
+
updated_at: object;
|
|
7560
|
+
/**
|
|
7561
|
+
* The URI for the SIP trunk
|
|
7562
|
+
* @type {string}
|
|
7563
|
+
* @memberof SIPTrunkResponse
|
|
7564
|
+
*/
|
|
7565
|
+
uri: string;
|
|
7566
|
+
/**
|
|
7567
|
+
* Username for SIP trunk authentication
|
|
7568
|
+
* @type {string}
|
|
7569
|
+
* @memberof SIPTrunkResponse
|
|
7570
|
+
*/
|
|
7571
|
+
username: string;
|
|
7572
|
+
}
|
|
6924
7573
|
/**
|
|
6925
7574
|
*
|
|
6926
7575
|
* @export
|
|
@@ -7080,6 +7729,49 @@ export interface SessionSettingsResponse {
|
|
|
7080
7729
|
*/
|
|
7081
7730
|
inactivity_timeout_seconds: number;
|
|
7082
7731
|
}
|
|
7732
|
+
/**
|
|
7733
|
+
* Credentials for SIP inbound call authentication
|
|
7734
|
+
* @export
|
|
7735
|
+
* @interface SipInboundCredentials
|
|
7736
|
+
*/
|
|
7737
|
+
export interface SipInboundCredentials {
|
|
7738
|
+
/**
|
|
7739
|
+
* Custom data associated with the call
|
|
7740
|
+
* @type {{ [key: string]: any; }}
|
|
7741
|
+
* @memberof SipInboundCredentials
|
|
7742
|
+
*/
|
|
7743
|
+
call_custom_data: { [key: string]: any };
|
|
7744
|
+
/**
|
|
7745
|
+
* ID of the call
|
|
7746
|
+
* @type {string}
|
|
7747
|
+
* @memberof SipInboundCredentials
|
|
7748
|
+
*/
|
|
7749
|
+
call_id: string;
|
|
7750
|
+
/**
|
|
7751
|
+
* Type of the call
|
|
7752
|
+
* @type {string}
|
|
7753
|
+
* @memberof SipInboundCredentials
|
|
7754
|
+
*/
|
|
7755
|
+
call_type: string;
|
|
7756
|
+
/**
|
|
7757
|
+
* Authentication token for the call
|
|
7758
|
+
* @type {string}
|
|
7759
|
+
* @memberof SipInboundCredentials
|
|
7760
|
+
*/
|
|
7761
|
+
token: string;
|
|
7762
|
+
/**
|
|
7763
|
+
* Custom data associated with the user
|
|
7764
|
+
* @type {{ [key: string]: any; }}
|
|
7765
|
+
* @memberof SipInboundCredentials
|
|
7766
|
+
*/
|
|
7767
|
+
user_custom_data: { [key: string]: any };
|
|
7768
|
+
/**
|
|
7769
|
+
* User ID for the call
|
|
7770
|
+
* @type {string}
|
|
7771
|
+
* @memberof SipInboundCredentials
|
|
7772
|
+
*/
|
|
7773
|
+
user_id: string;
|
|
7774
|
+
}
|
|
7083
7775
|
/**
|
|
7084
7776
|
*
|
|
7085
7777
|
* @export
|