@wildix/wilma-voice-client 0.0.52 → 0.0.53
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/enums.js +14 -14
- package/dist-cjs/schemas/schemas_0.js +73 -48
- package/dist-es/models/enums.js +13 -13
- package/dist-es/schemas/schemas_0.js +71 -46
- package/dist-types/commands/DescribeVoiceProtocolCommand.d.ts +254 -241
- package/dist-types/models/enums.d.ts +21 -21
- package/dist-types/models/models_0.d.ts +287 -216
- package/dist-types/schemas/schemas_0.d.ts +12 -6
- package/package.json +1 -1
|
@@ -27,7 +27,7 @@ declare const DescribeVoiceProtocolCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* Describes the
|
|
30
|
+
* Describes the messages of the voice protocols: the text socket `/v2/voice/ws`, the call socket `/v2/voice/calls/ws` and the call events stream `StreamCallEvents`. Utility method; the generated shapes are the source of truth for building a client or a server by hand.
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -40,138 +40,262 @@ declare const DescribeVoiceProtocolCommand_base: {
|
|
|
40
40
|
* const command = new DescribeVoiceProtocolCommand(input);
|
|
41
41
|
* const response = await client.send(command);
|
|
42
42
|
* // { // DescribeVoiceProtocolOutput
|
|
43
|
-
* //
|
|
44
|
-
* //
|
|
45
|
-
* //
|
|
46
|
-
* //
|
|
47
|
-
* //
|
|
48
|
-
* //
|
|
49
|
-
* //
|
|
50
|
-
* //
|
|
51
|
-
* //
|
|
52
|
-
* //
|
|
53
|
-
* //
|
|
54
|
-
* //
|
|
55
|
-
* //
|
|
56
|
-
* //
|
|
57
|
-
* //
|
|
58
|
-
* //
|
|
59
|
-
* //
|
|
60
|
-
* //
|
|
61
|
-
* //
|
|
62
|
-
* //
|
|
63
|
-
* //
|
|
64
|
-
* //
|
|
65
|
-
* // healthcheckWebsocketFrame: { // VoiceHealthcheckWebsocketFrame
|
|
66
|
-
* // type: "STRING_VALUE", // required
|
|
67
|
-
* // },
|
|
68
|
-
* // transcriptionEvent: { // VoiceTranscriptionEvent
|
|
69
|
-
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
70
|
-
* // id: "STRING_VALUE",
|
|
71
|
-
* // text: "STRING_VALUE", // required
|
|
72
|
-
* // confidence: Number("double"),
|
|
73
|
-
* // final: true || false,
|
|
74
|
-
* // language: "STRING_VALUE",
|
|
75
|
-
* // time: Number("long"),
|
|
76
|
-
* // },
|
|
77
|
-
* // agentTranscriptionEvent: { // VoiceAgentTranscriptionEvent
|
|
78
|
-
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
79
|
-
* // id: "STRING_VALUE",
|
|
80
|
-
* // text: "STRING_VALUE", // required
|
|
81
|
-
* // confidence: Number("double"),
|
|
82
|
-
* // final: true || false,
|
|
83
|
-
* // language: "STRING_VALUE",
|
|
84
|
-
* // time: Number("long"),
|
|
85
|
-
* // },
|
|
86
|
-
* // replyEvent: { // VoiceReplyEvent
|
|
87
|
-
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
88
|
-
* // id: "STRING_VALUE",
|
|
89
|
-
* // text: "STRING_VALUE", // required
|
|
90
|
-
* // time: Number("long"),
|
|
91
|
-
* // language: "STRING_VALUE",
|
|
92
|
-
* // confidence: Number("double"),
|
|
93
|
-
* // startTime: Number("long"),
|
|
94
|
-
* // endTime: Number("long"),
|
|
95
|
-
* // },
|
|
96
|
-
* // playbackEvent: { // VoicePlaybackEvent
|
|
97
|
-
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
98
|
-
* // replyId: "STRING_VALUE",
|
|
99
|
-
* // text: "STRING_VALUE",
|
|
100
|
-
* // complete: true || false, // required
|
|
101
|
-
* // startTime: Number("long"),
|
|
102
|
-
* // endTime: Number("long"),
|
|
103
|
-
* // },
|
|
104
|
-
* // interruptionEvent: { // VoiceInterruptionEvent
|
|
105
|
-
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
106
|
-
* // replyId: "STRING_VALUE",
|
|
107
|
-
* // playedText: "STRING_VALUE",
|
|
108
|
-
* // originalText: "STRING_VALUE",
|
|
109
|
-
* // time: Number("long"),
|
|
110
|
-
* // },
|
|
111
|
-
* // completeEvent: { // VoiceCompleteEvent
|
|
112
|
-
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
113
|
-
* // reason: "STRING_VALUE",
|
|
114
|
-
* // time: Number("long"),
|
|
115
|
-
* // },
|
|
116
|
-
* // sessionStartedEvent: { // VoiceSessionStartedEvent
|
|
117
|
-
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
118
|
-
* // time: Number("long"), // required
|
|
119
|
-
* // sessionId: "STRING_VALUE", // required
|
|
120
|
-
* // agentId: "STRING_VALUE", // required
|
|
121
|
-
* // agentVersion: Number("int"),
|
|
122
|
-
* // traceId: "STRING_VALUE",
|
|
123
|
-
* // agentName: "STRING_VALUE",
|
|
124
|
-
* // category: "STRING_VALUE",
|
|
125
|
-
* // groupId: "STRING_VALUE",
|
|
126
|
-
* // speech: { // VoiceSpeechPayload
|
|
127
|
-
* // engine: "STRING_VALUE", // required
|
|
128
|
-
* // languages: [ // LanguageCodeList // required
|
|
129
|
-
* // "STRING_VALUE",
|
|
130
|
-
* // ],
|
|
131
|
-
* // preferredLanguage: "STRING_VALUE", // required
|
|
132
|
-
* // autoDetect: true || false, // required
|
|
43
|
+
* // textSocket: { // VoiceTextProtocolFrames
|
|
44
|
+
* // connectParams: { // VoiceConnectParams
|
|
45
|
+
* // protocolVersion: Number("int"),
|
|
46
|
+
* // sessionId: "STRING_VALUE", // required
|
|
47
|
+
* // resume: true || false,
|
|
48
|
+
* // agentId: "STRING_VALUE", // required
|
|
49
|
+
* // agentVersion: Number("int"),
|
|
50
|
+
* // agentDraft: true || false,
|
|
51
|
+
* // callId: "STRING_VALUE",
|
|
52
|
+
* // flowIndex: Number("int"),
|
|
53
|
+
* // dialedNumber: "STRING_VALUE",
|
|
54
|
+
* // language: "STRING_VALUE",
|
|
55
|
+
* // callerName: "STRING_VALUE",
|
|
56
|
+
* // callerNumber: "STRING_VALUE",
|
|
57
|
+
* // callerEmail: "STRING_VALUE",
|
|
58
|
+
* // callerCompany: "STRING_VALUE",
|
|
59
|
+
* // voice: "STRING_VALUE",
|
|
60
|
+
* // initialMessage: "STRING_VALUE",
|
|
61
|
+
* // variables: "STRING_VALUE",
|
|
62
|
+
* // inputMode: "transcription",
|
|
63
|
+
* // user: "STRING_VALUE",
|
|
64
|
+
* // company: "STRING_VALUE",
|
|
133
65
|
* // },
|
|
134
|
-
* //
|
|
135
|
-
* //
|
|
136
|
-
* //
|
|
137
|
-
* //
|
|
138
|
-
* //
|
|
139
|
-
* //
|
|
140
|
-
* //
|
|
141
|
-
* //
|
|
142
|
-
* //
|
|
143
|
-
* //
|
|
144
|
-
* //
|
|
145
|
-
* //
|
|
146
|
-
* //
|
|
147
|
-
* //
|
|
148
|
-
* //
|
|
149
|
-
* //
|
|
150
|
-
* //
|
|
151
|
-
* //
|
|
152
|
-
* //
|
|
153
|
-
* //
|
|
154
|
-
* //
|
|
66
|
+
* // client: { // VoiceTextClientFrames
|
|
67
|
+
* // healthcheck: { // VoiceHealthcheckCommand
|
|
68
|
+
* // type: "STRING_VALUE", // required
|
|
69
|
+
* // },
|
|
70
|
+
* // transcription: { // VoiceTranscriptionEvent
|
|
71
|
+
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
72
|
+
* // id: "STRING_VALUE",
|
|
73
|
+
* // text: "STRING_VALUE", // required
|
|
74
|
+
* // confidence: Number("double"),
|
|
75
|
+
* // final: true || false,
|
|
76
|
+
* // language: "STRING_VALUE",
|
|
77
|
+
* // time: Number("long"),
|
|
78
|
+
* // },
|
|
79
|
+
* // agentTranscription: { // VoiceAgentTranscriptionEvent
|
|
80
|
+
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
81
|
+
* // id: "STRING_VALUE",
|
|
82
|
+
* // text: "STRING_VALUE", // required
|
|
83
|
+
* // confidence: Number("double"),
|
|
84
|
+
* // final: true || false,
|
|
85
|
+
* // language: "STRING_VALUE",
|
|
86
|
+
* // time: Number("long"),
|
|
87
|
+
* // },
|
|
88
|
+
* // reply: { // VoiceReplyEvent
|
|
89
|
+
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
90
|
+
* // id: "STRING_VALUE",
|
|
91
|
+
* // text: "STRING_VALUE", // required
|
|
92
|
+
* // time: Number("long"),
|
|
93
|
+
* // language: "STRING_VALUE",
|
|
94
|
+
* // confidence: Number("double"),
|
|
95
|
+
* // startTime: Number("long"),
|
|
96
|
+
* // endTime: Number("long"),
|
|
97
|
+
* // },
|
|
98
|
+
* // playback: { // VoicePlaybackEvent
|
|
99
|
+
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
100
|
+
* // replyId: "STRING_VALUE",
|
|
101
|
+
* // text: "STRING_VALUE",
|
|
102
|
+
* // complete: true || false, // required
|
|
103
|
+
* // startTime: Number("long"),
|
|
104
|
+
* // endTime: Number("long"),
|
|
105
|
+
* // },
|
|
106
|
+
* // interruption: { // VoiceInterruptionEvent
|
|
107
|
+
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
108
|
+
* // replyId: "STRING_VALUE",
|
|
109
|
+
* // playedText: "STRING_VALUE",
|
|
110
|
+
* // originalText: "STRING_VALUE",
|
|
111
|
+
* // time: Number("long"),
|
|
112
|
+
* // },
|
|
113
|
+
* // complete: { // VoiceCompleteEvent
|
|
114
|
+
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
115
|
+
* // reason: "STRING_VALUE",
|
|
116
|
+
* // time: Number("long"),
|
|
117
|
+
* // },
|
|
118
|
+
* // },
|
|
119
|
+
* // server: { // VoiceTextServerFrames
|
|
120
|
+
* // started: { // VoiceSessionStartedEvent
|
|
121
|
+
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
122
|
+
* // time: Number("long"), // required
|
|
123
|
+
* // sessionId: "STRING_VALUE", // required
|
|
124
|
+
* // agentId: "STRING_VALUE", // required
|
|
125
|
+
* // agentVersion: Number("int"),
|
|
126
|
+
* // traceId: "STRING_VALUE",
|
|
127
|
+
* // agentName: "STRING_VALUE",
|
|
128
|
+
* // category: "STRING_VALUE",
|
|
129
|
+
* // groupId: "STRING_VALUE",
|
|
130
|
+
* // speech: { // VoiceSpeechPayload
|
|
131
|
+
* // engine: "STRING_VALUE", // required
|
|
132
|
+
* // languages: [ // LanguageCodeList // required
|
|
133
|
+
* // "STRING_VALUE",
|
|
134
|
+
* // ],
|
|
135
|
+
* // preferredLanguage: "STRING_VALUE", // required
|
|
136
|
+
* // autoDetect: true || false, // required
|
|
137
|
+
* // },
|
|
138
|
+
* // backgroundSound: "STRING_VALUE",
|
|
139
|
+
* // },
|
|
140
|
+
* // ended: { // VoiceSessionEndedEvent
|
|
141
|
+
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
142
|
+
* // reason: "STRING_VALUE",
|
|
143
|
+
* // error: "STRING_VALUE",
|
|
144
|
+
* // time: Number("long"), // required
|
|
145
|
+
* // },
|
|
146
|
+
* // error: { // VoiceErrorEvent
|
|
147
|
+
* // type: "started" || "ended" || "error" || "transcription" || "agentTranscription" || "reply" || "playback" || "interruption" || "complete" || "thinking" || "tool", // required
|
|
148
|
+
* // code: "STRING_VALUE", // required
|
|
149
|
+
* // message: "STRING_VALUE", // required
|
|
150
|
+
* // time: Number("long"), // required
|
|
151
|
+
* // },
|
|
152
|
+
* // say: { // VoiceSayCommand
|
|
153
|
+
* // text: "STRING_VALUE", // required
|
|
154
|
+
* // replyId: "STRING_VALUE", // required
|
|
155
|
+
* // interruptible: true || false,
|
|
156
|
+
* // audio: { // VoiceSayCommandAudioOptions
|
|
157
|
+
* // streamId: "STRING_VALUE", // required
|
|
158
|
+
* // sampleRate: Number("int"), // required
|
|
159
|
+
* // },
|
|
160
|
+
* // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
|
|
161
|
+
* // },
|
|
162
|
+
* // play: { // VoicePlayCommand
|
|
163
|
+
* // replyId: "STRING_VALUE", // required
|
|
164
|
+
* // streamId: "STRING_VALUE", // required
|
|
165
|
+
* // data: "STRING_VALUE", // required
|
|
166
|
+
* // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
|
|
167
|
+
* // },
|
|
168
|
+
* // stop: { // VoiceStopCommand
|
|
169
|
+
* // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
|
|
170
|
+
* // },
|
|
171
|
+
* // hangup: { // VoiceHangupCommand
|
|
172
|
+
* // reason: "STRING_VALUE",
|
|
173
|
+
* // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
|
|
174
|
+
* // },
|
|
175
|
+
* // transfer: { // VoiceTransferCommand
|
|
176
|
+
* // context: "STRING_VALUE", // required
|
|
177
|
+
* // extension: "STRING_VALUE", // required
|
|
178
|
+
* // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
|
|
179
|
+
* // },
|
|
155
180
|
* // },
|
|
156
|
-
* // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
|
|
157
|
-
* // },
|
|
158
|
-
* // playCommand: { // VoicePlayCommandData
|
|
159
|
-
* // replyId: "STRING_VALUE", // required
|
|
160
|
-
* // streamId: "STRING_VALUE", // required
|
|
161
|
-
* // data: "STRING_VALUE", // required
|
|
162
|
-
* // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
|
|
163
|
-
* // },
|
|
164
|
-
* // stopCommand: { // VoiceStopCommandData
|
|
165
|
-
* // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
|
|
166
|
-
* // },
|
|
167
|
-
* // hangupCommand: { // VoiceHangupCommandData
|
|
168
|
-
* // reason: "STRING_VALUE",
|
|
169
|
-
* // type: "say" || "play" || "stop" || "hangup" || "transfer", // required
|
|
170
181
|
* // },
|
|
171
|
-
* //
|
|
172
|
-
* //
|
|
173
|
-
* //
|
|
174
|
-
* //
|
|
182
|
+
* // callSocket: { // VoiceCallProtocolFrames
|
|
183
|
+
* // client: { // VoiceCallClientFrames
|
|
184
|
+
* // start: { // VoiceCallStartFrame
|
|
185
|
+
* // type: "start" || "vad" || "dtmf" || "playback" || "end", // required
|
|
186
|
+
* // callId: "STRING_VALUE", // required
|
|
187
|
+
* // flowIndex: Number("int"), // required
|
|
188
|
+
* // sessionId: "STRING_VALUE", // required
|
|
189
|
+
* // resume: true || false, // required
|
|
190
|
+
* // resumeAtMs: Number("int"), // required
|
|
191
|
+
* // agent: { // VoiceCallStartAgent
|
|
192
|
+
* // id: "STRING_VALUE", // required
|
|
193
|
+
* // draft: true || false,
|
|
194
|
+
* // version: Number("int"),
|
|
195
|
+
* // },
|
|
196
|
+
* // language: "STRING_VALUE", // required
|
|
197
|
+
* // caller: { // VoiceCallStartCaller
|
|
198
|
+
* // name: "STRING_VALUE",
|
|
199
|
+
* // number: "STRING_VALUE",
|
|
200
|
+
* // email: "STRING_VALUE",
|
|
201
|
+
* // company: "STRING_VALUE",
|
|
202
|
+
* // },
|
|
203
|
+
* // dialedNumber: "STRING_VALUE",
|
|
204
|
+
* // variables: "STRING_VALUE",
|
|
205
|
+
* // },
|
|
206
|
+
* // vad: { // VoiceCallVadFrame
|
|
207
|
+
* // type: "start" || "vad" || "dtmf" || "playback" || "end", // required
|
|
208
|
+
* // speaking: true || false, // required
|
|
209
|
+
* // energyDb: Number("double"), // required
|
|
210
|
+
* // atMs: Number("int"), // required
|
|
211
|
+
* // },
|
|
212
|
+
* // dtmf: { // VoiceCallDtmfFrame
|
|
213
|
+
* // type: "start" || "vad" || "dtmf" || "playback" || "end", // required
|
|
214
|
+
* // id: "STRING_VALUE", // required
|
|
215
|
+
* // digits: "STRING_VALUE", // required
|
|
216
|
+
* // },
|
|
217
|
+
* // playback: { // VoiceCallPlaybackFrame
|
|
218
|
+
* // type: "start" || "vad" || "dtmf" || "playback" || "end", // required
|
|
219
|
+
* // replyId: "STRING_VALUE", // required
|
|
220
|
+
* // streamId: "STRING_VALUE", // required
|
|
221
|
+
* // event: "started" || "finished" || "stopped", // required
|
|
222
|
+
* // atMs: Number("int"), // required
|
|
223
|
+
* // playedMs: Number("int"),
|
|
224
|
+
* // dropped: true || false,
|
|
225
|
+
* // },
|
|
226
|
+
* // end: { // VoiceCallEndFrame
|
|
227
|
+
* // type: "start" || "vad" || "dtmf" || "playback" || "end", // required
|
|
228
|
+
* // reason: "caller-hangup" || "agent-hangup" || "agent-transfer" || "timeout", // required
|
|
229
|
+
* // },
|
|
230
|
+
* // },
|
|
231
|
+
* // server: { // VoiceCallServerFrames
|
|
232
|
+
* // started: { // VoiceCallStartedFrame
|
|
233
|
+
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
234
|
+
* // connectionId: "STRING_VALUE", // required
|
|
235
|
+
* // agent: { // VoiceCallStartedAgent
|
|
236
|
+
* // id: "STRING_VALUE", // required
|
|
237
|
+
* // name: "STRING_VALUE", // required
|
|
238
|
+
* // groupId: "STRING_VALUE",
|
|
239
|
+
* // },
|
|
240
|
+
* // backgroundSound: "STRING_VALUE",
|
|
241
|
+
* // voiceDetection: { // VoiceDetectionSettings
|
|
242
|
+
* // silenceMs: Number("int"),
|
|
243
|
+
* // silenceLevelDb: Number("int"),
|
|
244
|
+
* // speechLevelDb: Number("int"),
|
|
245
|
+
* // },
|
|
246
|
+
* // },
|
|
247
|
+
* // transcription: { // VoiceCallTranscriptionFrame
|
|
248
|
+
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
249
|
+
* // party: "caller" || "callee", // required
|
|
250
|
+
* // id: "STRING_VALUE", // required
|
|
251
|
+
* // final: true || false, // required
|
|
252
|
+
* // text: "STRING_VALUE", // required
|
|
253
|
+
* // startMs: Number("int"), // required
|
|
254
|
+
* // endMs: Number("int"), // required
|
|
255
|
+
* // language: "STRING_VALUE", // required
|
|
256
|
+
* // confidence: Number("double"),
|
|
257
|
+
* // },
|
|
258
|
+
* // audioBegin: { // VoiceCallAudioBeginFrame
|
|
259
|
+
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
260
|
+
* // replyId: "STRING_VALUE", // required
|
|
261
|
+
* // streamId: "STRING_VALUE", // required
|
|
262
|
+
* // sampleRate: Number("int"), // required
|
|
263
|
+
* // },
|
|
264
|
+
* // audioEnd: { // VoiceCallAudioEndFrame
|
|
265
|
+
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
266
|
+
* // streamId: "STRING_VALUE", // required
|
|
267
|
+
* // },
|
|
268
|
+
* // stop: { // VoiceCallStopFrame
|
|
269
|
+
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
270
|
+
* // },
|
|
271
|
+
* // duck: { // VoiceCallDuckFrame
|
|
272
|
+
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
273
|
+
* // replyId: "STRING_VALUE", // required
|
|
274
|
+
* // volumeDb: Number("int"), // required
|
|
275
|
+
* // rampMs: Number("int"), // required
|
|
276
|
+
* // },
|
|
277
|
+
* // language: { // VoiceCallLanguageFrame
|
|
278
|
+
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
279
|
+
* // language: "STRING_VALUE", // required
|
|
280
|
+
* // },
|
|
281
|
+
* // transfer: { // VoiceCallTransferFrame
|
|
282
|
+
* // context: "STRING_VALUE", // required
|
|
283
|
+
* // extension: "STRING_VALUE", // required
|
|
284
|
+
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
285
|
+
* // },
|
|
286
|
+
* // hangup: { // VoiceCallHangupFrame
|
|
287
|
+
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
288
|
+
* // },
|
|
289
|
+
* // error: { // VoiceCallErrorFrame
|
|
290
|
+
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
291
|
+
* // code: "STRING_VALUE", // required
|
|
292
|
+
* // retryable: true || false, // required
|
|
293
|
+
* // message: "STRING_VALUE", // required
|
|
294
|
+
* // },
|
|
295
|
+
* // ended: { // VoiceCallEndedFrame
|
|
296
|
+
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
297
|
+
* // },
|
|
298
|
+
* // },
|
|
175
299
|
* // },
|
|
176
300
|
* // callEvent: { // VoiceCallEvent Union: only one key present
|
|
177
301
|
* // started: { // VoiceCallStartedEvent
|
|
@@ -233,117 +357,6 @@ declare const DescribeVoiceProtocolCommand_base: {
|
|
|
233
357
|
* // reason: "hangup" || "transfer" || "timeout" || "error" || "complete", // required
|
|
234
358
|
* // },
|
|
235
359
|
* // },
|
|
236
|
-
* // callSocket: { // VoiceCallProtocolFrames
|
|
237
|
-
* // start: { // VoiceCallStartFrame
|
|
238
|
-
* // type: "start" || "vad" || "dtmf" || "playback" || "end", // required
|
|
239
|
-
* // callId: "STRING_VALUE", // required
|
|
240
|
-
* // flowIndex: Number("int"), // required
|
|
241
|
-
* // sessionId: "STRING_VALUE", // required
|
|
242
|
-
* // resume: true || false, // required
|
|
243
|
-
* // resumeAtMs: Number("int"), // required
|
|
244
|
-
* // agent: { // VoiceCallStartAgent
|
|
245
|
-
* // id: "STRING_VALUE", // required
|
|
246
|
-
* // draft: true || false,
|
|
247
|
-
* // version: Number("int"),
|
|
248
|
-
* // },
|
|
249
|
-
* // language: "STRING_VALUE", // required
|
|
250
|
-
* // caller: { // VoiceCallStartCaller
|
|
251
|
-
* // name: "STRING_VALUE",
|
|
252
|
-
* // number: "STRING_VALUE",
|
|
253
|
-
* // email: "STRING_VALUE",
|
|
254
|
-
* // company: "STRING_VALUE",
|
|
255
|
-
* // },
|
|
256
|
-
* // dialedNumber: "STRING_VALUE",
|
|
257
|
-
* // variables: "STRING_VALUE",
|
|
258
|
-
* // },
|
|
259
|
-
* // vad: { // VoiceCallVadFrame
|
|
260
|
-
* // type: "start" || "vad" || "dtmf" || "playback" || "end", // required
|
|
261
|
-
* // speaking: true || false, // required
|
|
262
|
-
* // energyDb: Number("double"), // required
|
|
263
|
-
* // atMs: Number("int"), // required
|
|
264
|
-
* // },
|
|
265
|
-
* // dtmf: { // VoiceCallDtmfFrame
|
|
266
|
-
* // type: "start" || "vad" || "dtmf" || "playback" || "end", // required
|
|
267
|
-
* // id: "STRING_VALUE", // required
|
|
268
|
-
* // digits: "STRING_VALUE", // required
|
|
269
|
-
* // },
|
|
270
|
-
* // playback: { // VoiceCallPlaybackFrame
|
|
271
|
-
* // type: "start" || "vad" || "dtmf" || "playback" || "end", // required
|
|
272
|
-
* // replyId: "STRING_VALUE", // required
|
|
273
|
-
* // streamId: "STRING_VALUE", // required
|
|
274
|
-
* // event: "started" || "finished" || "stopped", // required
|
|
275
|
-
* // atMs: Number("int"), // required
|
|
276
|
-
* // playedMs: Number("int"),
|
|
277
|
-
* // dropped: true || false,
|
|
278
|
-
* // },
|
|
279
|
-
* // end: { // VoiceCallEndFrame
|
|
280
|
-
* // type: "start" || "vad" || "dtmf" || "playback" || "end", // required
|
|
281
|
-
* // reason: "caller-hangup" || "agent-hangup" || "agent-transfer" || "timeout", // required
|
|
282
|
-
* // },
|
|
283
|
-
* // started: { // VoiceCallStartedFrame
|
|
284
|
-
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
285
|
-
* // connectionId: "STRING_VALUE", // required
|
|
286
|
-
* // agentName: "STRING_VALUE", // required
|
|
287
|
-
* // groupId: "STRING_VALUE",
|
|
288
|
-
* // backgroundSound: "STRING_VALUE",
|
|
289
|
-
* // voiceDetection: { // VoiceDetectionSettings
|
|
290
|
-
* // silenceMs: Number("int"),
|
|
291
|
-
* // silenceLevelDb: Number("int"),
|
|
292
|
-
* // speechLevelDb: Number("int"),
|
|
293
|
-
* // },
|
|
294
|
-
* // },
|
|
295
|
-
* // transcription: { // VoiceCallTranscriptionFrame
|
|
296
|
-
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
297
|
-
* // party: "caller" || "callee", // required
|
|
298
|
-
* // id: "STRING_VALUE", // required
|
|
299
|
-
* // final: true || false, // required
|
|
300
|
-
* // text: "STRING_VALUE", // required
|
|
301
|
-
* // startMs: Number("int"), // required
|
|
302
|
-
* // endMs: Number("int"), // required
|
|
303
|
-
* // language: "STRING_VALUE", // required
|
|
304
|
-
* // confidence: Number("double"),
|
|
305
|
-
* // },
|
|
306
|
-
* // audioBegin: { // VoiceCallAudioBeginFrame
|
|
307
|
-
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
308
|
-
* // replyId: "STRING_VALUE", // required
|
|
309
|
-
* // streamId: "STRING_VALUE", // required
|
|
310
|
-
* // sampleRate: Number("int"), // required
|
|
311
|
-
* // },
|
|
312
|
-
* // audioEnd: { // VoiceCallAudioEndFrame
|
|
313
|
-
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
314
|
-
* // streamId: "STRING_VALUE", // required
|
|
315
|
-
* // },
|
|
316
|
-
* // stop: { // VoiceCallStopFrame
|
|
317
|
-
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
318
|
-
* // },
|
|
319
|
-
* // duck: { // VoiceCallDuckFrame
|
|
320
|
-
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
321
|
-
* // replyId: "STRING_VALUE", // required
|
|
322
|
-
* // volumeDb: Number("int"), // required
|
|
323
|
-
* // rampMs: Number("int"), // required
|
|
324
|
-
* // },
|
|
325
|
-
* // language: { // VoiceCallLanguageFrame
|
|
326
|
-
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
327
|
-
* // language: "STRING_VALUE", // required
|
|
328
|
-
* // },
|
|
329
|
-
* // transfer: { // VoiceCallTransferFrame
|
|
330
|
-
* // context: "STRING_VALUE", // required
|
|
331
|
-
* // extension: "STRING_VALUE", // required
|
|
332
|
-
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
333
|
-
* // },
|
|
334
|
-
* // hangup: { // VoiceCallHangupFrame
|
|
335
|
-
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
336
|
-
* // },
|
|
337
|
-
* // error: { // VoiceCallErrorFrame
|
|
338
|
-
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
339
|
-
* // code: "STRING_VALUE", // required
|
|
340
|
-
* // retryable: true || false, // required
|
|
341
|
-
* // message: "STRING_VALUE", // required
|
|
342
|
-
* // },
|
|
343
|
-
* // ended: { // VoiceCallEndedFrame
|
|
344
|
-
* // type: "started" || "transcription" || "audio.begin" || "audio.end" || "stop" || "duck" || "language" || "transfer" || "hangup" || "error" || "ended", // required
|
|
345
|
-
* // },
|
|
346
|
-
* // },
|
|
347
360
|
* // };
|
|
348
361
|
*
|
|
349
362
|
* ```
|
|
@@ -97,27 +97,6 @@ export declare const VoiceCallEndReason: {
|
|
|
97
97
|
* @public
|
|
98
98
|
*/
|
|
99
99
|
export type VoiceCallEndReason = (typeof VoiceCallEndReason)[keyof typeof VoiceCallEndReason];
|
|
100
|
-
/**
|
|
101
|
-
* @public
|
|
102
|
-
* @enum
|
|
103
|
-
*/
|
|
104
|
-
export declare const VoiceCallServerFrameType: {
|
|
105
|
-
readonly AUDIO_BEGIN: "audio.begin";
|
|
106
|
-
readonly AUDIO_END: "audio.end";
|
|
107
|
-
readonly DUCK: "duck";
|
|
108
|
-
readonly ENDED: "ended";
|
|
109
|
-
readonly ERROR: "error";
|
|
110
|
-
readonly HANGUP: "hangup";
|
|
111
|
-
readonly LANGUAGE: "language";
|
|
112
|
-
readonly STARTED: "started";
|
|
113
|
-
readonly STOP: "stop";
|
|
114
|
-
readonly TRANSCRIPTION: "transcription";
|
|
115
|
-
readonly TRANSFER: "transfer";
|
|
116
|
-
};
|
|
117
|
-
/**
|
|
118
|
-
* @public
|
|
119
|
-
*/
|
|
120
|
-
export type VoiceCallServerFrameType = (typeof VoiceCallServerFrameType)[keyof typeof VoiceCallServerFrameType];
|
|
121
100
|
/**
|
|
122
101
|
* @public
|
|
123
102
|
* @enum
|
|
@@ -181,6 +160,27 @@ export declare const VoiceCallPlaybackPhase: {
|
|
|
181
160
|
* @public
|
|
182
161
|
*/
|
|
183
162
|
export type VoiceCallPlaybackPhase = (typeof VoiceCallPlaybackPhase)[keyof typeof VoiceCallPlaybackPhase];
|
|
163
|
+
/**
|
|
164
|
+
* @public
|
|
165
|
+
* @enum
|
|
166
|
+
*/
|
|
167
|
+
export declare const VoiceCallServerFrameType: {
|
|
168
|
+
readonly AUDIO_BEGIN: "audio.begin";
|
|
169
|
+
readonly AUDIO_END: "audio.end";
|
|
170
|
+
readonly DUCK: "duck";
|
|
171
|
+
readonly ENDED: "ended";
|
|
172
|
+
readonly ERROR: "error";
|
|
173
|
+
readonly HANGUP: "hangup";
|
|
174
|
+
readonly LANGUAGE: "language";
|
|
175
|
+
readonly STARTED: "started";
|
|
176
|
+
readonly STOP: "stop";
|
|
177
|
+
readonly TRANSCRIPTION: "transcription";
|
|
178
|
+
readonly TRANSFER: "transfer";
|
|
179
|
+
};
|
|
180
|
+
/**
|
|
181
|
+
* @public
|
|
182
|
+
*/
|
|
183
|
+
export type VoiceCallServerFrameType = (typeof VoiceCallServerFrameType)[keyof typeof VoiceCallServerFrameType];
|
|
184
184
|
/**
|
|
185
185
|
* @public
|
|
186
186
|
* @enum
|