@wildix/wda-stream-client 1.1.49 → 1.1.56
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/dist-cjs/models/models_0.js +14 -2
- package/dist-cjs/protocols/Aws_restJson1.js +3 -0
- package/dist-es/models/models_0.js +12 -0
- package/dist-es/protocols/Aws_restJson1.js +3 -0
- package/dist-types/commands/ConsumeEventCommand.d.ts +62 -36
- package/dist-types/commands/DescribeEventCommand.d.ts +155 -70
- package/dist-types/commands/GetOngoingCallCommand.d.ts +1 -0
- package/dist-types/commands/GetOngoingCallTranscriptionCommand.d.ts +4 -2
- package/dist-types/commands/GetOngoingConferenceCommand.d.ts +1 -1
- package/dist-types/commands/GetOngoingConferenceTranscriptionCommand.d.ts +3 -3
- package/dist-types/commands/ListServicesCommand.d.ts +1 -0
- package/dist-types/commands/QueryConversationsCommand.d.ts +4 -3
- package/dist-types/models/models_0.d.ts +468 -76
- package/dist-types/models/models_1.d.ts +51 -3
- package/package.json +1 -1
|
@@ -446,6 +446,11 @@ export interface CallRecord {
|
|
|
446
446
|
trunkDirection?: string | undefined;
|
|
447
447
|
queueName?: string | undefined;
|
|
448
448
|
queueId?: string | undefined;
|
|
449
|
+
/**
|
|
450
|
+
* Position of the call in the queue (1-based). Updated from consume events and emitted on live progress and record flows.
|
|
451
|
+
* @public
|
|
452
|
+
*/
|
|
453
|
+
queuePosition?: number | undefined;
|
|
449
454
|
tags?: (string)[] | undefined;
|
|
450
455
|
flags?: (string)[] | undefined;
|
|
451
456
|
callerMos?: string | undefined;
|
|
@@ -518,6 +523,20 @@ export declare const CallTranscriptionSpeaker: {
|
|
|
518
523
|
* @public
|
|
519
524
|
*/
|
|
520
525
|
export type CallTranscriptionSpeaker = typeof CallTranscriptionSpeaker[keyof typeof CallTranscriptionSpeaker];
|
|
526
|
+
/**
|
|
527
|
+
* @public
|
|
528
|
+
* @enum
|
|
529
|
+
*/
|
|
530
|
+
export declare const TranscriptionSentiment: {
|
|
531
|
+
readonly MIXED: "MIXED";
|
|
532
|
+
readonly NEGATIVE: "NEGATIVE";
|
|
533
|
+
readonly NEUTRAL: "NEUTRAL";
|
|
534
|
+
readonly POSITIVE: "POSITIVE";
|
|
535
|
+
};
|
|
536
|
+
/**
|
|
537
|
+
* @public
|
|
538
|
+
*/
|
|
539
|
+
export type TranscriptionSentiment = typeof TranscriptionSentiment[keyof typeof TranscriptionSentiment];
|
|
521
540
|
/**
|
|
522
541
|
* @public
|
|
523
542
|
*/
|
|
@@ -535,7 +554,16 @@ export interface CallTranscriptionChunk {
|
|
|
535
554
|
* @public
|
|
536
555
|
*/
|
|
537
556
|
confidence?: number | undefined;
|
|
538
|
-
|
|
557
|
+
/**
|
|
558
|
+
* Sentiment label for a transcription chunk. Shared between calls and conferences.
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
sentiment?: TranscriptionSentiment | undefined;
|
|
562
|
+
/**
|
|
563
|
+
* Tristate gate populated upstream from caller/callee user-level licenses. `true` = at least one participant is on a whitelisted tier (currently `business` or `premium`). `false` = both participants are known and neither is whitelisted. Absent or null means upstream had no license info — downstream should fall through and compute sentiment (fail-open) to preserve the pre-feature behaviour.
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
shouldComputeSentiment?: boolean | undefined;
|
|
539
567
|
}
|
|
540
568
|
/**
|
|
541
569
|
* @public
|
|
@@ -1254,7 +1282,11 @@ export interface ConferenceTranscriptionChunk {
|
|
|
1254
1282
|
isFinal: boolean;
|
|
1255
1283
|
start: number;
|
|
1256
1284
|
end: number;
|
|
1257
|
-
|
|
1285
|
+
/**
|
|
1286
|
+
* Sentiment label for a transcription chunk. Shared between calls and conferences.
|
|
1287
|
+
* @public
|
|
1288
|
+
*/
|
|
1289
|
+
sentiment?: TranscriptionSentiment | undefined;
|
|
1258
1290
|
}
|
|
1259
1291
|
/**
|
|
1260
1292
|
* @public
|
|
@@ -1429,6 +1461,7 @@ export declare const LiveEventType: {
|
|
|
1429
1461
|
readonly CONFERENCE_TRANSCRIPTION: "conference_transcription";
|
|
1430
1462
|
readonly SERVICE: "service";
|
|
1431
1463
|
readonly SERVICE_AGENT: "service_agent";
|
|
1464
|
+
readonly SERVICE_AGENT_STATUS: "service_agent_status";
|
|
1432
1465
|
readonly SERVICE_CALL: "service_call";
|
|
1433
1466
|
readonly SERVICE_CALL_COMPLETE: "service_call_complete";
|
|
1434
1467
|
readonly SERVICE_COMPLETE: "service_complete";
|
|
@@ -1556,6 +1589,11 @@ export interface CallAnalyticsLiveProgressEventFlow {
|
|
|
1556
1589
|
trunkDirection?: string | undefined;
|
|
1557
1590
|
queueName?: string | undefined;
|
|
1558
1591
|
queueId?: string | undefined;
|
|
1592
|
+
/**
|
|
1593
|
+
* Position of the call in the queue (1-based). Updated from consume events and emitted on live progress and record flows.
|
|
1594
|
+
* @public
|
|
1595
|
+
*/
|
|
1596
|
+
queuePosition?: number | undefined;
|
|
1559
1597
|
tags?: (string)[] | undefined;
|
|
1560
1598
|
flags?: (string)[] | undefined;
|
|
1561
1599
|
callerMos?: string | undefined;
|
|
@@ -1714,6 +1752,11 @@ export interface CallAnalyticsRecordEventFlow {
|
|
|
1714
1752
|
trunkDirection?: string | undefined;
|
|
1715
1753
|
queueName?: string | undefined;
|
|
1716
1754
|
queueId?: string | undefined;
|
|
1755
|
+
/**
|
|
1756
|
+
* Position of the call in the queue (1-based). Updated from consume events and emitted on live progress and record flows.
|
|
1757
|
+
* @public
|
|
1758
|
+
*/
|
|
1759
|
+
queuePosition?: number | undefined;
|
|
1717
1760
|
tags?: (string)[] | undefined;
|
|
1718
1761
|
flags?: (string)[] | undefined;
|
|
1719
1762
|
callerMos?: string | undefined;
|
|
@@ -2063,6 +2106,11 @@ export interface CallSplitConsumeEventData {
|
|
|
2063
2106
|
serviceNumber?: string | undefined;
|
|
2064
2107
|
trunk?: CallFlowConsumeTrunk | undefined;
|
|
2065
2108
|
queue?: CallFlowConsumeQueue | undefined;
|
|
2109
|
+
/**
|
|
2110
|
+
* Position of the call in the queue (1-based).
|
|
2111
|
+
* @public
|
|
2112
|
+
*/
|
|
2113
|
+
queuePosition?: number | undefined;
|
|
2066
2114
|
tags?: (string)[] | undefined;
|
|
2067
2115
|
flags?: (string)[] | undefined;
|
|
2068
2116
|
sipCallId?: string | undefined;
|
|
@@ -2095,6 +2143,11 @@ export interface CallStartConsumeEventData {
|
|
|
2095
2143
|
serviceNumber?: string | undefined;
|
|
2096
2144
|
trunk?: CallFlowConsumeTrunk | undefined;
|
|
2097
2145
|
queue?: CallFlowConsumeQueue | undefined;
|
|
2146
|
+
/**
|
|
2147
|
+
* Position of the call in the queue (1-based).
|
|
2148
|
+
* @public
|
|
2149
|
+
*/
|
|
2150
|
+
queuePosition?: number | undefined;
|
|
2098
2151
|
tags?: (string)[] | undefined;
|
|
2099
2152
|
flags?: (string)[] | undefined;
|
|
2100
2153
|
sipCallId?: string | undefined;
|
|
@@ -2148,6 +2201,11 @@ export interface CallUpdateConsumeEventData {
|
|
|
2148
2201
|
serviceNumber?: string | undefined;
|
|
2149
2202
|
trunk?: CallFlowConsumeTrunk | undefined;
|
|
2150
2203
|
queue?: CallFlowConsumeQueue | undefined;
|
|
2204
|
+
/**
|
|
2205
|
+
* Position of the call in the queue (1-based).
|
|
2206
|
+
* @public
|
|
2207
|
+
*/
|
|
2208
|
+
queuePosition?: number | undefined;
|
|
2151
2209
|
tags?: (string)[] | undefined;
|
|
2152
2210
|
flags?: (string)[] | undefined;
|
|
2153
2211
|
sipCallId?: string | undefined;
|
|
@@ -2883,9 +2941,14 @@ export interface ServiceAgentConsumeEventData {
|
|
|
2883
2941
|
penalty?: string | undefined;
|
|
2884
2942
|
type?: ServiceAgentType | undefined;
|
|
2885
2943
|
paused?: boolean | undefined;
|
|
2944
|
+
status?: string | undefined;
|
|
2945
|
+
reason?: string | undefined;
|
|
2946
|
+
message?: string | undefined;
|
|
2886
2947
|
lastQueueCallEnd?: number | undefined;
|
|
2887
2948
|
userExtension?: string | undefined;
|
|
2949
|
+
department?: string | undefined;
|
|
2888
2950
|
name?: string | undefined;
|
|
2951
|
+
aclGroup?: string | undefined;
|
|
2889
2952
|
}
|
|
2890
2953
|
/**
|
|
2891
2954
|
* @public
|
|
@@ -2910,9 +2973,17 @@ export type ServiceConsumeEventType = typeof ServiceConsumeEventType[keyof typeo
|
|
|
2910
2973
|
* @public
|
|
2911
2974
|
*/
|
|
2912
2975
|
export interface ServiceAgentJoinConsumeEvent {
|
|
2976
|
+
/**
|
|
2977
|
+
* The unique identifier of the service.
|
|
2978
|
+
* @public
|
|
2979
|
+
*/
|
|
2913
2980
|
id: string;
|
|
2914
|
-
|
|
2981
|
+
/**
|
|
2982
|
+
* The PBX identifier of the service.
|
|
2983
|
+
* @public
|
|
2984
|
+
*/
|
|
2915
2985
|
pbx: string;
|
|
2986
|
+
time: number;
|
|
2916
2987
|
company: string;
|
|
2917
2988
|
type: ServiceConsumeEventType;
|
|
2918
2989
|
data: ServiceAgentConsumeEventData;
|
|
@@ -2921,9 +2992,17 @@ export interface ServiceAgentJoinConsumeEvent {
|
|
|
2921
2992
|
* @public
|
|
2922
2993
|
*/
|
|
2923
2994
|
export interface ServiceAgentLeaveConsumeEvent {
|
|
2995
|
+
/**
|
|
2996
|
+
* The unique identifier of the service.
|
|
2997
|
+
* @public
|
|
2998
|
+
*/
|
|
2924
2999
|
id: string;
|
|
2925
|
-
|
|
3000
|
+
/**
|
|
3001
|
+
* The PBX identifier of the service.
|
|
3002
|
+
* @public
|
|
3003
|
+
*/
|
|
2926
3004
|
pbx: string;
|
|
3005
|
+
time: number;
|
|
2927
3006
|
company: string;
|
|
2928
3007
|
type: ServiceConsumeEventType;
|
|
2929
3008
|
data: ServiceAgentConsumeEventData;
|
|
@@ -2932,9 +3011,17 @@ export interface ServiceAgentLeaveConsumeEvent {
|
|
|
2932
3011
|
* @public
|
|
2933
3012
|
*/
|
|
2934
3013
|
export interface ServiceAgentUpdateConsumeEvent {
|
|
3014
|
+
/**
|
|
3015
|
+
* The unique identifier of the service.
|
|
3016
|
+
* @public
|
|
3017
|
+
*/
|
|
2935
3018
|
id: string;
|
|
2936
|
-
|
|
3019
|
+
/**
|
|
3020
|
+
* The PBX identifier of the service.
|
|
3021
|
+
* @public
|
|
3022
|
+
*/
|
|
2937
3023
|
pbx: string;
|
|
3024
|
+
time: number;
|
|
2938
3025
|
company: string;
|
|
2939
3026
|
type: ServiceConsumeEventType;
|
|
2940
3027
|
data: ServiceAgentConsumeEventData;
|
|
@@ -2946,43 +3033,69 @@ export interface ServiceAgentUpdateConsumeEvent {
|
|
|
2946
3033
|
export declare const ServiceCallAction: {
|
|
2947
3034
|
readonly ANSWER: "ANSWER";
|
|
2948
3035
|
readonly CANCEL: "CANCEL";
|
|
3036
|
+
readonly END: "END";
|
|
3037
|
+
readonly INIT: "INIT";
|
|
2949
3038
|
readonly REJECT: "REJECT";
|
|
2950
3039
|
readonly RING: "RING";
|
|
3040
|
+
readonly WAIT: "WAIT";
|
|
2951
3041
|
};
|
|
2952
3042
|
/**
|
|
2953
3043
|
* @public
|
|
2954
3044
|
*/
|
|
2955
3045
|
export type ServiceCallAction = typeof ServiceCallAction[keyof typeof ServiceCallAction];
|
|
2956
3046
|
/**
|
|
2957
|
-
*
|
|
2958
|
-
*/
|
|
2959
|
-
export interface ServiceCustomer {
|
|
2960
|
-
phone: string;
|
|
2961
|
-
name?: string | undefined;
|
|
2962
|
-
}
|
|
2963
|
-
/**
|
|
2964
|
-
* Service call data shared by live events and record representation.
|
|
3047
|
+
* Base service call structure.
|
|
2965
3048
|
* @public
|
|
2966
3049
|
*/
|
|
2967
3050
|
export interface ServiceCallConsumeEventData {
|
|
3051
|
+
/**
|
|
3052
|
+
* Action performed at this step (e.g., INIT, RING, CANCEL, ANSWER, END).
|
|
3053
|
+
* It's optional, can be absent in case some service call fields updated, while action is not changed.
|
|
3054
|
+
* @public
|
|
3055
|
+
*/
|
|
3056
|
+
action?: ServiceCallAction | undefined;
|
|
3057
|
+
/**
|
|
3058
|
+
* Optional human-readable reason (e.g., 'timeout', 'Normal call clearing').
|
|
3059
|
+
* @public
|
|
3060
|
+
*/
|
|
3061
|
+
reason?: string | undefined;
|
|
3062
|
+
/**
|
|
3063
|
+
* Agents related to this action (typically those ringing/answering/cancelling).
|
|
3064
|
+
* @public
|
|
3065
|
+
*/
|
|
3066
|
+
relatedAgents?: (string)[] | undefined;
|
|
3067
|
+
/**
|
|
3068
|
+
* Identifier of the call this record describes.
|
|
3069
|
+
* @public
|
|
3070
|
+
*/
|
|
2968
3071
|
callId: string;
|
|
3072
|
+
/**
|
|
3073
|
+
* Index of a call segment inside one call session. A call can have several flows after CALL.SPLIT (transfer, redirect, etc.)
|
|
3074
|
+
* @public
|
|
3075
|
+
*/
|
|
3076
|
+
flowId?: number | undefined;
|
|
2969
3077
|
startTime?: number | undefined;
|
|
2970
3078
|
direction?: CallDirection | undefined;
|
|
2971
|
-
action?: ServiceCallAction | undefined;
|
|
2972
|
-
customer?: ServiceCustomer | undefined;
|
|
2973
|
-
relatedAgents?: (string)[] | undefined;
|
|
2974
3079
|
}
|
|
2975
3080
|
/**
|
|
2976
3081
|
* @public
|
|
2977
3082
|
*/
|
|
2978
3083
|
export interface ServiceCallEndConsumeEvent {
|
|
3084
|
+
/**
|
|
3085
|
+
* The unique identifier of the service.
|
|
3086
|
+
* @public
|
|
3087
|
+
*/
|
|
2979
3088
|
id: string;
|
|
2980
|
-
|
|
3089
|
+
/**
|
|
3090
|
+
* The PBX identifier of the service.
|
|
3091
|
+
* @public
|
|
3092
|
+
*/
|
|
2981
3093
|
pbx: string;
|
|
3094
|
+
time: number;
|
|
2982
3095
|
company: string;
|
|
2983
3096
|
type: ServiceConsumeEventType;
|
|
2984
3097
|
/**
|
|
2985
|
-
*
|
|
3098
|
+
* Base service call structure.
|
|
2986
3099
|
* @public
|
|
2987
3100
|
*/
|
|
2988
3101
|
data: ServiceCallConsumeEventData;
|
|
@@ -2991,13 +3104,21 @@ export interface ServiceCallEndConsumeEvent {
|
|
|
2991
3104
|
* @public
|
|
2992
3105
|
*/
|
|
2993
3106
|
export interface ServiceCallInitConsumeEvent {
|
|
3107
|
+
/**
|
|
3108
|
+
* The unique identifier of the service.
|
|
3109
|
+
* @public
|
|
3110
|
+
*/
|
|
2994
3111
|
id: string;
|
|
2995
|
-
|
|
3112
|
+
/**
|
|
3113
|
+
* The PBX identifier of the service.
|
|
3114
|
+
* @public
|
|
3115
|
+
*/
|
|
2996
3116
|
pbx: string;
|
|
3117
|
+
time: number;
|
|
2997
3118
|
company: string;
|
|
2998
3119
|
type: ServiceConsumeEventType;
|
|
2999
3120
|
/**
|
|
3000
|
-
*
|
|
3121
|
+
* Base service call structure.
|
|
3001
3122
|
* @public
|
|
3002
3123
|
*/
|
|
3003
3124
|
data: ServiceCallConsumeEventData;
|
|
@@ -3006,13 +3127,21 @@ export interface ServiceCallInitConsumeEvent {
|
|
|
3006
3127
|
* @public
|
|
3007
3128
|
*/
|
|
3008
3129
|
export interface ServiceCallUpdateConsumeEvent {
|
|
3130
|
+
/**
|
|
3131
|
+
* The unique identifier of the service.
|
|
3132
|
+
* @public
|
|
3133
|
+
*/
|
|
3009
3134
|
id: string;
|
|
3010
|
-
|
|
3135
|
+
/**
|
|
3136
|
+
* The PBX identifier of the service.
|
|
3137
|
+
* @public
|
|
3138
|
+
*/
|
|
3011
3139
|
pbx: string;
|
|
3140
|
+
time: number;
|
|
3012
3141
|
company: string;
|
|
3013
3142
|
type: ServiceConsumeEventType;
|
|
3014
3143
|
/**
|
|
3015
|
-
*
|
|
3144
|
+
* Base service call structure.
|
|
3016
3145
|
* @public
|
|
3017
3146
|
*/
|
|
3018
3147
|
data: ServiceCallConsumeEventData;
|
|
@@ -3021,9 +3150,17 @@ export interface ServiceCallUpdateConsumeEvent {
|
|
|
3021
3150
|
* @public
|
|
3022
3151
|
*/
|
|
3023
3152
|
export interface ServiceEndConsumeEvent {
|
|
3153
|
+
/**
|
|
3154
|
+
* The unique identifier of the service.
|
|
3155
|
+
* @public
|
|
3156
|
+
*/
|
|
3024
3157
|
id: string;
|
|
3025
|
-
|
|
3158
|
+
/**
|
|
3159
|
+
* The PBX identifier of the service.
|
|
3160
|
+
* @public
|
|
3161
|
+
*/
|
|
3026
3162
|
pbx: string;
|
|
3163
|
+
time: number;
|
|
3027
3164
|
company: string;
|
|
3028
3165
|
type: ServiceConsumeEventType;
|
|
3029
3166
|
}
|
|
@@ -3035,18 +3172,45 @@ export interface ServiceAgent {
|
|
|
3035
3172
|
penalty?: string | undefined;
|
|
3036
3173
|
type?: ServiceAgentType | undefined;
|
|
3037
3174
|
paused?: boolean | undefined;
|
|
3175
|
+
status?: string | undefined;
|
|
3176
|
+
reason?: string | undefined;
|
|
3177
|
+
message?: string | undefined;
|
|
3038
3178
|
lastQueueCallEnd?: number | undefined;
|
|
3039
3179
|
userExtension?: string | undefined;
|
|
3180
|
+
department?: string | undefined;
|
|
3040
3181
|
name?: string | undefined;
|
|
3182
|
+
aclGroup?: string | undefined;
|
|
3041
3183
|
}
|
|
3042
3184
|
/**
|
|
3043
3185
|
* @public
|
|
3044
3186
|
*/
|
|
3045
3187
|
export interface ServiceConsumeEventData {
|
|
3046
|
-
|
|
3188
|
+
/**
|
|
3189
|
+
* The display name of the service.
|
|
3190
|
+
* @public
|
|
3191
|
+
*/
|
|
3192
|
+
name: string;
|
|
3193
|
+
/**
|
|
3194
|
+
* Call distribution strategy inside the service (e.g., 'ringall', 'linear', 'rrmemory')
|
|
3195
|
+
* @public
|
|
3196
|
+
*/
|
|
3047
3197
|
strategy?: string | undefined;
|
|
3048
3198
|
maxCalls?: string | undefined;
|
|
3199
|
+
/**
|
|
3200
|
+
* Defines the service priority among other services in terms of call distribution to an agent
|
|
3201
|
+
* @public
|
|
3202
|
+
*/
|
|
3049
3203
|
weight?: string | undefined;
|
|
3204
|
+
/**
|
|
3205
|
+
* PBX timeZone (e.g., 'Europe/Kyiv').
|
|
3206
|
+
* @public
|
|
3207
|
+
*/
|
|
3208
|
+
timeZone?: string | undefined;
|
|
3209
|
+
/**
|
|
3210
|
+
* ACL group identifier associated with the service.
|
|
3211
|
+
* @public
|
|
3212
|
+
*/
|
|
3213
|
+
aclGroup?: string | undefined;
|
|
3050
3214
|
agents?: (ServiceAgent)[] | undefined;
|
|
3051
3215
|
calls?: (string)[] | undefined;
|
|
3052
3216
|
}
|
|
@@ -3054,9 +3218,17 @@ export interface ServiceConsumeEventData {
|
|
|
3054
3218
|
* @public
|
|
3055
3219
|
*/
|
|
3056
3220
|
export interface ServiceInitConsumeEvent {
|
|
3221
|
+
/**
|
|
3222
|
+
* The unique identifier of the service.
|
|
3223
|
+
* @public
|
|
3224
|
+
*/
|
|
3057
3225
|
id: string;
|
|
3058
|
-
|
|
3226
|
+
/**
|
|
3227
|
+
* The PBX identifier of the service.
|
|
3228
|
+
* @public
|
|
3229
|
+
*/
|
|
3059
3230
|
pbx: string;
|
|
3231
|
+
time: number;
|
|
3060
3232
|
company: string;
|
|
3061
3233
|
type: ServiceConsumeEventType;
|
|
3062
3234
|
data: ServiceConsumeEventData;
|
|
@@ -3065,9 +3237,17 @@ export interface ServiceInitConsumeEvent {
|
|
|
3065
3237
|
* @public
|
|
3066
3238
|
*/
|
|
3067
3239
|
export interface ServiceUpdateConsumeEvent {
|
|
3240
|
+
/**
|
|
3241
|
+
* The unique identifier of the service.
|
|
3242
|
+
* @public
|
|
3243
|
+
*/
|
|
3068
3244
|
id: string;
|
|
3069
|
-
|
|
3245
|
+
/**
|
|
3246
|
+
* The PBX identifier of the service.
|
|
3247
|
+
* @public
|
|
3248
|
+
*/
|
|
3070
3249
|
pbx: string;
|
|
3250
|
+
time: number;
|
|
3071
3251
|
company: string;
|
|
3072
3252
|
type: ServiceConsumeEventType;
|
|
3073
3253
|
data: ServiceConsumeEventData;
|
|
@@ -5508,15 +5688,76 @@ export declare const PresenceEventType: {
|
|
|
5508
5688
|
* @public
|
|
5509
5689
|
*/
|
|
5510
5690
|
export type PresenceEventType = typeof PresenceEventType[keyof typeof PresenceEventType];
|
|
5691
|
+
/**
|
|
5692
|
+
* Record representation of a service agent status update.
|
|
5693
|
+
* @public
|
|
5694
|
+
*/
|
|
5695
|
+
export interface ServiceAgentsStatusAnalyticsRecordEvent {
|
|
5696
|
+
/**
|
|
5697
|
+
* The unique identifier of the service.
|
|
5698
|
+
* @public
|
|
5699
|
+
*/
|
|
5700
|
+
id: string;
|
|
5701
|
+
/**
|
|
5702
|
+
* The PBX identifier of the service.
|
|
5703
|
+
* @public
|
|
5704
|
+
*/
|
|
5705
|
+
pbx: string;
|
|
5706
|
+
time: number;
|
|
5707
|
+
company: string;
|
|
5708
|
+
/**
|
|
5709
|
+
* The display name of the service.
|
|
5710
|
+
* @public
|
|
5711
|
+
*/
|
|
5712
|
+
name: string;
|
|
5713
|
+
/**
|
|
5714
|
+
* Call distribution strategy inside the service (e.g., 'ringall', 'linear', 'rrmemory')
|
|
5715
|
+
* @public
|
|
5716
|
+
*/
|
|
5717
|
+
strategy?: string | undefined;
|
|
5718
|
+
maxCalls?: string | undefined;
|
|
5719
|
+
/**
|
|
5720
|
+
* Defines the service priority among other services in terms of call distribution to an agent
|
|
5721
|
+
* @public
|
|
5722
|
+
*/
|
|
5723
|
+
weight?: string | undefined;
|
|
5724
|
+
/**
|
|
5725
|
+
* PBX timeZone (e.g., 'Europe/Kyiv').
|
|
5726
|
+
* @public
|
|
5727
|
+
*/
|
|
5728
|
+
timeZone?: string | undefined;
|
|
5729
|
+
/**
|
|
5730
|
+
* ACL group identifier associated with the service.
|
|
5731
|
+
* @public
|
|
5732
|
+
*/
|
|
5733
|
+
aclGroup?: string | undefined;
|
|
5734
|
+
/**
|
|
5735
|
+
* Type discriminator; always 'service_agent_status' for this event.
|
|
5736
|
+
* @public
|
|
5737
|
+
*/
|
|
5738
|
+
type: LiveEventType;
|
|
5739
|
+
/**
|
|
5740
|
+
* List of agent objects for which status was recorded.
|
|
5741
|
+
* @public
|
|
5742
|
+
*/
|
|
5743
|
+
agents: (ServiceAgent)[];
|
|
5744
|
+
}
|
|
5511
5745
|
/**
|
|
5512
5746
|
* @public
|
|
5513
5747
|
*/
|
|
5514
5748
|
export interface ServiceAnalyticsLiveCompleteEvent {
|
|
5749
|
+
/**
|
|
5750
|
+
* The unique identifier of the service.
|
|
5751
|
+
* @public
|
|
5752
|
+
*/
|
|
5515
5753
|
id: string;
|
|
5754
|
+
/**
|
|
5755
|
+
* The PBX identifier of the service.
|
|
5756
|
+
* @public
|
|
5757
|
+
*/
|
|
5516
5758
|
pbx: string;
|
|
5517
5759
|
time: number;
|
|
5518
5760
|
company: string;
|
|
5519
|
-
licenses: (License)[];
|
|
5520
5761
|
event: LiveEventType;
|
|
5521
5762
|
}
|
|
5522
5763
|
/**
|
|
@@ -5542,22 +5783,27 @@ export type ServiceAnalyticsEventTrigger = typeof ServiceAnalyticsEventTrigger[k
|
|
|
5542
5783
|
* @public
|
|
5543
5784
|
*/
|
|
5544
5785
|
export interface ServiceAnalyticsLiveProgressEvent {
|
|
5786
|
+
/**
|
|
5787
|
+
* The unique identifier of the service.
|
|
5788
|
+
* @public
|
|
5789
|
+
*/
|
|
5545
5790
|
id: string;
|
|
5791
|
+
/**
|
|
5792
|
+
* The PBX identifier of the service.
|
|
5793
|
+
* @public
|
|
5794
|
+
*/
|
|
5546
5795
|
pbx: string;
|
|
5547
5796
|
time: number;
|
|
5548
5797
|
company: string;
|
|
5549
|
-
licenses: (License)[];
|
|
5550
|
-
event: LiveEventType;
|
|
5551
5798
|
/**
|
|
5552
|
-
*
|
|
5799
|
+
* The display name of the service.
|
|
5553
5800
|
* @public
|
|
5554
5801
|
*/
|
|
5555
|
-
|
|
5802
|
+
name: string;
|
|
5556
5803
|
/**
|
|
5557
|
-
*
|
|
5804
|
+
* Call distribution strategy inside the service (e.g., 'ringall', 'linear', 'rrmemory')
|
|
5558
5805
|
* @public
|
|
5559
5806
|
*/
|
|
5560
|
-
name?: string | undefined;
|
|
5561
5807
|
strategy?: string | undefined;
|
|
5562
5808
|
maxCalls?: string | undefined;
|
|
5563
5809
|
/**
|
|
@@ -5565,6 +5811,22 @@ export interface ServiceAnalyticsLiveProgressEvent {
|
|
|
5565
5811
|
* @public
|
|
5566
5812
|
*/
|
|
5567
5813
|
weight?: string | undefined;
|
|
5814
|
+
/**
|
|
5815
|
+
* PBX timeZone (e.g., 'Europe/Kyiv').
|
|
5816
|
+
* @public
|
|
5817
|
+
*/
|
|
5818
|
+
timeZone?: string | undefined;
|
|
5819
|
+
/**
|
|
5820
|
+
* ACL group identifier associated with the service.
|
|
5821
|
+
* @public
|
|
5822
|
+
*/
|
|
5823
|
+
aclGroup?: string | undefined;
|
|
5824
|
+
event: LiveEventType;
|
|
5825
|
+
/**
|
|
5826
|
+
* An original event that triggers current one.
|
|
5827
|
+
* @public
|
|
5828
|
+
*/
|
|
5829
|
+
eventTrigger: ServiceAnalyticsEventTrigger;
|
|
5568
5830
|
/**
|
|
5569
5831
|
* List of agents assigned to the service
|
|
5570
5832
|
* @public
|
|
@@ -5577,39 +5839,97 @@ export interface ServiceAnalyticsLiveProgressEvent {
|
|
|
5577
5839
|
calls?: (string)[] | undefined;
|
|
5578
5840
|
}
|
|
5579
5841
|
/**
|
|
5580
|
-
*
|
|
5842
|
+
* Base service call structure.
|
|
5581
5843
|
* @public
|
|
5582
5844
|
*/
|
|
5583
5845
|
export interface ServiceCallAnalyticsLiveCompleteEvent {
|
|
5846
|
+
/**
|
|
5847
|
+
* The unique identifier of the service.
|
|
5848
|
+
* @public
|
|
5849
|
+
*/
|
|
5584
5850
|
id: string;
|
|
5851
|
+
/**
|
|
5852
|
+
* The PBX identifier of the service.
|
|
5853
|
+
* @public
|
|
5854
|
+
*/
|
|
5585
5855
|
pbx: string;
|
|
5586
5856
|
time: number;
|
|
5587
5857
|
company: string;
|
|
5588
|
-
|
|
5858
|
+
/**
|
|
5859
|
+
* Action performed at this step (e.g., INIT, RING, CANCEL, ANSWER, END).
|
|
5860
|
+
* It's optional, can be absent in case some service call fields updated, while action is not changed.
|
|
5861
|
+
* @public
|
|
5862
|
+
*/
|
|
5863
|
+
action?: ServiceCallAction | undefined;
|
|
5864
|
+
/**
|
|
5865
|
+
* Optional human-readable reason (e.g., 'timeout', 'Normal call clearing').
|
|
5866
|
+
* @public
|
|
5867
|
+
*/
|
|
5868
|
+
reason?: string | undefined;
|
|
5869
|
+
/**
|
|
5870
|
+
* Agents related to this action (typically those ringing/answering/cancelling).
|
|
5871
|
+
* @public
|
|
5872
|
+
*/
|
|
5873
|
+
relatedAgents?: (string)[] | undefined;
|
|
5874
|
+
/**
|
|
5875
|
+
* Identifier of the call this record describes.
|
|
5876
|
+
* @public
|
|
5877
|
+
*/
|
|
5589
5878
|
callId: string;
|
|
5879
|
+
/**
|
|
5880
|
+
* Index of a call segment inside one call session. A call can have several flows after CALL.SPLIT (transfer, redirect, etc.)
|
|
5881
|
+
* @public
|
|
5882
|
+
*/
|
|
5883
|
+
flowId?: number | undefined;
|
|
5590
5884
|
startTime?: number | undefined;
|
|
5591
5885
|
direction?: CallDirection | undefined;
|
|
5592
|
-
action?: ServiceCallAction | undefined;
|
|
5593
|
-
customer?: ServiceCustomer | undefined;
|
|
5594
|
-
relatedAgents?: (string)[] | undefined;
|
|
5595
5886
|
event: LiveEventType;
|
|
5596
5887
|
}
|
|
5597
5888
|
/**
|
|
5598
|
-
*
|
|
5889
|
+
* Base service call structure.
|
|
5599
5890
|
* @public
|
|
5600
5891
|
*/
|
|
5601
5892
|
export interface ServiceCallAnalyticsLiveProgressEvent {
|
|
5893
|
+
/**
|
|
5894
|
+
* The unique identifier of the service.
|
|
5895
|
+
* @public
|
|
5896
|
+
*/
|
|
5602
5897
|
id: string;
|
|
5898
|
+
/**
|
|
5899
|
+
* The PBX identifier of the service.
|
|
5900
|
+
* @public
|
|
5901
|
+
*/
|
|
5603
5902
|
pbx: string;
|
|
5604
5903
|
time: number;
|
|
5605
5904
|
company: string;
|
|
5606
|
-
|
|
5905
|
+
/**
|
|
5906
|
+
* Action performed at this step (e.g., INIT, RING, CANCEL, ANSWER, END).
|
|
5907
|
+
* It's optional, can be absent in case some service call fields updated, while action is not changed.
|
|
5908
|
+
* @public
|
|
5909
|
+
*/
|
|
5910
|
+
action?: ServiceCallAction | undefined;
|
|
5911
|
+
/**
|
|
5912
|
+
* Optional human-readable reason (e.g., 'timeout', 'Normal call clearing').
|
|
5913
|
+
* @public
|
|
5914
|
+
*/
|
|
5915
|
+
reason?: string | undefined;
|
|
5916
|
+
/**
|
|
5917
|
+
* Agents related to this action (typically those ringing/answering/cancelling).
|
|
5918
|
+
* @public
|
|
5919
|
+
*/
|
|
5920
|
+
relatedAgents?: (string)[] | undefined;
|
|
5921
|
+
/**
|
|
5922
|
+
* Identifier of the call this record describes.
|
|
5923
|
+
* @public
|
|
5924
|
+
*/
|
|
5607
5925
|
callId: string;
|
|
5926
|
+
/**
|
|
5927
|
+
* Index of a call segment inside one call session. A call can have several flows after CALL.SPLIT (transfer, redirect, etc.)
|
|
5928
|
+
* @public
|
|
5929
|
+
*/
|
|
5930
|
+
flowId?: number | undefined;
|
|
5608
5931
|
startTime?: number | undefined;
|
|
5609
5932
|
direction?: CallDirection | undefined;
|
|
5610
|
-
action?: ServiceCallAction | undefined;
|
|
5611
|
-
customer?: ServiceCustomer | undefined;
|
|
5612
|
-
relatedAgents?: (string)[] | undefined;
|
|
5613
5933
|
event: LiveEventType;
|
|
5614
5934
|
/**
|
|
5615
5935
|
* An original event that triggers current one.
|
|
@@ -5617,6 +5937,109 @@ export interface ServiceCallAnalyticsLiveProgressEvent {
|
|
|
5617
5937
|
*/
|
|
5618
5938
|
eventTrigger: ServiceAnalyticsEventTrigger;
|
|
5619
5939
|
}
|
|
5940
|
+
/**
|
|
5941
|
+
* A single lifecycle entry inside ServiceCallAnalyticsRecordEvent.actions, capturing the original triggering event, the resulting action, and the agents involved at that moment.
|
|
5942
|
+
* @public
|
|
5943
|
+
*/
|
|
5944
|
+
export interface ServiceCallRecord {
|
|
5945
|
+
/**
|
|
5946
|
+
* Action performed at this step (e.g., INIT, RING, CANCEL, ANSWER, END).
|
|
5947
|
+
* It's optional, can be absent in case some service call fields updated, while action is not changed.
|
|
5948
|
+
* @public
|
|
5949
|
+
*/
|
|
5950
|
+
action?: ServiceCallAction | undefined;
|
|
5951
|
+
/**
|
|
5952
|
+
* Optional human-readable reason (e.g., 'timeout', 'Normal call clearing').
|
|
5953
|
+
* @public
|
|
5954
|
+
*/
|
|
5955
|
+
reason?: string | undefined;
|
|
5956
|
+
/**
|
|
5957
|
+
* Agents related to this action (typically those ringing/answering/cancelling).
|
|
5958
|
+
* @public
|
|
5959
|
+
*/
|
|
5960
|
+
relatedAgents?: (string)[] | undefined;
|
|
5961
|
+
/**
|
|
5962
|
+
* Time when the action was emitted (epoch ms).
|
|
5963
|
+
* @public
|
|
5964
|
+
*/
|
|
5965
|
+
time: number;
|
|
5966
|
+
/**
|
|
5967
|
+
* Original event that triggered this action.
|
|
5968
|
+
* @public
|
|
5969
|
+
*/
|
|
5970
|
+
eventTrigger: ServiceAnalyticsEventTrigger;
|
|
5971
|
+
}
|
|
5972
|
+
/**
|
|
5973
|
+
* Finalized record representation of a service call lifecycle, containing the full ordered sequence of lifecycle actions from queue entry to end.
|
|
5974
|
+
* @public
|
|
5975
|
+
*/
|
|
5976
|
+
export interface ServiceCallAnalyticsRecordEvent {
|
|
5977
|
+
/**
|
|
5978
|
+
* The unique identifier of the service.
|
|
5979
|
+
* @public
|
|
5980
|
+
*/
|
|
5981
|
+
id: string;
|
|
5982
|
+
/**
|
|
5983
|
+
* The PBX identifier of the service.
|
|
5984
|
+
* @public
|
|
5985
|
+
*/
|
|
5986
|
+
pbx: string;
|
|
5987
|
+
time: number;
|
|
5988
|
+
company: string;
|
|
5989
|
+
/**
|
|
5990
|
+
* The display name of the service.
|
|
5991
|
+
* @public
|
|
5992
|
+
*/
|
|
5993
|
+
name: string;
|
|
5994
|
+
/**
|
|
5995
|
+
* Call distribution strategy inside the service (e.g., 'ringall', 'linear', 'rrmemory')
|
|
5996
|
+
* @public
|
|
5997
|
+
*/
|
|
5998
|
+
strategy?: string | undefined;
|
|
5999
|
+
maxCalls?: string | undefined;
|
|
6000
|
+
/**
|
|
6001
|
+
* Defines the service priority among other services in terms of call distribution to an agent
|
|
6002
|
+
* @public
|
|
6003
|
+
*/
|
|
6004
|
+
weight?: string | undefined;
|
|
6005
|
+
/**
|
|
6006
|
+
* PBX timeZone (e.g., 'Europe/Kyiv').
|
|
6007
|
+
* @public
|
|
6008
|
+
*/
|
|
6009
|
+
timeZone?: string | undefined;
|
|
6010
|
+
/**
|
|
6011
|
+
* ACL group identifier associated with the service.
|
|
6012
|
+
* @public
|
|
6013
|
+
*/
|
|
6014
|
+
aclGroup?: string | undefined;
|
|
6015
|
+
/**
|
|
6016
|
+
* Identifier of the call this record describes.
|
|
6017
|
+
* @public
|
|
6018
|
+
*/
|
|
6019
|
+
callId: string;
|
|
6020
|
+
/**
|
|
6021
|
+
* Index of a call segment inside one call session. A call can have several flows after CALL.SPLIT (transfer, redirect, etc.)
|
|
6022
|
+
* @public
|
|
6023
|
+
*/
|
|
6024
|
+
flowId?: number | undefined;
|
|
6025
|
+
startTime?: number | undefined;
|
|
6026
|
+
direction?: CallDirection | undefined;
|
|
6027
|
+
/**
|
|
6028
|
+
* Type discriminator; always 'service_call' for this event.
|
|
6029
|
+
* @public
|
|
6030
|
+
*/
|
|
6031
|
+
type: LiveEventType;
|
|
6032
|
+
/**
|
|
6033
|
+
* Agents assigned to the service at record finalization time.
|
|
6034
|
+
* @public
|
|
6035
|
+
*/
|
|
6036
|
+
agents?: (ServiceAgent)[] | undefined;
|
|
6037
|
+
/**
|
|
6038
|
+
* Ordered list of lifecycle actions for the service call.
|
|
6039
|
+
* @public
|
|
6040
|
+
*/
|
|
6041
|
+
actions: (ServiceCallRecord)[];
|
|
6042
|
+
}
|
|
5620
6043
|
/**
|
|
5621
6044
|
* @public
|
|
5622
6045
|
* @enum
|
|
@@ -5624,6 +6047,7 @@ export interface ServiceCallAnalyticsLiveProgressEvent {
|
|
|
5624
6047
|
export declare const ServiceCallEventType: {
|
|
5625
6048
|
readonly LIVE_COMPLETE_EVENT: "ServiceCallAnalyticsLiveCompleteEvent";
|
|
5626
6049
|
readonly LIVE_PROGRESS_EVENT: "ServiceCallAnalyticsLiveProgressEvent";
|
|
6050
|
+
readonly RECORD_EVENT: "ServiceCallAnalyticsRecordEvent";
|
|
5627
6051
|
};
|
|
5628
6052
|
/**
|
|
5629
6053
|
* @public
|
|
@@ -5634,6 +6058,7 @@ export type ServiceCallEventType = typeof ServiceCallEventType[keyof typeof Serv
|
|
|
5634
6058
|
* @enum
|
|
5635
6059
|
*/
|
|
5636
6060
|
export declare const ServiceEventType: {
|
|
6061
|
+
readonly AGENTS_STATUS_RECORD_EVENT: "ServiceAgentsStatusAnalyticsRecordEvent";
|
|
5637
6062
|
readonly LIVE_COMPLETE_EVENT: "ServiceAnalyticsLiveCompleteEvent";
|
|
5638
6063
|
readonly LIVE_PROGRESS_EVENT: "ServiceAnalyticsLiveProgressEvent";
|
|
5639
6064
|
};
|
|
@@ -6274,36 +6699,3 @@ export interface WebsocketConversationsBroadcastEvent {
|
|
|
6274
6699
|
data: __DocumentType;
|
|
6275
6700
|
meta?: __DocumentType | undefined;
|
|
6276
6701
|
}
|
|
6277
|
-
/**
|
|
6278
|
-
* @public
|
|
6279
|
-
*/
|
|
6280
|
-
export interface WebsocketPresenceData {
|
|
6281
|
-
id?: string | undefined;
|
|
6282
|
-
company?: string | undefined;
|
|
6283
|
-
extension?: string | undefined;
|
|
6284
|
-
status?: string | undefined;
|
|
6285
|
-
telephony?: string | undefined;
|
|
6286
|
-
conference?: string | undefined;
|
|
6287
|
-
message?: string | undefined;
|
|
6288
|
-
until?: string | undefined;
|
|
6289
|
-
address?: string | undefined;
|
|
6290
|
-
lng?: string | undefined;
|
|
6291
|
-
lat?: string | undefined;
|
|
6292
|
-
seen?: string | undefined;
|
|
6293
|
-
}
|
|
6294
|
-
/**
|
|
6295
|
-
* @public
|
|
6296
|
-
*/
|
|
6297
|
-
export interface WebsocketPresenceDataList {
|
|
6298
|
-
member?: WebsocketPresenceData | undefined;
|
|
6299
|
-
}
|
|
6300
|
-
/**
|
|
6301
|
-
* @public
|
|
6302
|
-
*/
|
|
6303
|
-
export interface WebsocketPresenceBroadcastEvent {
|
|
6304
|
-
event: WebsocketEvent;
|
|
6305
|
-
topic: WebsocketTopic;
|
|
6306
|
-
delta?: WebsocketPresenceData | undefined;
|
|
6307
|
-
data?: WebsocketPresenceDataList | undefined;
|
|
6308
|
-
meta?: __DocumentType | undefined;
|
|
6309
|
-
}
|