@wildix/wim-voicebots-client 1.0.8 → 1.0.10
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/VoiceBots.js +4 -0
- package/dist-cjs/commands/GetTraceCommand.js +21 -0
- package/dist-cjs/commands/ListTracesCommand.js +21 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +144 -1
- package/dist-cjs/protocols/Aws_restJson1.js +246 -5
- package/dist-es/VoiceBots.js +4 -0
- package/dist-es/commands/GetTraceCommand.js +17 -0
- package/dist-es/commands/ListTracesCommand.js +17 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +143 -0
- package/dist-es/protocols/Aws_restJson1.js +241 -4
- package/dist-types/VoiceBots.d.ts +15 -0
- package/dist-types/VoiceBotsClient.d.ts +4 -2
- package/dist-types/commands/CreateVoiceBotCommand.d.ts +32 -6
- package/dist-types/commands/DescribeEventCommand.d.ts +179 -2
- package/dist-types/commands/GetTraceCommand.d.ts +225 -0
- package/dist-types/commands/GetVoiceBotCommand.d.ts +16 -3
- package/dist-types/commands/ListTracesCommand.d.ts +80 -0
- package/dist-types/commands/ListVoiceBotsCommand.d.ts +16 -3
- package/dist-types/commands/SendHangupCommand.d.ts +2 -2
- package/dist-types/commands/SendSayCommand.d.ts +2 -2
- package/dist-types/commands/SendTransferCommand.d.ts +2 -2
- package/dist-types/commands/UpdateVoiceBotCommand.d.ts +32 -6
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +831 -42
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/package.json +1 -1
|
@@ -27,8 +27,7 @@ declare const DescribeEventCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* Utility method to describe available events for websocket and webhook events.
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -191,6 +190,183 @@ declare const DescribeEventCommand_base: {
|
|
|
191
190
|
* // callId: "STRING_VALUE", // required
|
|
192
191
|
* // flowIndex: Number("int"), // required
|
|
193
192
|
* // },
|
|
193
|
+
* // PubSubBroadcastWebsocketEvent: { // PubSubBroadcastWebsocketEvent
|
|
194
|
+
* // event: "STRING_VALUE", // required
|
|
195
|
+
* // topic: "STRING_VALUE", // required
|
|
196
|
+
* // items: [ // PubSubBroadcastItems // required
|
|
197
|
+
* // { // PubSubBroadcastItem Union: only one key present
|
|
198
|
+
* // session: { // TraceSession
|
|
199
|
+
* // sessionId: "STRING_VALUE", // required
|
|
200
|
+
* // connectionId: "STRING_VALUE", // required
|
|
201
|
+
* // company: "STRING_VALUE", // required
|
|
202
|
+
* // botId: "STRING_VALUE", // required
|
|
203
|
+
* // botName: "STRING_VALUE", // required
|
|
204
|
+
* // callId: "STRING_VALUE", // required
|
|
205
|
+
* // flowIndex: Number("int"), // required
|
|
206
|
+
* // language: "STRING_VALUE",
|
|
207
|
+
* // callerName: "STRING_VALUE",
|
|
208
|
+
* // callerNumber: "STRING_VALUE",
|
|
209
|
+
* // status: "complete" || "complete_with_error" || "pending", // required
|
|
210
|
+
* // start: Number("int"), // required
|
|
211
|
+
* // duration: Number("int"),
|
|
212
|
+
* // },
|
|
213
|
+
* // activity: { // TraceActivity
|
|
214
|
+
* // id: "STRING_VALUE", // required
|
|
215
|
+
* // version: Number("int"), // required
|
|
216
|
+
* // status: "pending" || "error" || "complete" || "cancelled", // required
|
|
217
|
+
* // trigger: { // TraceActivityTrigger Union: only one key present
|
|
218
|
+
* // connectEvent: { // TraceConnectEventTrigger
|
|
219
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
220
|
+
* // },
|
|
221
|
+
* // disconnectEvent: { // TraceDisconnectEventTrigger
|
|
222
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
223
|
+
* // },
|
|
224
|
+
* // replyEvent: {
|
|
225
|
+
* // type: "STRING_VALUE", // required
|
|
226
|
+
* // event: {
|
|
227
|
+
* // type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
|
|
228
|
+
* // id: "STRING_VALUE", // required
|
|
229
|
+
* // text: "STRING_VALUE", // required
|
|
230
|
+
* // startTime: Number("long"), // required
|
|
231
|
+
* // endTime: Number("long"), // required
|
|
232
|
+
* // },
|
|
233
|
+
* // },
|
|
234
|
+
* // completeEvent: {
|
|
235
|
+
* // type: "STRING_VALUE", // required
|
|
236
|
+
* // event: {
|
|
237
|
+
* // type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
|
|
238
|
+
* // reason: "STRING_VALUE", // required
|
|
239
|
+
* // time: Number("long"), // required
|
|
240
|
+
* // },
|
|
241
|
+
* // },
|
|
242
|
+
* // interruptionEvent: {
|
|
243
|
+
* // type: "STRING_VALUE", // required
|
|
244
|
+
* // event: {
|
|
245
|
+
* // type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
|
|
246
|
+
* // replyId: "STRING_VALUE", // required
|
|
247
|
+
* // playedText: "STRING_VALUE", // required
|
|
248
|
+
* // originalText: "STRING_VALUE", // required
|
|
249
|
+
* // time: Number("long"), // required
|
|
250
|
+
* // },
|
|
251
|
+
* // },
|
|
252
|
+
* // playbackEvent: {
|
|
253
|
+
* // type: "STRING_VALUE", // required
|
|
254
|
+
* // event: {
|
|
255
|
+
* // type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
|
|
256
|
+
* // replyId: "STRING_VALUE", // required
|
|
257
|
+
* // text: "STRING_VALUE", // required
|
|
258
|
+
* // complete: true || false, // required
|
|
259
|
+
* // startTime: Number("long"), // required
|
|
260
|
+
* // endTime: Number("long"),
|
|
261
|
+
* // },
|
|
262
|
+
* // },
|
|
263
|
+
* // transcriptionEvent: {
|
|
264
|
+
* // type: "STRING_VALUE", // required
|
|
265
|
+
* // event: {
|
|
266
|
+
* // type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
|
|
267
|
+
* // id: "STRING_VALUE", // required
|
|
268
|
+
* // text: "STRING_VALUE", // required
|
|
269
|
+
* // time: Number("long"), // required
|
|
270
|
+
* // },
|
|
271
|
+
* // },
|
|
272
|
+
* // sayCommand: {
|
|
273
|
+
* // type: "STRING_VALUE", // required
|
|
274
|
+
* // command: {
|
|
275
|
+
* // text: "STRING_VALUE", // required
|
|
276
|
+
* // replyId: "STRING_VALUE", // required
|
|
277
|
+
* // interruptible: true || false,
|
|
278
|
+
* // type: "say" || "hangup" || "transfer", // required
|
|
279
|
+
* // },
|
|
280
|
+
* // },
|
|
281
|
+
* // hangupCommand: {
|
|
282
|
+
* // type: "STRING_VALUE", // required
|
|
283
|
+
* // command: {
|
|
284
|
+
* // reason: "STRING_VALUE",
|
|
285
|
+
* // type: "say" || "hangup" || "transfer", // required
|
|
286
|
+
* // },
|
|
287
|
+
* // },
|
|
288
|
+
* // transferCommand: {
|
|
289
|
+
* // type: "STRING_VALUE", // required
|
|
290
|
+
* // command: {
|
|
291
|
+
* // context: "STRING_VALUE", // required
|
|
292
|
+
* // extension: "STRING_VALUE", // required
|
|
293
|
+
* // type: "say" || "hangup" || "transfer", // required
|
|
294
|
+
* // },
|
|
295
|
+
* // },
|
|
296
|
+
* // silenceTimeoutTask: { // TraceSilenceTimeoutTaskTrigger
|
|
297
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
298
|
+
* // },
|
|
299
|
+
* // durationTimeoutTask: { // TraceDurationTimeoutTaskTrigger
|
|
300
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
301
|
+
* // },
|
|
302
|
+
* // },
|
|
303
|
+
* // result: { // TraceActivityResult Union: only one key present
|
|
304
|
+
* // error: { // TraceErrorResult
|
|
305
|
+
* // internal: true || false, // required
|
|
306
|
+
* // message: "STRING_VALUE", // required
|
|
307
|
+
* // },
|
|
308
|
+
* // text: "STRING_VALUE",
|
|
309
|
+
* // },
|
|
310
|
+
* // start: Number("int"), // required
|
|
311
|
+
* // duration: Number("int"),
|
|
312
|
+
* // },
|
|
313
|
+
* // segment: { // TraceSegment
|
|
314
|
+
* // id: "STRING_VALUE", // required
|
|
315
|
+
* // activityId: "STRING_VALUE", // required
|
|
316
|
+
* // version: Number("int"), // required
|
|
317
|
+
* // status: "pending" || "error" || "complete", // required
|
|
318
|
+
* // input: { // TraceSegmentInput Union: only one key present
|
|
319
|
+
* // completion: { // TraceSegmentCompletionInput
|
|
320
|
+
* // messages: { // TraceSegmentCompletionMessageItem Union: only one key present
|
|
321
|
+
* // user: "STRING_VALUE",
|
|
322
|
+
* // bot: "STRING_VALUE",
|
|
323
|
+
* // },
|
|
324
|
+
* // },
|
|
325
|
+
* // tool: { // TraceToolCall Union: only one key present
|
|
326
|
+
* // transfer: "STRING_VALUE",
|
|
327
|
+
* // hangup: "STRING_VALUE",
|
|
328
|
+
* // delegation: "STRING_VALUE",
|
|
329
|
+
* // function: "STRING_VALUE",
|
|
330
|
+
* // },
|
|
331
|
+
* // },
|
|
332
|
+
* // result: { // TraceSegmentResult Union: only one key present
|
|
333
|
+
* // error: {
|
|
334
|
+
* // internal: true || false, // required
|
|
335
|
+
* // message: "STRING_VALUE", // required
|
|
336
|
+
* // },
|
|
337
|
+
* // tools: [ // TraceToolsResult
|
|
338
|
+
* // { // TraceToolResult Union: only one key present
|
|
339
|
+
* // transfer: "STRING_VALUE",
|
|
340
|
+
* // hangup: "STRING_VALUE",
|
|
341
|
+
* // delegation: "STRING_VALUE",
|
|
342
|
+
* // function: "STRING_VALUE",
|
|
343
|
+
* // },
|
|
344
|
+
* // ],
|
|
345
|
+
* // text: "STRING_VALUE",
|
|
346
|
+
* // json: "DOCUMENT_VALUE",
|
|
347
|
+
* // },
|
|
348
|
+
* // start: Number("int"), // required
|
|
349
|
+
* // duration: Number("int"),
|
|
350
|
+
* // },
|
|
351
|
+
* // },
|
|
352
|
+
* // ],
|
|
353
|
+
* // },
|
|
354
|
+
* // PubSubSubscribeWebsocketCommand: { // PubSubSubscribeWebsocketCommand
|
|
355
|
+
* // action: "STRING_VALUE", // required
|
|
356
|
+
* // topic: "STRING_VALUE", // required
|
|
357
|
+
* // },
|
|
358
|
+
* // PubSubSubscribedWebsocketEvent: { // PubSubSubscribedWebsocketEvent
|
|
359
|
+
* // event: "STRING_VALUE", // required
|
|
360
|
+
* // topic: "STRING_VALUE", // required
|
|
361
|
+
* // },
|
|
362
|
+
* // PubSubUnsubscribeWebsocketCommand: { // PubSubUnsubscribeWebsocketCommand
|
|
363
|
+
* // action: "STRING_VALUE", // required
|
|
364
|
+
* // topic: "STRING_VALUE", // required
|
|
365
|
+
* // },
|
|
366
|
+
* // PubSubUnsubscribedWebsocketEvent: { // PubSubUnsubscribedWebsocketEvent
|
|
367
|
+
* // event: "STRING_VALUE", // required
|
|
368
|
+
* // topic: "STRING_VALUE", // required
|
|
369
|
+
* // },
|
|
194
370
|
* // };
|
|
195
371
|
*
|
|
196
372
|
* ```
|
|
@@ -208,6 +384,7 @@ declare const DescribeEventCommand_base: {
|
|
|
208
384
|
* @throws {@link VoiceBotsServiceException}
|
|
209
385
|
* <p>Base exception class for all service exceptions from VoiceBots service.</p>
|
|
210
386
|
*
|
|
387
|
+
* @public
|
|
211
388
|
*/
|
|
212
389
|
export declare class DescribeEventCommand extends DescribeEventCommand_base {
|
|
213
390
|
}
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, VoiceBotsClientResolvedConfig } from "../VoiceBotsClient";
|
|
2
|
+
import { GetTraceInput, GetTraceOutput } 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 GetTraceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetTraceCommandInput extends GetTraceInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetTraceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetTraceCommandOutput extends GetTraceOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetTraceCommand_base: {
|
|
25
|
+
new (input: GetTraceCommandInput): import("@smithy/smithy-client").CommandImpl<GetTraceCommandInput, GetTraceCommandOutput, VoiceBotsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetTraceCommandInput): import("@smithy/smithy-client").CommandImpl<GetTraceCommandInput, GetTraceCommandOutput, VoiceBotsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { VoiceBotsClient, GetTraceCommand } from "@wildix/wim-voicebots-client"; // ES Modules import
|
|
36
|
+
* // const { VoiceBotsClient, GetTraceCommand } = require("@wildix/wim-voicebots-client"); // CommonJS import
|
|
37
|
+
* const client = new VoiceBotsClient(config);
|
|
38
|
+
* const input = { // GetTraceInput
|
|
39
|
+
* company: "STRING_VALUE",
|
|
40
|
+
* sessionId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetTraceCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetTraceOutput
|
|
45
|
+
* // trace: { // Trace
|
|
46
|
+
* // session: { // TraceSession
|
|
47
|
+
* // sessionId: "STRING_VALUE", // required
|
|
48
|
+
* // connectionId: "STRING_VALUE", // required
|
|
49
|
+
* // company: "STRING_VALUE", // required
|
|
50
|
+
* // botId: "STRING_VALUE", // required
|
|
51
|
+
* // botName: "STRING_VALUE", // required
|
|
52
|
+
* // callId: "STRING_VALUE", // required
|
|
53
|
+
* // flowIndex: Number("int"), // required
|
|
54
|
+
* // language: "STRING_VALUE",
|
|
55
|
+
* // callerName: "STRING_VALUE",
|
|
56
|
+
* // callerNumber: "STRING_VALUE",
|
|
57
|
+
* // status: "complete" || "complete_with_error" || "pending", // required
|
|
58
|
+
* // start: Number("int"), // required
|
|
59
|
+
* // duration: Number("int"),
|
|
60
|
+
* // },
|
|
61
|
+
* // activities: [ // TraceActivitiesList // required
|
|
62
|
+
* // { // TraceActivity
|
|
63
|
+
* // id: "STRING_VALUE", // required
|
|
64
|
+
* // version: Number("int"), // required
|
|
65
|
+
* // status: "pending" || "error" || "complete" || "cancelled", // required
|
|
66
|
+
* // trigger: { // TraceActivityTrigger Union: only one key present
|
|
67
|
+
* // connectEvent: { // TraceConnectEventTrigger
|
|
68
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // disconnectEvent: { // TraceDisconnectEventTrigger
|
|
71
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // replyEvent: { // ReplyWebsocketEvent
|
|
74
|
+
* // type: "STRING_VALUE", // required
|
|
75
|
+
* // event: { // ReplyEvent
|
|
76
|
+
* // type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
|
|
77
|
+
* // id: "STRING_VALUE", // required
|
|
78
|
+
* // text: "STRING_VALUE", // required
|
|
79
|
+
* // startTime: Number("long"), // required
|
|
80
|
+
* // endTime: Number("long"), // required
|
|
81
|
+
* // },
|
|
82
|
+
* // },
|
|
83
|
+
* // completeEvent: { // CompleteWebsocketEvent
|
|
84
|
+
* // type: "STRING_VALUE", // required
|
|
85
|
+
* // event: { // CompleteEvent
|
|
86
|
+
* // type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
|
|
87
|
+
* // reason: "STRING_VALUE", // required
|
|
88
|
+
* // time: Number("long"), // required
|
|
89
|
+
* // },
|
|
90
|
+
* // },
|
|
91
|
+
* // interruptionEvent: { // InterruptionWebsocketEvent
|
|
92
|
+
* // type: "STRING_VALUE", // required
|
|
93
|
+
* // event: { // InterruptionEvent
|
|
94
|
+
* // type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
|
|
95
|
+
* // replyId: "STRING_VALUE", // required
|
|
96
|
+
* // playedText: "STRING_VALUE", // required
|
|
97
|
+
* // originalText: "STRING_VALUE", // required
|
|
98
|
+
* // time: Number("long"), // required
|
|
99
|
+
* // },
|
|
100
|
+
* // },
|
|
101
|
+
* // playbackEvent: { // PlaybackWebsocketEvent
|
|
102
|
+
* // type: "STRING_VALUE", // required
|
|
103
|
+
* // event: { // PlaybackEvent
|
|
104
|
+
* // type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
|
|
105
|
+
* // replyId: "STRING_VALUE", // required
|
|
106
|
+
* // text: "STRING_VALUE", // required
|
|
107
|
+
* // complete: true || false, // required
|
|
108
|
+
* // startTime: Number("long"), // required
|
|
109
|
+
* // endTime: Number("long"),
|
|
110
|
+
* // },
|
|
111
|
+
* // },
|
|
112
|
+
* // transcriptionEvent: { // TranscriptionWebsocketEvent
|
|
113
|
+
* // type: "STRING_VALUE", // required
|
|
114
|
+
* // event: { // TranscriptionEvent
|
|
115
|
+
* // type: "started" || "ended" || "reply" || "playback" || "transcription" || "interruption" || "complete", // required
|
|
116
|
+
* // id: "STRING_VALUE", // required
|
|
117
|
+
* // text: "STRING_VALUE", // required
|
|
118
|
+
* // time: Number("long"), // required
|
|
119
|
+
* // },
|
|
120
|
+
* // },
|
|
121
|
+
* // sayCommand: { // SayWebsocketCommand
|
|
122
|
+
* // type: "STRING_VALUE", // required
|
|
123
|
+
* // command: { // SayWebsocketCommandData
|
|
124
|
+
* // text: "STRING_VALUE", // required
|
|
125
|
+
* // replyId: "STRING_VALUE", // required
|
|
126
|
+
* // interruptible: true || false,
|
|
127
|
+
* // type: "say" || "hangup" || "transfer", // required
|
|
128
|
+
* // },
|
|
129
|
+
* // },
|
|
130
|
+
* // hangupCommand: { // HangupWebsocketCommand
|
|
131
|
+
* // type: "STRING_VALUE", // required
|
|
132
|
+
* // command: { // HangupWebsocketCommandData
|
|
133
|
+
* // reason: "STRING_VALUE",
|
|
134
|
+
* // type: "say" || "hangup" || "transfer", // required
|
|
135
|
+
* // },
|
|
136
|
+
* // },
|
|
137
|
+
* // transferCommand: { // TransferWebsocketCommand
|
|
138
|
+
* // type: "STRING_VALUE", // required
|
|
139
|
+
* // command: { // TransferWebsocketCommandData
|
|
140
|
+
* // context: "STRING_VALUE", // required
|
|
141
|
+
* // extension: "STRING_VALUE", // required
|
|
142
|
+
* // type: "say" || "hangup" || "transfer", // required
|
|
143
|
+
* // },
|
|
144
|
+
* // },
|
|
145
|
+
* // silenceTimeoutTask: { // TraceSilenceTimeoutTaskTrigger
|
|
146
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
147
|
+
* // },
|
|
148
|
+
* // durationTimeoutTask: { // TraceDurationTimeoutTaskTrigger
|
|
149
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
150
|
+
* // },
|
|
151
|
+
* // },
|
|
152
|
+
* // result: { // TraceActivityResult Union: only one key present
|
|
153
|
+
* // error: { // TraceErrorResult
|
|
154
|
+
* // internal: true || false, // required
|
|
155
|
+
* // message: "STRING_VALUE", // required
|
|
156
|
+
* // },
|
|
157
|
+
* // text: "STRING_VALUE",
|
|
158
|
+
* // },
|
|
159
|
+
* // start: Number("int"), // required
|
|
160
|
+
* // duration: Number("int"),
|
|
161
|
+
* // },
|
|
162
|
+
* // ],
|
|
163
|
+
* // segments: [ // TraceSegmentsList // required
|
|
164
|
+
* // { // TraceSegment
|
|
165
|
+
* // id: "STRING_VALUE", // required
|
|
166
|
+
* // activityId: "STRING_VALUE", // required
|
|
167
|
+
* // version: Number("int"), // required
|
|
168
|
+
* // status: "pending" || "error" || "complete", // required
|
|
169
|
+
* // input: { // TraceSegmentInput Union: only one key present
|
|
170
|
+
* // completion: { // TraceSegmentCompletionInput
|
|
171
|
+
* // messages: { // TraceSegmentCompletionMessageItem Union: only one key present
|
|
172
|
+
* // user: "STRING_VALUE",
|
|
173
|
+
* // bot: "STRING_VALUE",
|
|
174
|
+
* // },
|
|
175
|
+
* // },
|
|
176
|
+
* // tool: { // TraceToolCall Union: only one key present
|
|
177
|
+
* // transfer: "STRING_VALUE",
|
|
178
|
+
* // hangup: "STRING_VALUE",
|
|
179
|
+
* // delegation: "STRING_VALUE",
|
|
180
|
+
* // function: "STRING_VALUE",
|
|
181
|
+
* // },
|
|
182
|
+
* // },
|
|
183
|
+
* // result: { // TraceSegmentResult Union: only one key present
|
|
184
|
+
* // error: {
|
|
185
|
+
* // internal: true || false, // required
|
|
186
|
+
* // message: "STRING_VALUE", // required
|
|
187
|
+
* // },
|
|
188
|
+
* // tools: [ // TraceToolsResult
|
|
189
|
+
* // { // TraceToolResult Union: only one key present
|
|
190
|
+
* // transfer: "STRING_VALUE",
|
|
191
|
+
* // hangup: "STRING_VALUE",
|
|
192
|
+
* // delegation: "STRING_VALUE",
|
|
193
|
+
* // function: "STRING_VALUE",
|
|
194
|
+
* // },
|
|
195
|
+
* // ],
|
|
196
|
+
* // text: "STRING_VALUE",
|
|
197
|
+
* // json: "DOCUMENT_VALUE",
|
|
198
|
+
* // },
|
|
199
|
+
* // start: Number("int"), // required
|
|
200
|
+
* // duration: Number("int"),
|
|
201
|
+
* // },
|
|
202
|
+
* // ],
|
|
203
|
+
* // },
|
|
204
|
+
* // };
|
|
205
|
+
*
|
|
206
|
+
* ```
|
|
207
|
+
*
|
|
208
|
+
* @param GetTraceCommandInput - {@link GetTraceCommandInput}
|
|
209
|
+
* @returns {@link GetTraceCommandOutput}
|
|
210
|
+
* @see {@link GetTraceCommandInput} for command's `input` shape.
|
|
211
|
+
* @see {@link GetTraceCommandOutput} for command's `response` shape.
|
|
212
|
+
* @see {@link VoiceBotsClientResolvedConfig | config} for VoiceBotsClient's `config` shape.
|
|
213
|
+
*
|
|
214
|
+
* @throws {@link VoiceBotNotFoundException} (client fault)
|
|
215
|
+
*
|
|
216
|
+
* @throws {@link ValidationException} (client fault)
|
|
217
|
+
*
|
|
218
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
219
|
+
*
|
|
220
|
+
* @throws {@link VoiceBotsServiceException}
|
|
221
|
+
* <p>Base exception class for all service exceptions from VoiceBots service.</p>
|
|
222
|
+
*
|
|
223
|
+
*/
|
|
224
|
+
export declare class GetTraceCommand extends GetTraceCommand_base {
|
|
225
|
+
}
|
|
@@ -57,7 +57,7 @@ declare const GetVoiceBotCommand_base: {
|
|
|
57
57
|
* // prompt: "STRING_VALUE", // required
|
|
58
58
|
* // embeddedTools: [ // VoiceBotEmbeddedToolsList
|
|
59
59
|
* // { // VoiceBotEmbeddedTool
|
|
60
|
-
* // type: "HANGUP" || "TRANSFER", // required
|
|
60
|
+
* // type: "HANGUP" || "TRANSFER" || "DELEGATE", // required
|
|
61
61
|
* // name: "STRING_VALUE", // required
|
|
62
62
|
* // parameters: "DOCUMENT_VALUE",
|
|
63
63
|
* // },
|
|
@@ -73,8 +73,21 @@ declare const GetVoiceBotCommand_base: {
|
|
|
73
73
|
* // webhook: { // VoiceBotFunctionIntegrationWebhook
|
|
74
74
|
* // url: "STRING_VALUE", // required
|
|
75
75
|
* // async: true || false,
|
|
76
|
-
* //
|
|
77
|
-
* //
|
|
76
|
+
* // authorization: { // VoiceBotFunctionIntegrationWebhookAuthorization Union: only one key present
|
|
77
|
+
* // bearer: { // VoiceBotFunctionIntegrationWebhookAuthorizationBearer
|
|
78
|
+
* // token: "STRING_VALUE", // required
|
|
79
|
+
* // },
|
|
80
|
+
* // basic: { // VoiceBotFunctionIntegrationWebhookAuthorizationBasic
|
|
81
|
+
* // username: "STRING_VALUE", // required
|
|
82
|
+
* // password: "STRING_VALUE", // required
|
|
83
|
+
* // },
|
|
84
|
+
* // oauth: { // VoiceBotFunctionIntegrationWebhookAuthorizationOAuth
|
|
85
|
+
* // clientId: "STRING_VALUE", // required
|
|
86
|
+
* // clientSecret: "STRING_VALUE", // required
|
|
87
|
+
* // endpointUrl: "STRING_VALUE", // required
|
|
88
|
+
* // scope: "STRING_VALUE",
|
|
89
|
+
* // },
|
|
90
|
+
* // },
|
|
78
91
|
* // headers: [ // VoiceBotFunctionIntegrationWebhookHeadersList
|
|
79
92
|
* // { // VoiceBotFunctionIntegrationWebhookHeader
|
|
80
93
|
* // key: "STRING_VALUE", // required
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, VoiceBotsClientResolvedConfig } from "../VoiceBotsClient";
|
|
2
|
+
import { ListTracesInput, ListTracesOutput } 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 ListTracesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListTracesCommandInput extends ListTracesInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListTracesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListTracesCommandOutput extends ListTracesOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListTracesCommand_base: {
|
|
25
|
+
new (input: ListTracesCommandInput): import("@smithy/smithy-client").CommandImpl<ListTracesCommandInput, ListTracesCommandOutput, VoiceBotsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListTracesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListTracesCommandInput, ListTracesCommandOutput, VoiceBotsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { VoiceBotsClient, ListTracesCommand } from "@wildix/wim-voicebots-client"; // ES Modules import
|
|
36
|
+
* // const { VoiceBotsClient, ListTracesCommand } = require("@wildix/wim-voicebots-client"); // CommonJS import
|
|
37
|
+
* const client = new VoiceBotsClient(config);
|
|
38
|
+
* const input = { // ListTracesInput
|
|
39
|
+
* company: "STRING_VALUE",
|
|
40
|
+
* };
|
|
41
|
+
* const command = new ListTracesCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // ListTracesOutput
|
|
44
|
+
* // traces: [ // TraceSessionsList // required
|
|
45
|
+
* // { // TraceSession
|
|
46
|
+
* // sessionId: "STRING_VALUE", // required
|
|
47
|
+
* // connectionId: "STRING_VALUE", // required
|
|
48
|
+
* // company: "STRING_VALUE", // required
|
|
49
|
+
* // botId: "STRING_VALUE", // required
|
|
50
|
+
* // botName: "STRING_VALUE", // required
|
|
51
|
+
* // callId: "STRING_VALUE", // required
|
|
52
|
+
* // flowIndex: Number("int"), // required
|
|
53
|
+
* // language: "STRING_VALUE",
|
|
54
|
+
* // callerName: "STRING_VALUE",
|
|
55
|
+
* // callerNumber: "STRING_VALUE",
|
|
56
|
+
* // status: "complete" || "complete_with_error" || "pending", // required
|
|
57
|
+
* // start: Number("int"), // required
|
|
58
|
+
* // duration: Number("int"),
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @param ListTracesCommandInput - {@link ListTracesCommandInput}
|
|
66
|
+
* @returns {@link ListTracesCommandOutput}
|
|
67
|
+
* @see {@link ListTracesCommandInput} for command's `input` shape.
|
|
68
|
+
* @see {@link ListTracesCommandOutput} for command's `response` shape.
|
|
69
|
+
* @see {@link VoiceBotsClientResolvedConfig | config} for VoiceBotsClient's `config` shape.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ValidationException} (client fault)
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link VoiceBotsServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from VoiceBots service.</p>
|
|
77
|
+
*
|
|
78
|
+
*/
|
|
79
|
+
export declare class ListTracesCommand extends ListTracesCommand_base {
|
|
80
|
+
}
|
|
@@ -57,7 +57,7 @@ declare const ListVoiceBotsCommand_base: {
|
|
|
57
57
|
* // prompt: "STRING_VALUE", // required
|
|
58
58
|
* // embeddedTools: [ // VoiceBotEmbeddedToolsList
|
|
59
59
|
* // { // VoiceBotEmbeddedTool
|
|
60
|
-
* // type: "HANGUP" || "TRANSFER", // required
|
|
60
|
+
* // type: "HANGUP" || "TRANSFER" || "DELEGATE", // required
|
|
61
61
|
* // name: "STRING_VALUE", // required
|
|
62
62
|
* // parameters: "DOCUMENT_VALUE",
|
|
63
63
|
* // },
|
|
@@ -73,8 +73,21 @@ declare const ListVoiceBotsCommand_base: {
|
|
|
73
73
|
* // webhook: { // VoiceBotFunctionIntegrationWebhook
|
|
74
74
|
* // url: "STRING_VALUE", // required
|
|
75
75
|
* // async: true || false,
|
|
76
|
-
* //
|
|
77
|
-
* //
|
|
76
|
+
* // authorization: { // VoiceBotFunctionIntegrationWebhookAuthorization Union: only one key present
|
|
77
|
+
* // bearer: { // VoiceBotFunctionIntegrationWebhookAuthorizationBearer
|
|
78
|
+
* // token: "STRING_VALUE", // required
|
|
79
|
+
* // },
|
|
80
|
+
* // basic: { // VoiceBotFunctionIntegrationWebhookAuthorizationBasic
|
|
81
|
+
* // username: "STRING_VALUE", // required
|
|
82
|
+
* // password: "STRING_VALUE", // required
|
|
83
|
+
* // },
|
|
84
|
+
* // oauth: { // VoiceBotFunctionIntegrationWebhookAuthorizationOAuth
|
|
85
|
+
* // clientId: "STRING_VALUE", // required
|
|
86
|
+
* // clientSecret: "STRING_VALUE", // required
|
|
87
|
+
* // endpointUrl: "STRING_VALUE", // required
|
|
88
|
+
* // scope: "STRING_VALUE",
|
|
89
|
+
* // },
|
|
90
|
+
* // },
|
|
78
91
|
* // headers: [ // VoiceBotFunctionIntegrationWebhookHeadersList
|
|
79
92
|
* // { // VoiceBotFunctionIntegrationWebhookHeader
|
|
80
93
|
* // key: "STRING_VALUE", // required
|
|
@@ -27,8 +27,7 @@ declare const SendHangupCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* Terminates the voice session and the call.
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -60,6 +59,7 @@ declare const SendHangupCommand_base: {
|
|
|
60
59
|
* @throws {@link VoiceBotsServiceException}
|
|
61
60
|
* <p>Base exception class for all service exceptions from VoiceBots service.</p>
|
|
62
61
|
*
|
|
62
|
+
* @public
|
|
63
63
|
*/
|
|
64
64
|
export declare class SendHangupCommand extends SendHangupCommand_base {
|
|
65
65
|
}
|
|
@@ -27,8 +27,7 @@ declare const SendSayCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* Generates and plays the specified text through the audio stream of the voice session.
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -62,6 +61,7 @@ declare const SendSayCommand_base: {
|
|
|
62
61
|
* @throws {@link VoiceBotsServiceException}
|
|
63
62
|
* <p>Base exception class for all service exceptions from VoiceBots service.</p>
|
|
64
63
|
*
|
|
64
|
+
* @public
|
|
65
65
|
*/
|
|
66
66
|
export declare class SendSayCommand extends SendSayCommand_base {
|
|
67
67
|
}
|
|
@@ -27,8 +27,7 @@ declare const SendTransferCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* Transfers the call to the specified context and extension, and terminates the voice bot session.
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -61,6 +60,7 @@ declare const SendTransferCommand_base: {
|
|
|
61
60
|
* @throws {@link VoiceBotsServiceException}
|
|
62
61
|
* <p>Base exception class for all service exceptions from VoiceBots service.</p>
|
|
63
62
|
*
|
|
63
|
+
* @public
|
|
64
64
|
*/
|
|
65
65
|
export declare class SendTransferCommand extends SendTransferCommand_base {
|
|
66
66
|
}
|