@wildix/wda-stream-client 1.1.38 → 1.1.40
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/WdaStream.js +8 -0
- package/dist-cjs/commands/GetOngoingCallCommand.js +21 -0
- package/dist-cjs/commands/GetOngoingCallTranscriptionCommand.js +21 -0
- package/dist-cjs/commands/GetOngoingConferenceCommand.js +21 -0
- package/dist-cjs/commands/GetOngoingConferenceTranscriptionCommand.js +21 -0
- package/dist-cjs/commands/index.js +4 -0
- package/dist-cjs/protocols/Aws_restJson1.js +129 -1
- package/dist-es/WdaStream.js +8 -0
- package/dist-es/commands/GetOngoingCallCommand.js +17 -0
- package/dist-es/commands/GetOngoingCallTranscriptionCommand.js +17 -0
- package/dist-es/commands/GetOngoingConferenceCommand.js +17 -0
- package/dist-es/commands/GetOngoingConferenceTranscriptionCommand.js +17 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +120 -0
- package/dist-types/WdaStream.d.ts +28 -0
- package/dist-types/WdaStreamClient.d.ts +6 -2
- package/dist-types/commands/GetOngoingCallCommand.d.ts +251 -0
- package/dist-types/commands/GetOngoingCallTranscriptionCommand.d.ts +297 -0
- package/dist-types/commands/GetOngoingConferenceCommand.d.ts +106 -0
- package/dist-types/commands/GetOngoingConferenceTranscriptionCommand.d.ts +142 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +56 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +1 -1
|
@@ -0,0 +1,251 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WdaStreamClientResolvedConfig } from "../WdaStreamClient";
|
|
2
|
+
import { GetOngoingCallInput, GetOngoingCallOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetOngoingCallCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetOngoingCallCommandInput extends GetOngoingCallInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetOngoingCallCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetOngoingCallCommandOutput extends GetOngoingCallOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetOngoingCallCommand_base: {
|
|
25
|
+
new (input: GetOngoingCallCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingCallCommandInput, GetOngoingCallCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetOngoingCallCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingCallCommandInput, GetOngoingCallCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves information for ongoing call.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WdaStreamClient, GetOngoingCallCommand } from "@wildix/wda-stream-client"; // ES Modules import
|
|
35
|
+
* // const { WdaStreamClient, GetOngoingCallCommand } = require("@wildix/wda-stream-client"); // CommonJS import
|
|
36
|
+
* const client = new WdaStreamClient(config);
|
|
37
|
+
* const input = { // GetOngoingCallInput
|
|
38
|
+
* company: "STRING_VALUE",
|
|
39
|
+
* callId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetOngoingCallCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetOngoingCallOutput
|
|
44
|
+
* // company: "STRING_VALUE", // required
|
|
45
|
+
* // flows: [ // CallAnalyticsLiveProgressEventFlowList // required
|
|
46
|
+
* // { // CallAnalyticsLiveProgressEventFlow
|
|
47
|
+
* // flowIndex: Number("int"), // required
|
|
48
|
+
* // startTime: Number("long"), // required
|
|
49
|
+
* // endTime: Number("long"), // required
|
|
50
|
+
* // connectTime: Number("long"),
|
|
51
|
+
* // talkTime: Number("long"),
|
|
52
|
+
* // waitTime: Number("long"),
|
|
53
|
+
* // queueTime: Number("long"),
|
|
54
|
+
* // holdTime: Number("long"),
|
|
55
|
+
* // duration: Number("long"), // required
|
|
56
|
+
* // caller: { // CallParticipant
|
|
57
|
+
* // type: "REMOTE" || "LOCAL", // required
|
|
58
|
+
* // phone: "STRING_VALUE",
|
|
59
|
+
* // name: "STRING_VALUE",
|
|
60
|
+
* // company: "STRING_VALUE",
|
|
61
|
+
* // email: "STRING_VALUE",
|
|
62
|
+
* // userId: "STRING_VALUE",
|
|
63
|
+
* // userExtension: "STRING_VALUE",
|
|
64
|
+
* // userDepartment: "STRING_VALUE",
|
|
65
|
+
* // groupId: "STRING_VALUE",
|
|
66
|
+
* // groupName: "STRING_VALUE",
|
|
67
|
+
* // userAgent: "STRING_VALUE",
|
|
68
|
+
* // userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "VOICEBOT" || "UNKNOWN",
|
|
69
|
+
* // role: "CLIENT" || "AGENT", // required
|
|
70
|
+
* // license: "STRING_VALUE",
|
|
71
|
+
* // sipCallId: "STRING_VALUE",
|
|
72
|
+
* // publicAddress: "STRING_VALUE",
|
|
73
|
+
* // privateAddress: "STRING_VALUE",
|
|
74
|
+
* // location: "STRING_VALUE",
|
|
75
|
+
* // },
|
|
76
|
+
* // callee: {
|
|
77
|
+
* // type: "REMOTE" || "LOCAL", // required
|
|
78
|
+
* // phone: "STRING_VALUE",
|
|
79
|
+
* // name: "STRING_VALUE",
|
|
80
|
+
* // company: "STRING_VALUE",
|
|
81
|
+
* // email: "STRING_VALUE",
|
|
82
|
+
* // userId: "STRING_VALUE",
|
|
83
|
+
* // userExtension: "STRING_VALUE",
|
|
84
|
+
* // userDepartment: "STRING_VALUE",
|
|
85
|
+
* // groupId: "STRING_VALUE",
|
|
86
|
+
* // groupName: "STRING_VALUE",
|
|
87
|
+
* // userAgent: "STRING_VALUE",
|
|
88
|
+
* // userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "VOICEBOT" || "UNKNOWN",
|
|
89
|
+
* // role: "CLIENT" || "AGENT", // required
|
|
90
|
+
* // license: "STRING_VALUE",
|
|
91
|
+
* // sipCallId: "STRING_VALUE",
|
|
92
|
+
* // publicAddress: "STRING_VALUE",
|
|
93
|
+
* // privateAddress: "STRING_VALUE",
|
|
94
|
+
* // location: "STRING_VALUE",
|
|
95
|
+
* // },
|
|
96
|
+
* // service: "STRING_VALUE",
|
|
97
|
+
* // serviceNumber: "STRING_VALUE",
|
|
98
|
+
* // destination: "STRING_VALUE",
|
|
99
|
+
* // direction: "INTERNAL" || "INBOUND" || "OUTBOUND" || "UNDEFINED",
|
|
100
|
+
* // trunkName: "STRING_VALUE",
|
|
101
|
+
* // trunkDirection: "STRING_VALUE",
|
|
102
|
+
* // queueName: "STRING_VALUE",
|
|
103
|
+
* // queueId: "STRING_VALUE",
|
|
104
|
+
* // tags: [ // CallFlowTags
|
|
105
|
+
* // "STRING_VALUE",
|
|
106
|
+
* // ],
|
|
107
|
+
* // flags: [ // CallFlowFlags
|
|
108
|
+
* // "STRING_VALUE",
|
|
109
|
+
* // ],
|
|
110
|
+
* // callerMos: "STRING_VALUE",
|
|
111
|
+
* // calleeMos: "STRING_VALUE",
|
|
112
|
+
* // xhoppersConfId: "STRING_VALUE",
|
|
113
|
+
* // recordings: [ // CallFlowRecordings
|
|
114
|
+
* // "STRING_VALUE",
|
|
115
|
+
* // ],
|
|
116
|
+
* // recordingsData: [ // CallFlowRecordingsData
|
|
117
|
+
* // { // CallFlowRecording
|
|
118
|
+
* // fileName: "STRING_VALUE", // required
|
|
119
|
+
* // start: Number("long"), // required
|
|
120
|
+
* // end: Number("long"), // required
|
|
121
|
+
* // owner: "callee" || "caller" || "system", // required
|
|
122
|
+
* // url: "STRING_VALUE", // required
|
|
123
|
+
* // pauses: [ // CallRecordPausesList // required
|
|
124
|
+
* // { // CallRecordPause
|
|
125
|
+
* // start: Number("long"),
|
|
126
|
+
* // end: Number("long"),
|
|
127
|
+
* // reason: "pause" || "hold",
|
|
128
|
+
* // },
|
|
129
|
+
* // ],
|
|
130
|
+
* // },
|
|
131
|
+
* // ],
|
|
132
|
+
* // mergeWith: "STRING_VALUE",
|
|
133
|
+
* // splitReason: "STRING_VALUE",
|
|
134
|
+
* // splitTransferType: "STRING_VALUE",
|
|
135
|
+
* // remotePhone: "STRING_VALUE",
|
|
136
|
+
* // remotePhoneCountryCode: Number("int"),
|
|
137
|
+
* // remotePhoneCountryCodeStr: "STRING_VALUE",
|
|
138
|
+
* // remotePhoneLocation: "STRING_VALUE",
|
|
139
|
+
* // callStatus: "COMPLETED" || "MISSED",
|
|
140
|
+
* // transcriptionStatus: "AVAILABLE" || "POST_TRANSCRIPTION" || "UNAVAILABLE",
|
|
141
|
+
* // transcriptionLanguage: "STRING_VALUE",
|
|
142
|
+
* // transcriptionSeconds: Number("int"),
|
|
143
|
+
* // attachment: "STRING_VALUE",
|
|
144
|
+
* // attachmentType: "VOICEMAIL" || "FAX",
|
|
145
|
+
* // attachmentDestinations: [ // CallFlowAttachmentDestinationList
|
|
146
|
+
* // { // CallFlowAttachmentDestination
|
|
147
|
+
* // phone: "STRING_VALUE",
|
|
148
|
+
* // name: "STRING_VALUE",
|
|
149
|
+
* // email: "STRING_VALUE",
|
|
150
|
+
* // userId: "STRING_VALUE",
|
|
151
|
+
* // userExtension: "STRING_VALUE",
|
|
152
|
+
* // userDepartment: "STRING_VALUE",
|
|
153
|
+
* // groupId: "STRING_VALUE",
|
|
154
|
+
* // groupName: "STRING_VALUE",
|
|
155
|
+
* // },
|
|
156
|
+
* // ],
|
|
157
|
+
* // attachments: [ // CallFlowAttachments
|
|
158
|
+
* // { // CallFlowAttachment Union: only one key present
|
|
159
|
+
* // recording: {
|
|
160
|
+
* // fileName: "STRING_VALUE", // required
|
|
161
|
+
* // start: Number("long"), // required
|
|
162
|
+
* // end: Number("long"), // required
|
|
163
|
+
* // owner: "callee" || "caller" || "system", // required
|
|
164
|
+
* // url: "STRING_VALUE", // required
|
|
165
|
+
* // pauses: [ // required
|
|
166
|
+
* // {
|
|
167
|
+
* // start: Number("long"),
|
|
168
|
+
* // end: Number("long"),
|
|
169
|
+
* // reason: "pause" || "hold",
|
|
170
|
+
* // },
|
|
171
|
+
* // ],
|
|
172
|
+
* // },
|
|
173
|
+
* // fax: { // CallFlowFax
|
|
174
|
+
* // url: "STRING_VALUE", // required
|
|
175
|
+
* // status: "ok" || "error",
|
|
176
|
+
* // destinations: [
|
|
177
|
+
* // {
|
|
178
|
+
* // phone: "STRING_VALUE",
|
|
179
|
+
* // name: "STRING_VALUE",
|
|
180
|
+
* // email: "STRING_VALUE",
|
|
181
|
+
* // userId: "STRING_VALUE",
|
|
182
|
+
* // userExtension: "STRING_VALUE",
|
|
183
|
+
* // userDepartment: "STRING_VALUE",
|
|
184
|
+
* // groupId: "STRING_VALUE",
|
|
185
|
+
* // groupName: "STRING_VALUE",
|
|
186
|
+
* // },
|
|
187
|
+
* // ],
|
|
188
|
+
* // owner: "callee" || "caller" || "system",
|
|
189
|
+
* // error: "STRING_VALUE",
|
|
190
|
+
* // },
|
|
191
|
+
* // voicemail: { // CallFlowVoicemail
|
|
192
|
+
* // url: "STRING_VALUE", // required
|
|
193
|
+
* // destinations: [
|
|
194
|
+
* // {
|
|
195
|
+
* // phone: "STRING_VALUE",
|
|
196
|
+
* // name: "STRING_VALUE",
|
|
197
|
+
* // email: "STRING_VALUE",
|
|
198
|
+
* // userId: "STRING_VALUE",
|
|
199
|
+
* // userExtension: "STRING_VALUE",
|
|
200
|
+
* // userDepartment: "STRING_VALUE",
|
|
201
|
+
* // groupId: "STRING_VALUE",
|
|
202
|
+
* // groupName: "STRING_VALUE",
|
|
203
|
+
* // },
|
|
204
|
+
* // ],
|
|
205
|
+
* // owner: "callee" || "caller" || "system",
|
|
206
|
+
* // },
|
|
207
|
+
* // },
|
|
208
|
+
* // ],
|
|
209
|
+
* // notifications: { // CallFlowNotifications
|
|
210
|
+
* // destinations: "<CallFlowAttachmentDestinationList>",
|
|
211
|
+
* // type: [ // NotificationsType
|
|
212
|
+
* // "STRING_VALUE",
|
|
213
|
+
* // ],
|
|
214
|
+
* // },
|
|
215
|
+
* // status: "CONNECTING" || "TALKING" || "HOLD", // required
|
|
216
|
+
* // statusChangeDate: "STRING_VALUE", // required
|
|
217
|
+
* // },
|
|
218
|
+
* // ],
|
|
219
|
+
* // };
|
|
220
|
+
*
|
|
221
|
+
* ```
|
|
222
|
+
*
|
|
223
|
+
* @param GetOngoingCallCommandInput - {@link GetOngoingCallCommandInput}
|
|
224
|
+
* @returns {@link GetOngoingCallCommandOutput}
|
|
225
|
+
* @see {@link GetOngoingCallCommandInput} for command's `input` shape.
|
|
226
|
+
* @see {@link GetOngoingCallCommandOutput} for command's `response` shape.
|
|
227
|
+
* @see {@link WdaStreamClientResolvedConfig | config} for WdaStreamClient's `config` shape.
|
|
228
|
+
*
|
|
229
|
+
* @throws {@link ValidationException} (client fault)
|
|
230
|
+
*
|
|
231
|
+
* @throws {@link MatchNotFoundException} (client fault)
|
|
232
|
+
*
|
|
233
|
+
* @throws {@link WdaStreamServiceException}
|
|
234
|
+
* <p>Base exception class for all service exceptions from WdaStream service.</p>
|
|
235
|
+
*
|
|
236
|
+
*
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
export declare class GetOngoingCallCommand extends GetOngoingCallCommand_base {
|
|
240
|
+
/** @internal type navigation helper, not in runtime. */
|
|
241
|
+
protected static __types: {
|
|
242
|
+
api: {
|
|
243
|
+
input: GetOngoingCallInput;
|
|
244
|
+
output: GetOngoingCallOutput;
|
|
245
|
+
};
|
|
246
|
+
sdk: {
|
|
247
|
+
input: GetOngoingCallCommandInput;
|
|
248
|
+
output: GetOngoingCallCommandOutput;
|
|
249
|
+
};
|
|
250
|
+
};
|
|
251
|
+
}
|
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WdaStreamClientResolvedConfig } from "../WdaStreamClient";
|
|
2
|
+
import { GetOngoingCallTranscriptionInput, GetOngoingCallTranscriptionOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetOngoingCallTranscriptionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetOngoingCallTranscriptionCommandInput extends GetOngoingCallTranscriptionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetOngoingCallTranscriptionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetOngoingCallTranscriptionCommandOutput extends GetOngoingCallTranscriptionOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetOngoingCallTranscriptionCommand_base: {
|
|
25
|
+
new (input: GetOngoingCallTranscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingCallTranscriptionCommandInput, GetOngoingCallTranscriptionCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetOngoingCallTranscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingCallTranscriptionCommandInput, GetOngoingCallTranscriptionCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves information and transcription for ongoing call.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WdaStreamClient, GetOngoingCallTranscriptionCommand } from "@wildix/wda-stream-client"; // ES Modules import
|
|
35
|
+
* // const { WdaStreamClient, GetOngoingCallTranscriptionCommand } = require("@wildix/wda-stream-client"); // CommonJS import
|
|
36
|
+
* const client = new WdaStreamClient(config);
|
|
37
|
+
* const input = { // GetOngoingCallTranscriptionInput
|
|
38
|
+
* company: "STRING_VALUE",
|
|
39
|
+
* callId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetOngoingCallTranscriptionCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetOngoingCallTranscriptionOutput
|
|
44
|
+
* // company: "STRING_VALUE", // required
|
|
45
|
+
* // flows: [ // CallAnalyticsLiveProgressEventFlowList // required
|
|
46
|
+
* // { // CallAnalyticsLiveProgressEventFlow
|
|
47
|
+
* // flowIndex: Number("int"), // required
|
|
48
|
+
* // startTime: Number("long"), // required
|
|
49
|
+
* // endTime: Number("long"), // required
|
|
50
|
+
* // connectTime: Number("long"),
|
|
51
|
+
* // talkTime: Number("long"),
|
|
52
|
+
* // waitTime: Number("long"),
|
|
53
|
+
* // queueTime: Number("long"),
|
|
54
|
+
* // holdTime: Number("long"),
|
|
55
|
+
* // duration: Number("long"), // required
|
|
56
|
+
* // caller: { // CallParticipant
|
|
57
|
+
* // type: "REMOTE" || "LOCAL", // required
|
|
58
|
+
* // phone: "STRING_VALUE",
|
|
59
|
+
* // name: "STRING_VALUE",
|
|
60
|
+
* // company: "STRING_VALUE",
|
|
61
|
+
* // email: "STRING_VALUE",
|
|
62
|
+
* // userId: "STRING_VALUE",
|
|
63
|
+
* // userExtension: "STRING_VALUE",
|
|
64
|
+
* // userDepartment: "STRING_VALUE",
|
|
65
|
+
* // groupId: "STRING_VALUE",
|
|
66
|
+
* // groupName: "STRING_VALUE",
|
|
67
|
+
* // userAgent: "STRING_VALUE",
|
|
68
|
+
* // userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "VOICEBOT" || "UNKNOWN",
|
|
69
|
+
* // role: "CLIENT" || "AGENT", // required
|
|
70
|
+
* // license: "STRING_VALUE",
|
|
71
|
+
* // sipCallId: "STRING_VALUE",
|
|
72
|
+
* // publicAddress: "STRING_VALUE",
|
|
73
|
+
* // privateAddress: "STRING_VALUE",
|
|
74
|
+
* // location: "STRING_VALUE",
|
|
75
|
+
* // },
|
|
76
|
+
* // callee: {
|
|
77
|
+
* // type: "REMOTE" || "LOCAL", // required
|
|
78
|
+
* // phone: "STRING_VALUE",
|
|
79
|
+
* // name: "STRING_VALUE",
|
|
80
|
+
* // company: "STRING_VALUE",
|
|
81
|
+
* // email: "STRING_VALUE",
|
|
82
|
+
* // userId: "STRING_VALUE",
|
|
83
|
+
* // userExtension: "STRING_VALUE",
|
|
84
|
+
* // userDepartment: "STRING_VALUE",
|
|
85
|
+
* // groupId: "STRING_VALUE",
|
|
86
|
+
* // groupName: "STRING_VALUE",
|
|
87
|
+
* // userAgent: "STRING_VALUE",
|
|
88
|
+
* // userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "VOICEBOT" || "UNKNOWN",
|
|
89
|
+
* // role: "CLIENT" || "AGENT", // required
|
|
90
|
+
* // license: "STRING_VALUE",
|
|
91
|
+
* // sipCallId: "STRING_VALUE",
|
|
92
|
+
* // publicAddress: "STRING_VALUE",
|
|
93
|
+
* // privateAddress: "STRING_VALUE",
|
|
94
|
+
* // location: "STRING_VALUE",
|
|
95
|
+
* // },
|
|
96
|
+
* // service: "STRING_VALUE",
|
|
97
|
+
* // serviceNumber: "STRING_VALUE",
|
|
98
|
+
* // destination: "STRING_VALUE",
|
|
99
|
+
* // direction: "INTERNAL" || "INBOUND" || "OUTBOUND" || "UNDEFINED",
|
|
100
|
+
* // trunkName: "STRING_VALUE",
|
|
101
|
+
* // trunkDirection: "STRING_VALUE",
|
|
102
|
+
* // queueName: "STRING_VALUE",
|
|
103
|
+
* // queueId: "STRING_VALUE",
|
|
104
|
+
* // tags: [ // CallFlowTags
|
|
105
|
+
* // "STRING_VALUE",
|
|
106
|
+
* // ],
|
|
107
|
+
* // flags: [ // CallFlowFlags
|
|
108
|
+
* // "STRING_VALUE",
|
|
109
|
+
* // ],
|
|
110
|
+
* // callerMos: "STRING_VALUE",
|
|
111
|
+
* // calleeMos: "STRING_VALUE",
|
|
112
|
+
* // xhoppersConfId: "STRING_VALUE",
|
|
113
|
+
* // recordings: [ // CallFlowRecordings
|
|
114
|
+
* // "STRING_VALUE",
|
|
115
|
+
* // ],
|
|
116
|
+
* // recordingsData: [ // CallFlowRecordingsData
|
|
117
|
+
* // { // CallFlowRecording
|
|
118
|
+
* // fileName: "STRING_VALUE", // required
|
|
119
|
+
* // start: Number("long"), // required
|
|
120
|
+
* // end: Number("long"), // required
|
|
121
|
+
* // owner: "callee" || "caller" || "system", // required
|
|
122
|
+
* // url: "STRING_VALUE", // required
|
|
123
|
+
* // pauses: [ // CallRecordPausesList // required
|
|
124
|
+
* // { // CallRecordPause
|
|
125
|
+
* // start: Number("long"),
|
|
126
|
+
* // end: Number("long"),
|
|
127
|
+
* // reason: "pause" || "hold",
|
|
128
|
+
* // },
|
|
129
|
+
* // ],
|
|
130
|
+
* // },
|
|
131
|
+
* // ],
|
|
132
|
+
* // mergeWith: "STRING_VALUE",
|
|
133
|
+
* // splitReason: "STRING_VALUE",
|
|
134
|
+
* // splitTransferType: "STRING_VALUE",
|
|
135
|
+
* // remotePhone: "STRING_VALUE",
|
|
136
|
+
* // remotePhoneCountryCode: Number("int"),
|
|
137
|
+
* // remotePhoneCountryCodeStr: "STRING_VALUE",
|
|
138
|
+
* // remotePhoneLocation: "STRING_VALUE",
|
|
139
|
+
* // callStatus: "COMPLETED" || "MISSED",
|
|
140
|
+
* // transcriptionStatus: "AVAILABLE" || "POST_TRANSCRIPTION" || "UNAVAILABLE",
|
|
141
|
+
* // transcriptionLanguage: "STRING_VALUE",
|
|
142
|
+
* // transcriptionSeconds: Number("int"),
|
|
143
|
+
* // attachment: "STRING_VALUE",
|
|
144
|
+
* // attachmentType: "VOICEMAIL" || "FAX",
|
|
145
|
+
* // attachmentDestinations: [ // CallFlowAttachmentDestinationList
|
|
146
|
+
* // { // CallFlowAttachmentDestination
|
|
147
|
+
* // phone: "STRING_VALUE",
|
|
148
|
+
* // name: "STRING_VALUE",
|
|
149
|
+
* // email: "STRING_VALUE",
|
|
150
|
+
* // userId: "STRING_VALUE",
|
|
151
|
+
* // userExtension: "STRING_VALUE",
|
|
152
|
+
* // userDepartment: "STRING_VALUE",
|
|
153
|
+
* // groupId: "STRING_VALUE",
|
|
154
|
+
* // groupName: "STRING_VALUE",
|
|
155
|
+
* // },
|
|
156
|
+
* // ],
|
|
157
|
+
* // attachments: [ // CallFlowAttachments
|
|
158
|
+
* // { // CallFlowAttachment Union: only one key present
|
|
159
|
+
* // recording: {
|
|
160
|
+
* // fileName: "STRING_VALUE", // required
|
|
161
|
+
* // start: Number("long"), // required
|
|
162
|
+
* // end: Number("long"), // required
|
|
163
|
+
* // owner: "callee" || "caller" || "system", // required
|
|
164
|
+
* // url: "STRING_VALUE", // required
|
|
165
|
+
* // pauses: [ // required
|
|
166
|
+
* // {
|
|
167
|
+
* // start: Number("long"),
|
|
168
|
+
* // end: Number("long"),
|
|
169
|
+
* // reason: "pause" || "hold",
|
|
170
|
+
* // },
|
|
171
|
+
* // ],
|
|
172
|
+
* // },
|
|
173
|
+
* // fax: { // CallFlowFax
|
|
174
|
+
* // url: "STRING_VALUE", // required
|
|
175
|
+
* // status: "ok" || "error",
|
|
176
|
+
* // destinations: [
|
|
177
|
+
* // {
|
|
178
|
+
* // phone: "STRING_VALUE",
|
|
179
|
+
* // name: "STRING_VALUE",
|
|
180
|
+
* // email: "STRING_VALUE",
|
|
181
|
+
* // userId: "STRING_VALUE",
|
|
182
|
+
* // userExtension: "STRING_VALUE",
|
|
183
|
+
* // userDepartment: "STRING_VALUE",
|
|
184
|
+
* // groupId: "STRING_VALUE",
|
|
185
|
+
* // groupName: "STRING_VALUE",
|
|
186
|
+
* // },
|
|
187
|
+
* // ],
|
|
188
|
+
* // owner: "callee" || "caller" || "system",
|
|
189
|
+
* // error: "STRING_VALUE",
|
|
190
|
+
* // },
|
|
191
|
+
* // voicemail: { // CallFlowVoicemail
|
|
192
|
+
* // url: "STRING_VALUE", // required
|
|
193
|
+
* // destinations: [
|
|
194
|
+
* // {
|
|
195
|
+
* // phone: "STRING_VALUE",
|
|
196
|
+
* // name: "STRING_VALUE",
|
|
197
|
+
* // email: "STRING_VALUE",
|
|
198
|
+
* // userId: "STRING_VALUE",
|
|
199
|
+
* // userExtension: "STRING_VALUE",
|
|
200
|
+
* // userDepartment: "STRING_VALUE",
|
|
201
|
+
* // groupId: "STRING_VALUE",
|
|
202
|
+
* // groupName: "STRING_VALUE",
|
|
203
|
+
* // },
|
|
204
|
+
* // ],
|
|
205
|
+
* // owner: "callee" || "caller" || "system",
|
|
206
|
+
* // },
|
|
207
|
+
* // },
|
|
208
|
+
* // ],
|
|
209
|
+
* // notifications: { // CallFlowNotifications
|
|
210
|
+
* // destinations: "<CallFlowAttachmentDestinationList>",
|
|
211
|
+
* // type: [ // NotificationsType
|
|
212
|
+
* // "STRING_VALUE",
|
|
213
|
+
* // ],
|
|
214
|
+
* // },
|
|
215
|
+
* // status: "CONNECTING" || "TALKING" || "HOLD", // required
|
|
216
|
+
* // statusChangeDate: "STRING_VALUE", // required
|
|
217
|
+
* // },
|
|
218
|
+
* // ],
|
|
219
|
+
* // transcriptions: [ // CallAnalyticsLiveTranscriptionEventList
|
|
220
|
+
* // { // CallAnalyticsLiveTranscriptionEvent
|
|
221
|
+
* // id: "STRING_VALUE", // required
|
|
222
|
+
* // pbx: "STRING_VALUE", // required
|
|
223
|
+
* // time: Number("long"), // required
|
|
224
|
+
* // company: "STRING_VALUE", // required
|
|
225
|
+
* // licenses: [ // LicensesList // required
|
|
226
|
+
* // "x-bees" || "uc",
|
|
227
|
+
* // ],
|
|
228
|
+
* // event: "chat" || "chat_transcription" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave", // required
|
|
229
|
+
* // flowIndex: Number("int"), // required
|
|
230
|
+
* // flowStartTime: Number("long"), // required
|
|
231
|
+
* // callStartTime: Number("long"), // required
|
|
232
|
+
* // chunk: { // CallTranscriptionChunk
|
|
233
|
+
* // id: "STRING_VALUE", // required
|
|
234
|
+
* // time: Number("long"), // required
|
|
235
|
+
* // speaker: "callee" || "caller", // required
|
|
236
|
+
* // text: "STRING_VALUE", // required
|
|
237
|
+
* // language: "STRING_VALUE",
|
|
238
|
+
* // isFinal: true || false, // required
|
|
239
|
+
* // start: Number("long"), // required
|
|
240
|
+
* // end: Number("long"), // required
|
|
241
|
+
* // sentiment: "STRING_VALUE",
|
|
242
|
+
* // },
|
|
243
|
+
* // participant: {
|
|
244
|
+
* // type: "REMOTE" || "LOCAL", // required
|
|
245
|
+
* // phone: "STRING_VALUE",
|
|
246
|
+
* // name: "STRING_VALUE",
|
|
247
|
+
* // company: "STRING_VALUE",
|
|
248
|
+
* // email: "STRING_VALUE",
|
|
249
|
+
* // userId: "STRING_VALUE",
|
|
250
|
+
* // userExtension: "STRING_VALUE",
|
|
251
|
+
* // userDepartment: "STRING_VALUE",
|
|
252
|
+
* // groupId: "STRING_VALUE",
|
|
253
|
+
* // groupName: "STRING_VALUE",
|
|
254
|
+
* // userAgent: "STRING_VALUE",
|
|
255
|
+
* // userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "VOICEBOT" || "UNKNOWN",
|
|
256
|
+
* // role: "CLIENT" || "AGENT", // required
|
|
257
|
+
* // license: "STRING_VALUE",
|
|
258
|
+
* // sipCallId: "STRING_VALUE",
|
|
259
|
+
* // publicAddress: "STRING_VALUE",
|
|
260
|
+
* // privateAddress: "STRING_VALUE",
|
|
261
|
+
* // location: "STRING_VALUE",
|
|
262
|
+
* // },
|
|
263
|
+
* // },
|
|
264
|
+
* // ],
|
|
265
|
+
* // };
|
|
266
|
+
*
|
|
267
|
+
* ```
|
|
268
|
+
*
|
|
269
|
+
* @param GetOngoingCallTranscriptionCommandInput - {@link GetOngoingCallTranscriptionCommandInput}
|
|
270
|
+
* @returns {@link GetOngoingCallTranscriptionCommandOutput}
|
|
271
|
+
* @see {@link GetOngoingCallTranscriptionCommandInput} for command's `input` shape.
|
|
272
|
+
* @see {@link GetOngoingCallTranscriptionCommandOutput} for command's `response` shape.
|
|
273
|
+
* @see {@link WdaStreamClientResolvedConfig | config} for WdaStreamClient's `config` shape.
|
|
274
|
+
*
|
|
275
|
+
* @throws {@link ValidationException} (client fault)
|
|
276
|
+
*
|
|
277
|
+
* @throws {@link MatchNotFoundException} (client fault)
|
|
278
|
+
*
|
|
279
|
+
* @throws {@link WdaStreamServiceException}
|
|
280
|
+
* <p>Base exception class for all service exceptions from WdaStream service.</p>
|
|
281
|
+
*
|
|
282
|
+
*
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
export declare class GetOngoingCallTranscriptionCommand extends GetOngoingCallTranscriptionCommand_base {
|
|
286
|
+
/** @internal type navigation helper, not in runtime. */
|
|
287
|
+
protected static __types: {
|
|
288
|
+
api: {
|
|
289
|
+
input: GetOngoingCallTranscriptionInput;
|
|
290
|
+
output: GetOngoingCallTranscriptionOutput;
|
|
291
|
+
};
|
|
292
|
+
sdk: {
|
|
293
|
+
input: GetOngoingCallTranscriptionCommandInput;
|
|
294
|
+
output: GetOngoingCallTranscriptionCommandOutput;
|
|
295
|
+
};
|
|
296
|
+
};
|
|
297
|
+
}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, WdaStreamClientResolvedConfig } from "../WdaStreamClient";
|
|
2
|
+
import { GetOngoingConferenceInput, GetOngoingConferenceOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetOngoingConferenceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetOngoingConferenceCommandInput extends GetOngoingConferenceInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetOngoingConferenceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetOngoingConferenceCommandOutput extends GetOngoingConferenceOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetOngoingConferenceCommand_base: {
|
|
25
|
+
new (input: GetOngoingConferenceCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingConferenceCommandInput, GetOngoingConferenceCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetOngoingConferenceCommandInput): import("@smithy/smithy-client").CommandImpl<GetOngoingConferenceCommandInput, GetOngoingConferenceCommandOutput, WdaStreamClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves information for ongoing conference.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { WdaStreamClient, GetOngoingConferenceCommand } from "@wildix/wda-stream-client"; // ES Modules import
|
|
35
|
+
* // const { WdaStreamClient, GetOngoingConferenceCommand } = require("@wildix/wda-stream-client"); // CommonJS import
|
|
36
|
+
* const client = new WdaStreamClient(config);
|
|
37
|
+
* const input = { // GetOngoingConferenceInput
|
|
38
|
+
* company: "STRING_VALUE",
|
|
39
|
+
* conferenceId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetOngoingConferenceCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetOngoingConferenceOutput
|
|
44
|
+
* // conference: { // ConferenceAnalyticsLiveProgressEvent
|
|
45
|
+
* // id: "STRING_VALUE", // required
|
|
46
|
+
* // time: Number("long"), // required
|
|
47
|
+
* // company: "STRING_VALUE", // required
|
|
48
|
+
* // event: "chat" || "chat_transcription" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave", // required
|
|
49
|
+
* // start: "STRING_VALUE", // required
|
|
50
|
+
* // subject: "STRING_VALUE", // required
|
|
51
|
+
* // participants: [ // ConferenceParticipantsList // required
|
|
52
|
+
* // { // ConferenceParticipant
|
|
53
|
+
* // type: "EXTERNAL" || "EXTERNAL_DIAL_IN" || "PBX" || "PBX_SIP" || "XBS", // required
|
|
54
|
+
* // role: "CLIENT" || "AGENT",
|
|
55
|
+
* // jid: "STRING_VALUE",
|
|
56
|
+
* // name: "STRING_VALUE",
|
|
57
|
+
* // email: "STRING_VALUE",
|
|
58
|
+
* // phone: "STRING_VALUE",
|
|
59
|
+
* // department: "STRING_VALUE",
|
|
60
|
+
* // company: "STRING_VALUE",
|
|
61
|
+
* // pbxSerial: "STRING_VALUE",
|
|
62
|
+
* // pbxExtension: "STRING_VALUE",
|
|
63
|
+
* // pbxGroupId: "STRING_VALUE",
|
|
64
|
+
* // xbsId: "STRING_VALUE",
|
|
65
|
+
* // license: "basic" || "essential" || "business" || "premium" || "wizyconf",
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // transcriptionStatus: "AVAILABLE" || "POST_TRANSCRIPTION" || "UNAVAILABLE",
|
|
69
|
+
* // transcriptionLanguage: "STRING_VALUE",
|
|
70
|
+
* // participantsGroupIds: [ // ConversationParticipantsGroupList
|
|
71
|
+
* // "STRING_VALUE",
|
|
72
|
+
* // ],
|
|
73
|
+
* // },
|
|
74
|
+
* // };
|
|
75
|
+
*
|
|
76
|
+
* ```
|
|
77
|
+
*
|
|
78
|
+
* @param GetOngoingConferenceCommandInput - {@link GetOngoingConferenceCommandInput}
|
|
79
|
+
* @returns {@link GetOngoingConferenceCommandOutput}
|
|
80
|
+
* @see {@link GetOngoingConferenceCommandInput} for command's `input` shape.
|
|
81
|
+
* @see {@link GetOngoingConferenceCommandOutput} for command's `response` shape.
|
|
82
|
+
* @see {@link WdaStreamClientResolvedConfig | config} for WdaStreamClient's `config` shape.
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ValidationException} (client fault)
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link MatchNotFoundException} (client fault)
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link WdaStreamServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from WdaStream service.</p>
|
|
90
|
+
*
|
|
91
|
+
*
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
export declare class GetOngoingConferenceCommand extends GetOngoingConferenceCommand_base {
|
|
95
|
+
/** @internal type navigation helper, not in runtime. */
|
|
96
|
+
protected static __types: {
|
|
97
|
+
api: {
|
|
98
|
+
input: GetOngoingConferenceInput;
|
|
99
|
+
output: GetOngoingConferenceOutput;
|
|
100
|
+
};
|
|
101
|
+
sdk: {
|
|
102
|
+
input: GetOngoingConferenceCommandInput;
|
|
103
|
+
output: GetOngoingConferenceCommandOutput;
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
}
|