@azure/communication-call-automation 1.3.0-beta.2 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.js +213 -1240
- package/dist/index.js.map +1 -1
- package/dist-esm/src/callAutomationClient.js +5 -9
- package/dist-esm/src/callAutomationClient.js.map +1 -1
- package/dist-esm/src/callAutomationEventParser.js +5 -20
- package/dist-esm/src/callAutomationEventParser.js.map +1 -1
- package/dist-esm/src/callConnection.js +1 -1
- package/dist-esm/src/callConnection.js.map +1 -1
- package/dist-esm/src/callMedia.js +1 -57
- package/dist-esm/src/callMedia.js.map +1 -1
- package/dist-esm/src/callRecording.js +1 -1
- package/dist-esm/src/callRecording.js.map +1 -1
- package/dist-esm/src/contentDownloader.js +2 -2
- package/dist-esm/src/contentDownloader.js.map +1 -1
- package/dist-esm/src/credential/callAutomationAccessKeyCredentialPolicy.js +1 -1
- package/dist-esm/src/credential/callAutomationAccessKeyCredentialPolicy.js.map +1 -1
- package/dist-esm/src/credential/callAutomationAuthPolicy.js +2 -2
- package/dist-esm/src/credential/callAutomationAuthPolicy.js.map +1 -1
- package/dist-esm/src/credential/cryptoUtils.browser.js +1 -1
- package/dist-esm/src/credential/cryptoUtils.browser.js.map +1 -1
- package/dist-esm/src/credential/cryptoUtils.js +1 -1
- package/dist-esm/src/credential/cryptoUtils.js.map +1 -1
- package/dist-esm/src/credential/encodeUtils.browser.js +1 -1
- package/dist-esm/src/credential/encodeUtils.browser.js.map +1 -1
- package/dist-esm/src/generated/src/callAutomationApiClient.js +2 -2
- package/dist-esm/src/generated/src/callAutomationApiClient.js.map +1 -1
- package/dist-esm/src/generated/src/models/index.js +2 -150
- package/dist-esm/src/generated/src/models/index.js.map +1 -1
- package/dist-esm/src/generated/src/models/mappers.js +132 -696
- package/dist-esm/src/generated/src/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/src/models/parameters.js +2 -22
- package/dist-esm/src/generated/src/models/parameters.js.map +1 -1
- package/dist-esm/src/generated/src/operations/callConnection.js +1 -1
- package/dist-esm/src/generated/src/operations/callConnection.js.map +1 -1
- package/dist-esm/src/generated/src/operations/callMedia.js +0 -125
- package/dist-esm/src/generated/src/operations/callMedia.js.map +1 -1
- package/dist-esm/src/generated/src/operationsInterfaces/callConnection.js.map +1 -1
- package/dist-esm/src/generated/src/operationsInterfaces/callMedia.js.map +1 -1
- package/dist-esm/src/index.js +1 -4
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/models/constants.js +2 -2
- package/dist-esm/src/models/constants.js.map +1 -1
- package/dist-esm/src/models/events.js +1 -1
- package/dist-esm/src/models/events.js.map +1 -1
- package/dist-esm/src/models/logger.js +1 -1
- package/dist-esm/src/models/logger.js.map +1 -1
- package/dist-esm/src/models/mapper.js +1 -1
- package/dist-esm/src/models/mapper.js.map +1 -1
- package/dist-esm/src/models/models.js +2 -2
- package/dist-esm/src/models/models.js.map +1 -1
- package/dist-esm/src/models/options.js +1 -1
- package/dist-esm/src/models/options.js.map +1 -1
- package/dist-esm/src/models/responses.js +1 -1
- package/dist-esm/src/models/responses.js.map +1 -1
- package/dist-esm/src/utli/converters.js +2 -2
- package/dist-esm/src/utli/converters.js.map +1 -1
- package/package.json +12 -15
- package/types/communication-call-automation.d.ts +86 -708
- package/dist-esm/src/models/audio.js +0 -2
- package/dist-esm/src/models/audio.js.map +0 -1
- package/dist-esm/src/models/transcription.js +0 -11
- package/dist-esm/src/models/transcription.js.map +0 -1
- package/dist-esm/src/streamingDataParser.js +0 -68
- package/dist-esm/src/streamingDataParser.js.map +0 -1
|
@@ -73,10 +73,6 @@ export declare interface AddParticipantSucceeded extends Omit<RestAddParticipant
|
|
|
73
73
|
export declare interface AnswerCallOptions extends OperationOptions {
|
|
74
74
|
/** AI options for the call. */
|
|
75
75
|
callIntelligenceOptions?: CallIntelligenceOptions;
|
|
76
|
-
/** Configuration of Media streaming. */
|
|
77
|
-
mediaStreamingOptions?: MediaStreamingOptions;
|
|
78
|
-
/** Configuration of live transcription. */
|
|
79
|
-
transcriptionOptions?: TranscriptionOptions;
|
|
80
76
|
/** The operation context. */
|
|
81
77
|
operationContext?: string;
|
|
82
78
|
}
|
|
@@ -86,34 +82,17 @@ export declare interface AnswerCallOptions extends OperationOptions {
|
|
|
86
82
|
*/
|
|
87
83
|
export declare type AnswerCallResult = CallResult;
|
|
88
84
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
participant: CommunicationIdentifier | undefined;
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
/**
|
|
104
|
-
* Audio streaming metadata.
|
|
105
|
-
*/
|
|
106
|
-
export declare interface AudioMetadata {
|
|
107
|
-
/** Audio streaming subscription id.*/
|
|
108
|
-
subscriptionId: string;
|
|
109
|
-
/** Audio streaming encoding.*/
|
|
110
|
-
encoding: string;
|
|
111
|
-
/** Audio streaming sample rate.*/
|
|
112
|
-
sampleRate: number;
|
|
113
|
-
/** Audio streaming chnnels*/
|
|
114
|
-
channels: number;
|
|
115
|
-
/** Audio streaming length.*/
|
|
116
|
-
length: number;
|
|
85
|
+
export declare interface AnswerFailed extends Omit<RestAnswerFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
86
|
+
/** Call connection ID. */
|
|
87
|
+
callConnectionId: string;
|
|
88
|
+
/** Server call ID. */
|
|
89
|
+
serverCallId: string;
|
|
90
|
+
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
91
|
+
correlationId: string;
|
|
92
|
+
/** Contains the resulting SIP code, sub-code and message. */
|
|
93
|
+
resultInformation?: ResultInformation;
|
|
94
|
+
/** kind of this event. */
|
|
95
|
+
kind: "AnswerFailed";
|
|
117
96
|
}
|
|
118
97
|
|
|
119
98
|
/** Optional parameters. */
|
|
@@ -216,16 +195,18 @@ export declare interface CallAutomationClientOptions extends CommonClientOptions
|
|
|
216
195
|
}
|
|
217
196
|
|
|
218
197
|
/** Callback events for Call Automation */
|
|
219
|
-
export declare type CallAutomationEvent = AddParticipantSucceeded | AddParticipantFailed | RemoveParticipantSucceeded | RemoveParticipantFailed | CallConnected | CallDisconnected | CallTransferAccepted | CallTransferFailed | ParticipantsUpdated | RecordingStateChanged | PlayStarted | PlayCompleted | PlayFailed | PlayCanceled | RecognizeCompleted | RecognizeCanceled | RecognizeFailed | ContinuousDtmfRecognitionToneReceived | ContinuousDtmfRecognitionToneFailed | ContinuousDtmfRecognitionStopped | SendDtmfTonesCompleted | SendDtmfTonesFailed | CancelAddParticipantSucceeded | CancelAddParticipantFailed | ConnectFailed |
|
|
198
|
+
export declare type CallAutomationEvent = AddParticipantSucceeded | AddParticipantFailed | RemoveParticipantSucceeded | RemoveParticipantFailed | CallConnected | CallDisconnected | CallTransferAccepted | CallTransferFailed | ParticipantsUpdated | RecordingStateChanged | PlayStarted | PlayCompleted | PlayFailed | PlayCanceled | RecognizeCompleted | RecognizeCanceled | RecognizeFailed | ContinuousDtmfRecognitionToneReceived | ContinuousDtmfRecognitionToneFailed | ContinuousDtmfRecognitionStopped | SendDtmfTonesCompleted | SendDtmfTonesFailed | CancelAddParticipantSucceeded | CancelAddParticipantFailed | ConnectFailed | HoldFailed | AnswerFailed | CreateCallFailed;
|
|
220
199
|
|
|
221
200
|
/** Event when call was established. */
|
|
222
|
-
export declare interface CallConnected extends Omit<RestCallConnected, "callConnectionId" | "serverCallId" | "correlationId"> {
|
|
201
|
+
export declare interface CallConnected extends Omit<RestCallConnected, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
223
202
|
/** Call connection ID. */
|
|
224
203
|
callConnectionId: string;
|
|
225
204
|
/** Server call ID. */
|
|
226
205
|
serverCallId: string;
|
|
227
206
|
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
228
207
|
correlationId: string;
|
|
208
|
+
/** Contains the resulting SIP code/sub-code and message from NGC services. */
|
|
209
|
+
resultInformation?: ResultInformation;
|
|
229
210
|
/** kind of this event. */
|
|
230
211
|
kind: "CallConnected";
|
|
231
212
|
}
|
|
@@ -320,10 +301,6 @@ export declare interface CallConnectionProperties {
|
|
|
320
301
|
callConnectionState?: CallConnectionStateModel;
|
|
321
302
|
/** The callback URL. */
|
|
322
303
|
callbackUrl?: string;
|
|
323
|
-
/** Subscription for media streaming */
|
|
324
|
-
mediaStreamingSubscription?: MediaStreamingSubscription;
|
|
325
|
-
/** Subscription for transcription */
|
|
326
|
-
transcriptionSubscription?: TranscriptionSubscription;
|
|
327
304
|
/** The correlation ID. */
|
|
328
305
|
correlationId?: string;
|
|
329
306
|
/** Identity of the answering entity. Only populated when identity is provided in the request. */
|
|
@@ -348,13 +325,15 @@ export declare interface CallConnectionProperties {
|
|
|
348
325
|
export declare type CallConnectionStateModel = string;
|
|
349
326
|
|
|
350
327
|
/** Event when all participants left and call was terminated. */
|
|
351
|
-
export declare interface CallDisconnected extends Omit<RestCallDisconnected, "callConnectionId" | "serverCallId" | "correlationId"> {
|
|
328
|
+
export declare interface CallDisconnected extends Omit<RestCallDisconnected, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
352
329
|
/** Call connection ID. */
|
|
353
330
|
callConnectionId: string;
|
|
354
331
|
/** Server call ID. */
|
|
355
332
|
serverCallId: string;
|
|
356
333
|
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
357
334
|
correlationId: string;
|
|
335
|
+
/** Contains the resulting SIP code/sub-code and message from NGC services. */
|
|
336
|
+
resultInformation?: ResultInformation;
|
|
358
337
|
/** kind of this event. */
|
|
359
338
|
kind: "CallDisconnected";
|
|
360
339
|
}
|
|
@@ -461,31 +440,6 @@ export declare class CallMedia {
|
|
|
461
440
|
* @param options - Additional attributes for unhold participant.
|
|
462
441
|
*/
|
|
463
442
|
unhold(targetParticipant: CommunicationIdentifier, options?: UnholdOptions): Promise<void>;
|
|
464
|
-
/**
|
|
465
|
-
* Starts transcription in the call
|
|
466
|
-
* @param options - Additional attributes for start transcription.
|
|
467
|
-
*/
|
|
468
|
-
startTranscription(options?: StartTranscriptionOptions): Promise<void>;
|
|
469
|
-
/**
|
|
470
|
-
* Stops transcription in the call.
|
|
471
|
-
* @param options - Additional attributes for stop transcription.
|
|
472
|
-
*/
|
|
473
|
-
stopTranscription(options?: StopTranscriptionOptions): Promise<void>;
|
|
474
|
-
/**
|
|
475
|
-
* Update transcription language.
|
|
476
|
-
* @param locale - Defines new locale for transcription.
|
|
477
|
-
*/
|
|
478
|
-
updateTranscription(locale: string, options?: UpdateTranscriptionOptions): Promise<void>;
|
|
479
|
-
/**
|
|
480
|
-
* Starts media streaming in the call.
|
|
481
|
-
* @param options - Additional attributes for start media streaming.
|
|
482
|
-
*/
|
|
483
|
-
startMediaStreaming(options?: StartMediaStreamingOptions): Promise<void>;
|
|
484
|
-
/**
|
|
485
|
-
* Stops media streaming in the call.
|
|
486
|
-
* @param options - Additional attributes for stop media streaming.
|
|
487
|
-
*/
|
|
488
|
-
stopMediaStreaming(options?: StopMediaStreamingOptions): Promise<void>;
|
|
489
443
|
}
|
|
490
444
|
|
|
491
445
|
/** The recognize configuration specific to Choices. */
|
|
@@ -734,7 +688,7 @@ export declare interface CancelAddParticipantOperationResult {
|
|
|
734
688
|
}
|
|
735
689
|
|
|
736
690
|
/** Successful cancel add participant event. */
|
|
737
|
-
export declare interface CancelAddParticipantSucceeded extends Omit<RestCancelAddParticipantSucceeded, "callConnectionId" | "serverCallId" | "correlationId" | "invitationId"> {
|
|
691
|
+
export declare interface CancelAddParticipantSucceeded extends Omit<RestCancelAddParticipantSucceeded, "callConnectionId" | "serverCallId" | "correlationId" | "invitationId" | "resultInformation"> {
|
|
738
692
|
/** Call connection ID. */
|
|
739
693
|
callConnectionId: string;
|
|
740
694
|
/** Server call ID. */
|
|
@@ -743,6 +697,8 @@ export declare interface CancelAddParticipantSucceeded extends Omit<RestCancelAd
|
|
|
743
697
|
correlationId: string;
|
|
744
698
|
/** Invitation ID used to cancel the add participant request. */
|
|
745
699
|
invitationId: string;
|
|
700
|
+
/** Contains the resulting SIP code/sub-code and message from NGC services. */
|
|
701
|
+
resultInformation?: ResultInformation;
|
|
746
702
|
/** kind of this event. */
|
|
747
703
|
kind: "CancelAddParticipantSucceeded";
|
|
748
704
|
}
|
|
@@ -899,6 +855,19 @@ export declare interface ContinuousDtmfRecognitionToneReceived extends Omit<Rest
|
|
|
899
855
|
kind: "ContinuousDtmfRecognitionToneReceived";
|
|
900
856
|
}
|
|
901
857
|
|
|
858
|
+
export declare interface CreateCallFailed extends Omit<RestCreateCallFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
859
|
+
/** Call connection ID. */
|
|
860
|
+
callConnectionId: string;
|
|
861
|
+
/** Server call ID. */
|
|
862
|
+
serverCallId: string;
|
|
863
|
+
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
864
|
+
correlationId: string;
|
|
865
|
+
/** Contains the resulting SIP code, sub-code and message. */
|
|
866
|
+
resultInformation?: ResultInformation;
|
|
867
|
+
/** kind of this event. */
|
|
868
|
+
kind: "CreateCallFailed";
|
|
869
|
+
}
|
|
870
|
+
|
|
902
871
|
/**
|
|
903
872
|
* Options to create a call.
|
|
904
873
|
*/
|
|
@@ -914,10 +883,6 @@ export declare interface CreateCallOptions extends OperationOptions {
|
|
|
914
883
|
operationContext?: string;
|
|
915
884
|
/** AI options for the call. */
|
|
916
885
|
callIntelligenceOptions?: CallIntelligenceOptions;
|
|
917
|
-
/** Configuration of Media streaming. */
|
|
918
|
-
mediaStreamingOptions?: MediaStreamingOptions;
|
|
919
|
-
/** Configuration of live transcription. */
|
|
920
|
-
transcriptionOptions?: TranscriptionOptions;
|
|
921
886
|
}
|
|
922
887
|
|
|
923
888
|
/**
|
|
@@ -1050,26 +1015,6 @@ export declare enum KnownCallRejectReason {
|
|
|
1050
1015
|
Forbidden = "forbidden"
|
|
1051
1016
|
}
|
|
1052
1017
|
|
|
1053
|
-
/** Known values of {@link MediaStreamingAudioChannelType} that the service accepts. */
|
|
1054
|
-
export declare enum KnownMediaStreamingAudioChannelType {
|
|
1055
|
-
/** Mixed */
|
|
1056
|
-
Mixed = "mixed",
|
|
1057
|
-
/** Unmixed */
|
|
1058
|
-
Unmixed = "unmixed"
|
|
1059
|
-
}
|
|
1060
|
-
|
|
1061
|
-
/** Known values of {@link MediaStreamingContentType} that the service accepts. */
|
|
1062
|
-
export declare enum KnownMediaStreamingContentType {
|
|
1063
|
-
/** Audio */
|
|
1064
|
-
Audio = "audio"
|
|
1065
|
-
}
|
|
1066
|
-
|
|
1067
|
-
/** Known values of {@link MediaStreamingTransportType} that the service accepts. */
|
|
1068
|
-
export declare enum KnownMediaStreamingTransportType {
|
|
1069
|
-
/** Websocket */
|
|
1070
|
-
Websocket = "websocket"
|
|
1071
|
-
}
|
|
1072
|
-
|
|
1073
1018
|
/** The response payload for getting participants of the call. */
|
|
1074
1019
|
export declare interface ListParticipantsResult {
|
|
1075
1020
|
/** List of the current participants in the call. */
|
|
@@ -1078,149 +1023,6 @@ export declare interface ListParticipantsResult {
|
|
|
1078
1023
|
nextLink?: string;
|
|
1079
1024
|
}
|
|
1080
1025
|
|
|
1081
|
-
/**
|
|
1082
|
-
* Defines values for MediaStreamingAudioChannelType. \
|
|
1083
|
-
* {@link KnownMediaStreamingAudioChannelType} can be used interchangeably with MediaStreamingAudioChannelType,
|
|
1084
|
-
* this enum contains the known values that the service supports.
|
|
1085
|
-
* ### Known values supported by the service
|
|
1086
|
-
* **mixed** \
|
|
1087
|
-
* **unmixed**
|
|
1088
|
-
*/
|
|
1089
|
-
export declare type MediaStreamingAudioChannelType = string;
|
|
1090
|
-
|
|
1091
|
-
/**
|
|
1092
|
-
* Defines values for MediaStreamingContentType. \
|
|
1093
|
-
* {@link KnownMediaStreamingContentType} can be used interchangeably with MediaStreamingContentType,
|
|
1094
|
-
* this enum contains the known values that the service supports.
|
|
1095
|
-
* ### Known values supported by the service
|
|
1096
|
-
* **audio**
|
|
1097
|
-
*/
|
|
1098
|
-
export declare type MediaStreamingContentType = string;
|
|
1099
|
-
|
|
1100
|
-
export declare interface MediaStreamingFailed extends Omit<RestMediaStreamingFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
1101
|
-
/** Call connection ID. */
|
|
1102
|
-
callConnectionId: string;
|
|
1103
|
-
/** Server call ID. */
|
|
1104
|
-
serverCallId: string;
|
|
1105
|
-
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
1106
|
-
correlationId: string;
|
|
1107
|
-
/** Contains the resulting SIP code, sub-code and message. */
|
|
1108
|
-
resultInformation?: ResultInformation;
|
|
1109
|
-
/** kind of this event. */
|
|
1110
|
-
kind: "MediaStreamingFailed";
|
|
1111
|
-
}
|
|
1112
|
-
|
|
1113
|
-
/** Configuration of Media streaming. */
|
|
1114
|
-
export declare interface MediaStreamingOptions {
|
|
1115
|
-
/** Transport URL for media streaming */
|
|
1116
|
-
transportUrl: string;
|
|
1117
|
-
/** The type of transport to be used for media streaming, eg. Websocket */
|
|
1118
|
-
transportType: MediaStreamingTransportType;
|
|
1119
|
-
/** Content type to stream, eg. audio */
|
|
1120
|
-
contentType: MediaStreamingContentType;
|
|
1121
|
-
/** Audio channel type to stream, eg. unmixed audio, mixed audio */
|
|
1122
|
-
audioChannelType: MediaStreamingAudioChannelType;
|
|
1123
|
-
/** Determines if the media streaming should be started immediately after call is answered or not. */
|
|
1124
|
-
startMediaStreaming?: boolean;
|
|
1125
|
-
}
|
|
1126
|
-
|
|
1127
|
-
export declare interface MediaStreamingStarted extends Omit<RestMediaStreamingStarted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
1128
|
-
/** Call connection ID. */
|
|
1129
|
-
callConnectionId: string;
|
|
1130
|
-
/** Server call ID. */
|
|
1131
|
-
serverCallId: string;
|
|
1132
|
-
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
1133
|
-
correlationId: string;
|
|
1134
|
-
/** Contains the resulting SIP code, sub-code and message. */
|
|
1135
|
-
resultInformation?: ResultInformation;
|
|
1136
|
-
/** kind of this event. */
|
|
1137
|
-
kind: "MediaStreamingStarted";
|
|
1138
|
-
}
|
|
1139
|
-
|
|
1140
|
-
/**
|
|
1141
|
-
* Defines values for MediaStreamingStatus. \
|
|
1142
|
-
* {@link KnownMediaStreamingStatus} can be used interchangeably with MediaStreamingStatus,
|
|
1143
|
-
* this enum contains the known values that the service supports.
|
|
1144
|
-
* ### Known values supported by the service
|
|
1145
|
-
* **mediaStreamingStarted** \
|
|
1146
|
-
* **mediaStreamingFailed** \
|
|
1147
|
-
* **mediaStreamingStopped** \
|
|
1148
|
-
* **unspecifiedError**
|
|
1149
|
-
*/
|
|
1150
|
-
declare type MediaStreamingStatus = string;
|
|
1151
|
-
|
|
1152
|
-
/**
|
|
1153
|
-
* Defines values for MediaStreamingStatusDetails. \
|
|
1154
|
-
* {@link KnownMediaStreamingStatusDetails} can be used interchangeably with MediaStreamingStatusDetails,
|
|
1155
|
-
* this enum contains the known values that the service supports.
|
|
1156
|
-
* ### Known values supported by the service
|
|
1157
|
-
* **subscriptionStarted** \
|
|
1158
|
-
* **streamConnectionReestablished** \
|
|
1159
|
-
* **streamConnectionUnsuccessful** \
|
|
1160
|
-
* **streamUrlMissing** \
|
|
1161
|
-
* **serviceShutdown** \
|
|
1162
|
-
* **streamConnectionInterrupted** \
|
|
1163
|
-
* **speechServicesConnectionError** \
|
|
1164
|
-
* **subscriptionStopped** \
|
|
1165
|
-
* **unspecifiedError** \
|
|
1166
|
-
* **authenticationFailure** \
|
|
1167
|
-
* **badRequest** \
|
|
1168
|
-
* **tooManyRequests** \
|
|
1169
|
-
* **forbidden** \
|
|
1170
|
-
* **serviceTimeout** \
|
|
1171
|
-
* **initialWebSocketConnectionFailed**
|
|
1172
|
-
*/
|
|
1173
|
-
declare type MediaStreamingStatusDetails = string;
|
|
1174
|
-
|
|
1175
|
-
export declare interface MediaStreamingStopped extends Omit<RestMediaStreamingStopped, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
1176
|
-
/** Call connection ID. */
|
|
1177
|
-
callConnectionId: string;
|
|
1178
|
-
/** Server call ID. */
|
|
1179
|
-
serverCallId: string;
|
|
1180
|
-
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
1181
|
-
correlationId: string;
|
|
1182
|
-
/** Contains the resulting SIP code, sub-code and message. */
|
|
1183
|
-
resultInformation?: ResultInformation;
|
|
1184
|
-
/** kind of this event. */
|
|
1185
|
-
kind: "MediaStreamingStopped";
|
|
1186
|
-
}
|
|
1187
|
-
|
|
1188
|
-
/** Media streaming Subscription Object. */
|
|
1189
|
-
export declare interface MediaStreamingSubscription {
|
|
1190
|
-
/** Subscription Id. */
|
|
1191
|
-
id?: string;
|
|
1192
|
-
/** Media streaming subscription state. */
|
|
1193
|
-
state?: MediaStreamingSubscriptionState;
|
|
1194
|
-
/** Subscribed media streaming content types. */
|
|
1195
|
-
subscribedContentTypes?: MediaStreamingContentType[];
|
|
1196
|
-
}
|
|
1197
|
-
|
|
1198
|
-
/**
|
|
1199
|
-
* Defines values for MediaStreamingSubscriptionState. \
|
|
1200
|
-
* {@link KnownMediaStreamingSubscriptionState} can be used interchangeably with MediaStreamingSubscriptionState,
|
|
1201
|
-
* this enum contains the known values that the service supports.
|
|
1202
|
-
* ### Known values supported by the service
|
|
1203
|
-
* **disabled** \
|
|
1204
|
-
* **inactive** \
|
|
1205
|
-
* **active**
|
|
1206
|
-
*/
|
|
1207
|
-
declare type MediaStreamingSubscriptionState = string;
|
|
1208
|
-
|
|
1209
|
-
/**
|
|
1210
|
-
* Defines values for MediaStreamingTransportType. \
|
|
1211
|
-
* {@link KnownMediaStreamingTransportType} can be used interchangeably with MediaStreamingTransportType,
|
|
1212
|
-
* this enum contains the known values that the service supports.
|
|
1213
|
-
* ### Known values supported by the service
|
|
1214
|
-
* **websocket**
|
|
1215
|
-
*/
|
|
1216
|
-
export declare type MediaStreamingTransportType = string;
|
|
1217
|
-
|
|
1218
|
-
declare interface MediaStreamingUpdate {
|
|
1219
|
-
contentType?: string;
|
|
1220
|
-
mediaStreamingStatus?: MediaStreamingStatus;
|
|
1221
|
-
mediaStreamingStatusDetails?: MediaStreamingStatusDetails;
|
|
1222
|
-
}
|
|
1223
|
-
|
|
1224
1026
|
/** A Microsoft Teams application. */
|
|
1225
1027
|
declare interface MicrosoftTeamsAppIdentifierModel {
|
|
1226
1028
|
/** The Id of the Microsoft Teams application. */
|
|
@@ -1259,7 +1061,7 @@ export declare interface MuteParticipantResult {
|
|
|
1259
1061
|
export declare function parseCallAutomationEvent(encodedEvents: string | Record<string, unknown>): CallAutomationEvent;
|
|
1260
1062
|
|
|
1261
1063
|
/** Event when there was an update to participant(s). */
|
|
1262
|
-
export declare interface ParticipantsUpdated extends Omit<RestParticipantsUpdated, "callConnectionId" | "serverCallId" | "correlationId" | "participants"> {
|
|
1064
|
+
export declare interface ParticipantsUpdated extends Omit<RestParticipantsUpdated, "callConnectionId" | "serverCallId" | "correlationId" | "participants" | "resultInformation"> {
|
|
1263
1065
|
/** Call connection ID. */
|
|
1264
1066
|
callConnectionId: string;
|
|
1265
1067
|
/** Server call ID. */
|
|
@@ -1268,6 +1070,8 @@ export declare interface ParticipantsUpdated extends Omit<RestParticipantsUpdate
|
|
|
1268
1070
|
correlationId: string;
|
|
1269
1071
|
/** The list of participants in the call. */
|
|
1270
1072
|
participants: CallParticipant[];
|
|
1073
|
+
/** Contains the resulting SIP code/sub-code and message from NGC services. */
|
|
1074
|
+
resultInformation?: ResultInformation;
|
|
1271
1075
|
/** kind of this event. */
|
|
1272
1076
|
kind: "ParticipantsUpdated";
|
|
1273
1077
|
}
|
|
@@ -1284,13 +1088,15 @@ declare interface PhoneNumberIdentifierModel {
|
|
|
1284
1088
|
}
|
|
1285
1089
|
|
|
1286
1090
|
/** Event when Media play was canceled by Cancel operation. */
|
|
1287
|
-
export declare interface PlayCanceled extends Omit<RestPlayCanceled, "callConnectionId" | "serverCallId" | "correlationId"> {
|
|
1091
|
+
export declare interface PlayCanceled extends Omit<RestPlayCanceled, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
1288
1092
|
/** Call connection ID. */
|
|
1289
1093
|
callConnectionId: string;
|
|
1290
1094
|
/** Server call ID. */
|
|
1291
1095
|
serverCallId: string;
|
|
1292
1096
|
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
1293
1097
|
correlationId: string;
|
|
1098
|
+
/** Contains the resulting SIP code/sub-code and message from NGC services. */
|
|
1099
|
+
resultInformation?: ResultInformation;
|
|
1294
1100
|
/** kind of this event. */
|
|
1295
1101
|
kind: "PlayCanceled";
|
|
1296
1102
|
}
|
|
@@ -1387,13 +1193,15 @@ export declare interface RecognitionChoice {
|
|
|
1387
1193
|
export declare type RecognitionType = string;
|
|
1388
1194
|
|
|
1389
1195
|
/** Event when Media recognize was canceled by Cancel operation. */
|
|
1390
|
-
export declare interface RecognizeCanceled extends Omit<RestRecognizeCanceled, "callConnectionId" | "serverCallId" | "correlationId"> {
|
|
1196
|
+
export declare interface RecognizeCanceled extends Omit<RestRecognizeCanceled, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
1391
1197
|
/** Call connection ID. */
|
|
1392
1198
|
callConnectionId: string;
|
|
1393
1199
|
/** Server call ID. */
|
|
1394
1200
|
serverCallId: string;
|
|
1395
1201
|
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
1396
1202
|
correlationId: string;
|
|
1203
|
+
/** Contains the resulting SIP code/sub-code and message from NGC services. */
|
|
1204
|
+
resultInformation?: ResultInformation;
|
|
1397
1205
|
/** kind of this event. */
|
|
1398
1206
|
kind: "RecognizeCanceled";
|
|
1399
1207
|
}
|
|
@@ -1466,13 +1274,15 @@ declare type RecordingKind_2 = string;
|
|
|
1466
1274
|
export declare type RecordingState = string;
|
|
1467
1275
|
|
|
1468
1276
|
/** Event when Recording state has been changed. */
|
|
1469
|
-
export declare interface RecordingStateChanged extends Omit<RestRecordingStateChanged, "callConnectionId" | "serverCallId" | "correlationId"> {
|
|
1277
|
+
export declare interface RecordingStateChanged extends Omit<RestRecordingStateChanged, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
1470
1278
|
/** Call connection ID. */
|
|
1471
1279
|
callConnectionId: string;
|
|
1472
1280
|
/** Server call ID. */
|
|
1473
1281
|
serverCallId: string;
|
|
1474
1282
|
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
1475
1283
|
correlationId: string;
|
|
1284
|
+
/** Contains the resulting SIP code/sub-code and message from NGC services. */
|
|
1285
|
+
resultInformation?: ResultInformation;
|
|
1476
1286
|
/** kind of this event. */
|
|
1477
1287
|
kind: "RecordingStateChanged";
|
|
1478
1288
|
}
|
|
@@ -1591,6 +1401,20 @@ export declare interface RestAddParticipantSucceeded {
|
|
|
1591
1401
|
participant?: CommunicationIdentifierModel;
|
|
1592
1402
|
}
|
|
1593
1403
|
|
|
1404
|
+
/** The failed to answer call event. */
|
|
1405
|
+
export declare interface RestAnswerFailed {
|
|
1406
|
+
/** Call connection ID. */
|
|
1407
|
+
callConnectionId?: string;
|
|
1408
|
+
/** Server call ID. */
|
|
1409
|
+
serverCallId?: string;
|
|
1410
|
+
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
1411
|
+
correlationId?: string;
|
|
1412
|
+
/** Used by customers when calling mid-call actions to correlate the request to the response event. */
|
|
1413
|
+
operationContext?: string;
|
|
1414
|
+
/** Contains the resulting SIP code, sub-code and message. */
|
|
1415
|
+
resultInformation?: RestResultInformation;
|
|
1416
|
+
}
|
|
1417
|
+
|
|
1594
1418
|
/** The call connected event. */
|
|
1595
1419
|
export declare interface RestCallConnected {
|
|
1596
1420
|
/** Call connection ID. */
|
|
@@ -1601,6 +1425,8 @@ export declare interface RestCallConnected {
|
|
|
1601
1425
|
correlationId?: string;
|
|
1602
1426
|
/** Used by customers to set the context for creating a new call. This property will be null for answering a call. */
|
|
1603
1427
|
operationContext?: string;
|
|
1428
|
+
/** Contains the resulting SIP code, sub-code and message. */
|
|
1429
|
+
resultInformation?: RestResultInformation;
|
|
1604
1430
|
}
|
|
1605
1431
|
|
|
1606
1432
|
/** The call disconnected event. */
|
|
@@ -1613,6 +1439,8 @@ export declare interface RestCallDisconnected {
|
|
|
1613
1439
|
correlationId?: string;
|
|
1614
1440
|
/** Used by customers to set the context for creating a new call. This property will be null for answering a call. */
|
|
1615
1441
|
operationContext?: string;
|
|
1442
|
+
/** Contains the resulting SIP code, sub-code and message. */
|
|
1443
|
+
resultInformation?: RestResultInformation;
|
|
1616
1444
|
}
|
|
1617
1445
|
|
|
1618
1446
|
/** The call transfer accepted event. */
|
|
@@ -1675,6 +1503,8 @@ export declare interface RestCancelAddParticipantSucceeded {
|
|
|
1675
1503
|
operationContext?: string;
|
|
1676
1504
|
/** Invitation ID used to cancel the request. */
|
|
1677
1505
|
invitationId?: string;
|
|
1506
|
+
/** Contains the resulting SIP code, sub-code and message. */
|
|
1507
|
+
resultInformation?: RestResultInformation;
|
|
1678
1508
|
}
|
|
1679
1509
|
|
|
1680
1510
|
/** The ConnectFailed event. */
|
|
@@ -1685,7 +1515,7 @@ export declare interface RestConnectFailed {
|
|
|
1685
1515
|
serverCallId?: string;
|
|
1686
1516
|
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
1687
1517
|
correlationId?: string;
|
|
1688
|
-
/** Used by customers to
|
|
1518
|
+
/** Used by customers to correlate the request to the response event. */
|
|
1689
1519
|
operationContext?: string;
|
|
1690
1520
|
/** Contains the resulting SIP code, sub-code and message. */
|
|
1691
1521
|
resultInformation?: RestResultInformation;
|
|
@@ -1736,12 +1566,13 @@ export declare interface RestContinuousDtmfRecognitionToneReceived {
|
|
|
1736
1566
|
operationContext?: string;
|
|
1737
1567
|
}
|
|
1738
1568
|
|
|
1739
|
-
|
|
1569
|
+
/** The create call failed event. */
|
|
1570
|
+
export declare interface RestCreateCallFailed {
|
|
1740
1571
|
/** Call connection ID. */
|
|
1741
1572
|
callConnectionId?: string;
|
|
1742
1573
|
/** Server call ID. */
|
|
1743
1574
|
serverCallId?: string;
|
|
1744
|
-
/** Correlation ID for event to call correlation. */
|
|
1575
|
+
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
1745
1576
|
correlationId?: string;
|
|
1746
1577
|
/** Used by customers when calling mid-call actions to correlate the request to the response event. */
|
|
1747
1578
|
operationContext?: string;
|
|
@@ -1749,85 +1580,17 @@ export declare interface RestHoldFailed {
|
|
|
1749
1580
|
resultInformation?: RestResultInformation;
|
|
1750
1581
|
}
|
|
1751
1582
|
|
|
1752
|
-
export declare interface
|
|
1753
|
-
/**
|
|
1754
|
-
|
|
1755
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1756
|
-
*/
|
|
1757
|
-
readonly callConnectionId?: string;
|
|
1758
|
-
/** Server call ID. */
|
|
1759
|
-
serverCallId?: string;
|
|
1760
|
-
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
1761
|
-
correlationId?: string;
|
|
1762
|
-
/**
|
|
1763
|
-
* Used by customers when calling answerCall action to correlate the request to the response event.
|
|
1764
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1765
|
-
*/
|
|
1766
|
-
readonly operationContext?: string;
|
|
1767
|
-
/**
|
|
1768
|
-
* Contains the resulting SIP code/sub-code and message from NGC services.
|
|
1769
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1770
|
-
*/
|
|
1771
|
-
readonly resultInformation?: RestResultInformation;
|
|
1772
|
-
/**
|
|
1773
|
-
* Defines the result for MediaStreamingUpdate with the current status and the details about the status
|
|
1774
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1775
|
-
*/
|
|
1776
|
-
readonly mediaStreamingUpdate?: MediaStreamingUpdate;
|
|
1777
|
-
}
|
|
1778
|
-
|
|
1779
|
-
export declare interface RestMediaStreamingStarted {
|
|
1780
|
-
/**
|
|
1781
|
-
* Call connection ID.
|
|
1782
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1783
|
-
*/
|
|
1784
|
-
readonly callConnectionId?: string;
|
|
1785
|
-
/** Server call ID. */
|
|
1786
|
-
serverCallId?: string;
|
|
1787
|
-
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
1788
|
-
correlationId?: string;
|
|
1789
|
-
/**
|
|
1790
|
-
* Used by customers when calling answerCall action to correlate the request to the response event.
|
|
1791
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1792
|
-
*/
|
|
1793
|
-
readonly operationContext?: string;
|
|
1794
|
-
/**
|
|
1795
|
-
* Contains the resulting SIP code/sub-code and message from NGC services.
|
|
1796
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1797
|
-
*/
|
|
1798
|
-
readonly resultInformation?: RestResultInformation;
|
|
1799
|
-
/**
|
|
1800
|
-
* Defines the result for MediaStreamingUpdate with the current status and the details about the status
|
|
1801
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1802
|
-
*/
|
|
1803
|
-
readonly mediaStreamingUpdate?: MediaStreamingUpdate;
|
|
1804
|
-
}
|
|
1805
|
-
|
|
1806
|
-
export declare interface RestMediaStreamingStopped {
|
|
1807
|
-
/**
|
|
1808
|
-
* Call connection ID.
|
|
1809
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1810
|
-
*/
|
|
1811
|
-
readonly callConnectionId?: string;
|
|
1583
|
+
export declare interface RestHoldFailed {
|
|
1584
|
+
/** Call connection ID. */
|
|
1585
|
+
callConnectionId?: string;
|
|
1812
1586
|
/** Server call ID. */
|
|
1813
1587
|
serverCallId?: string;
|
|
1814
|
-
/** Correlation ID for event to call correlation.
|
|
1588
|
+
/** Correlation ID for event to call correlation. */
|
|
1815
1589
|
correlationId?: string;
|
|
1816
|
-
/**
|
|
1817
|
-
|
|
1818
|
-
|
|
1819
|
-
|
|
1820
|
-
readonly operationContext?: string;
|
|
1821
|
-
/**
|
|
1822
|
-
* Contains the resulting SIP code/sub-code and message from NGC services.
|
|
1823
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1824
|
-
*/
|
|
1825
|
-
readonly resultInformation?: RestResultInformation;
|
|
1826
|
-
/**
|
|
1827
|
-
* Defines the result for MediaStreamingUpdate with the current status and the details about the status
|
|
1828
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
1829
|
-
*/
|
|
1830
|
-
readonly mediaStreamingUpdate?: MediaStreamingUpdate;
|
|
1590
|
+
/** Used by customers when calling mid-call actions to correlate the request to the response event. */
|
|
1591
|
+
operationContext?: string;
|
|
1592
|
+
/** Contains the resulting SIP code, sub-code and message. */
|
|
1593
|
+
resultInformation?: RestResultInformation;
|
|
1831
1594
|
}
|
|
1832
1595
|
|
|
1833
1596
|
/** The participants updated in a call event. */
|
|
@@ -1842,6 +1605,8 @@ export declare interface RestParticipantsUpdated {
|
|
|
1842
1605
|
sequenceNumber?: number;
|
|
1843
1606
|
/** The list of participants in the call. */
|
|
1844
1607
|
participants?: CallParticipantInternal[];
|
|
1608
|
+
/** Contains the resulting SIP code, sub-code and message. */
|
|
1609
|
+
resultInformation?: RestResultInformation;
|
|
1845
1610
|
}
|
|
1846
1611
|
|
|
1847
1612
|
export declare interface RestPlayCanceled {
|
|
@@ -1853,6 +1618,8 @@ export declare interface RestPlayCanceled {
|
|
|
1853
1618
|
correlationId?: string;
|
|
1854
1619
|
/** Used by customers when calling mid-call actions to correlate the request to the response event. */
|
|
1855
1620
|
operationContext?: string;
|
|
1621
|
+
/** Contains the resulting SIP code, sub-code and message. */
|
|
1622
|
+
resultInformation?: RestResultInformation;
|
|
1856
1623
|
}
|
|
1857
1624
|
|
|
1858
1625
|
export declare interface RestPlayCompleted {
|
|
@@ -1906,6 +1673,8 @@ export declare interface RestRecognizeCanceled {
|
|
|
1906
1673
|
correlationId?: string;
|
|
1907
1674
|
/** Used by customers when calling mid-call actions to correlate the request to the response event. */
|
|
1908
1675
|
operationContext?: string;
|
|
1676
|
+
/** Contains the resulting SIP code, sub-code and message. */
|
|
1677
|
+
resultInformation?: RestResultInformation;
|
|
1909
1678
|
}
|
|
1910
1679
|
|
|
1911
1680
|
export declare interface RestRecognizeCompleted {
|
|
@@ -1969,6 +1738,8 @@ export declare interface RestRecordingStateChanged {
|
|
|
1969
1738
|
*/
|
|
1970
1739
|
readonly startDateTime?: Date;
|
|
1971
1740
|
recordingKind?: RecordingKind_2;
|
|
1741
|
+
/** Contains the resulting SIP code, sub-code and message. */
|
|
1742
|
+
resultInformation?: RestResultInformation;
|
|
1972
1743
|
}
|
|
1973
1744
|
|
|
1974
1745
|
/** The failed to remove participant event. */
|
|
@@ -2038,138 +1809,6 @@ export declare interface RestSendDtmfTonesFailed {
|
|
|
2038
1809
|
resultInformation?: RestResultInformation;
|
|
2039
1810
|
}
|
|
2040
1811
|
|
|
2041
|
-
export declare interface RestTranscriptionFailed {
|
|
2042
|
-
/**
|
|
2043
|
-
* Used by customers when calling mid-call actions to correlate the request to the response event.
|
|
2044
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2045
|
-
*/
|
|
2046
|
-
readonly operationContext?: string;
|
|
2047
|
-
/**
|
|
2048
|
-
* Contains the resulting SIP code, sub-code and message.
|
|
2049
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2050
|
-
*/
|
|
2051
|
-
readonly resultInformation?: RestResultInformation;
|
|
2052
|
-
/**
|
|
2053
|
-
* Defines the result for TranscriptionUpdate with the current status and the details about the status
|
|
2054
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2055
|
-
*/
|
|
2056
|
-
readonly transcriptionUpdate?: TranscriptionUpdate;
|
|
2057
|
-
/**
|
|
2058
|
-
* Call connection ID.
|
|
2059
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2060
|
-
*/
|
|
2061
|
-
readonly callConnectionId?: string;
|
|
2062
|
-
/**
|
|
2063
|
-
* Server call ID.
|
|
2064
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2065
|
-
*/
|
|
2066
|
-
readonly serverCallId?: string;
|
|
2067
|
-
/**
|
|
2068
|
-
* Correlation ID for event to call correlation. Also called ChainId for skype chain ID.
|
|
2069
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2070
|
-
*/
|
|
2071
|
-
readonly correlationId?: string;
|
|
2072
|
-
}
|
|
2073
|
-
|
|
2074
|
-
export declare interface RestTranscriptionStarted {
|
|
2075
|
-
/**
|
|
2076
|
-
* Used by customers when calling mid-call actions to correlate the request to the response event.
|
|
2077
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2078
|
-
*/
|
|
2079
|
-
readonly operationContext?: string;
|
|
2080
|
-
/**
|
|
2081
|
-
* Contains the resulting SIP code, sub-code and message.
|
|
2082
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2083
|
-
*/
|
|
2084
|
-
readonly resultInformation?: RestResultInformation;
|
|
2085
|
-
/**
|
|
2086
|
-
* Defines the result for TranscriptionUpdate with the current status and the details about the status
|
|
2087
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2088
|
-
*/
|
|
2089
|
-
readonly transcriptionUpdate?: TranscriptionUpdate;
|
|
2090
|
-
/**
|
|
2091
|
-
* Call connection ID.
|
|
2092
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2093
|
-
*/
|
|
2094
|
-
readonly callConnectionId?: string;
|
|
2095
|
-
/**
|
|
2096
|
-
* Server call ID.
|
|
2097
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2098
|
-
*/
|
|
2099
|
-
readonly serverCallId?: string;
|
|
2100
|
-
/**
|
|
2101
|
-
* Correlation ID for event to call correlation. Also called ChainId for skype chain ID.
|
|
2102
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2103
|
-
*/
|
|
2104
|
-
readonly correlationId?: string;
|
|
2105
|
-
}
|
|
2106
|
-
|
|
2107
|
-
export declare interface RestTranscriptionStopped {
|
|
2108
|
-
/**
|
|
2109
|
-
* Used by customers when calling mid-call actions to correlate the request to the response event.
|
|
2110
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2111
|
-
*/
|
|
2112
|
-
readonly operationContext?: string;
|
|
2113
|
-
/**
|
|
2114
|
-
* Contains the resulting SIP code, sub-code and message.
|
|
2115
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2116
|
-
*/
|
|
2117
|
-
readonly resultInformation?: RestResultInformation;
|
|
2118
|
-
/**
|
|
2119
|
-
* Defines the result for TranscriptionUpdate with the current status and the details about the status
|
|
2120
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2121
|
-
*/
|
|
2122
|
-
readonly transcriptionUpdate?: TranscriptionUpdate;
|
|
2123
|
-
/**
|
|
2124
|
-
* Call connection ID.
|
|
2125
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2126
|
-
*/
|
|
2127
|
-
readonly callConnectionId?: string;
|
|
2128
|
-
/**
|
|
2129
|
-
* Server call ID.
|
|
2130
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2131
|
-
*/
|
|
2132
|
-
readonly serverCallId?: string;
|
|
2133
|
-
/**
|
|
2134
|
-
* Correlation ID for event to call correlation. Also called ChainId for skype chain ID.
|
|
2135
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2136
|
-
*/
|
|
2137
|
-
readonly correlationId?: string;
|
|
2138
|
-
}
|
|
2139
|
-
|
|
2140
|
-
export declare interface RestTranscriptionUpdated {
|
|
2141
|
-
/**
|
|
2142
|
-
* Used by customers when calling mid-call actions to correlate the request to the response event.
|
|
2143
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2144
|
-
*/
|
|
2145
|
-
readonly operationContext?: string;
|
|
2146
|
-
/**
|
|
2147
|
-
* Contains the resulting SIP code, sub-code and message.
|
|
2148
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2149
|
-
*/
|
|
2150
|
-
readonly resultInformation?: RestResultInformation;
|
|
2151
|
-
/**
|
|
2152
|
-
* Defines the result for TranscriptionUpdate with the current status and the details about the status
|
|
2153
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2154
|
-
*/
|
|
2155
|
-
readonly transcriptionUpdate?: TranscriptionUpdate;
|
|
2156
|
-
/**
|
|
2157
|
-
* Call connection ID.
|
|
2158
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2159
|
-
*/
|
|
2160
|
-
readonly callConnectionId?: string;
|
|
2161
|
-
/**
|
|
2162
|
-
* Server call ID.
|
|
2163
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2164
|
-
*/
|
|
2165
|
-
readonly serverCallId?: string;
|
|
2166
|
-
/**
|
|
2167
|
-
* Correlation ID for event to call correlation. Also called ChainId for skype chain ID.
|
|
2168
|
-
* NOTE: This property will not be serialized. It can only be populated by the server.
|
|
2169
|
-
*/
|
|
2170
|
-
readonly correlationId?: string;
|
|
2171
|
-
}
|
|
2172
|
-
|
|
2173
1812
|
export declare interface ResultInformation extends Omit<RestResultInformation, "code" | "subCode" | "message"> {
|
|
2174
1813
|
/** The error code. */
|
|
2175
1814
|
code: number;
|
|
@@ -2254,17 +1893,6 @@ export declare interface SsmlSource extends PlaySource {
|
|
|
2254
1893
|
readonly kind: "ssmlSource";
|
|
2255
1894
|
}
|
|
2256
1895
|
|
|
2257
|
-
/** Options for start media streaming request. */
|
|
2258
|
-
export declare interface StartMediaStreamingOptions extends OperationOptions {
|
|
2259
|
-
/**
|
|
2260
|
-
* Set a callback URL that overrides the default callback URI set by CreateCall/AnswerCall for this operation.
|
|
2261
|
-
* This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
|
|
2262
|
-
*/
|
|
2263
|
-
operationCallbackUrl?: string;
|
|
2264
|
-
/** The value to identify context of the operation. */
|
|
2265
|
-
operationContext?: string;
|
|
2266
|
-
}
|
|
2267
|
-
|
|
2268
1896
|
/**
|
|
2269
1897
|
* Options to get a start a recording.
|
|
2270
1898
|
*/
|
|
@@ -2298,53 +1926,11 @@ export declare interface StartRecordingOptions extends OperationOptions {
|
|
|
2298
1926
|
channelAffinity?: ChannelAffinity[];
|
|
2299
1927
|
}
|
|
2300
1928
|
|
|
2301
|
-
/**
|
|
2302
|
-
* Options to start transcription
|
|
2303
|
-
*/
|
|
2304
|
-
export declare interface StartTranscriptionOptions extends OperationOptions {
|
|
2305
|
-
/** Defines Locale for the transcription e,g en-US */
|
|
2306
|
-
locale?: string;
|
|
2307
|
-
/** The value to identify context of the operation. */
|
|
2308
|
-
operationContext?: string;
|
|
2309
|
-
/** Endpoint where the custom model was deployed. */
|
|
2310
|
-
speechRecognitionModelEndpointId?: string;
|
|
2311
|
-
}
|
|
2312
|
-
|
|
2313
|
-
/** Options for stop media streaming request. */
|
|
2314
|
-
export declare interface StopMediaStreamingOptions extends OperationOptions {
|
|
2315
|
-
/**
|
|
2316
|
-
* Set a callback URL that overrides the default callback URI set by CreateCall/AnswerCall for this operation.
|
|
2317
|
-
* This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
|
|
2318
|
-
*/
|
|
2319
|
-
operationCallbackUrl?: string;
|
|
2320
|
-
/** The value to identify context of the operation. */
|
|
2321
|
-
operationContext?: string;
|
|
2322
|
-
}
|
|
2323
|
-
|
|
2324
1929
|
/**
|
|
2325
1930
|
* Options to get a stop a recording.
|
|
2326
1931
|
*/
|
|
2327
1932
|
export declare type StopRecordingOptions = OperationOptions;
|
|
2328
1933
|
|
|
2329
|
-
/**
|
|
2330
|
-
* Options to stop transcription
|
|
2331
|
-
*/
|
|
2332
|
-
export declare interface StopTranscriptionOptions extends OperationOptions {
|
|
2333
|
-
/** The value to identify context of the operation. */
|
|
2334
|
-
operationContext?: string;
|
|
2335
|
-
}
|
|
2336
|
-
|
|
2337
|
-
/** Parse the incoming package. */
|
|
2338
|
-
export declare function streamingData(packetData: string | ArrayBuffer): TranscriptionMetadata | TranscriptionData | AudioData | AudioMetadata;
|
|
2339
|
-
|
|
2340
|
-
/**
|
|
2341
|
-
* The format of transcription text.
|
|
2342
|
-
*/
|
|
2343
|
-
export declare enum TextFormat {
|
|
2344
|
-
/** Formatted recognize text with punctuations.*/
|
|
2345
|
-
Display = "display"
|
|
2346
|
-
}
|
|
2347
|
-
|
|
2348
1934
|
/** The TextSource model. */
|
|
2349
1935
|
export declare interface TextSource extends PlaySource {
|
|
2350
1936
|
text: string;
|
|
@@ -2379,192 +1965,6 @@ export declare interface TextSource extends PlaySource {
|
|
|
2379
1965
|
*/
|
|
2380
1966
|
export declare type Tone = string;
|
|
2381
1967
|
|
|
2382
|
-
/**
|
|
2383
|
-
* Streaming Transcription.
|
|
2384
|
-
*/
|
|
2385
|
-
export declare interface TranscriptionData {
|
|
2386
|
-
/** The display form of the recognized word.*/
|
|
2387
|
-
text: string;
|
|
2388
|
-
/** The format of text.*/
|
|
2389
|
-
format: TextFormat;
|
|
2390
|
-
/** Confidence of recognition of the whole phrase, from 0.0 (no confidence) to 1.0 (full confidence). */
|
|
2391
|
-
confidence: number;
|
|
2392
|
-
/** The position of this payload. 1 tick = 100 nanoseconds. */
|
|
2393
|
-
offsetInTicks: number;
|
|
2394
|
-
/** Duration in ticks. 1 tick = 100 nanoseconds. */
|
|
2395
|
-
durationInTicks: number;
|
|
2396
|
-
/** The result for each word of the phrase. */
|
|
2397
|
-
words: WordData[];
|
|
2398
|
-
/** The identified speaker based on participant raw ID. */
|
|
2399
|
-
participant: CommunicationIdentifier;
|
|
2400
|
-
/** State of the result of transcription. */
|
|
2401
|
-
resultState: TranscriptionResultState;
|
|
2402
|
-
}
|
|
2403
|
-
|
|
2404
|
-
export declare interface TranscriptionFailed extends Omit<RestTranscriptionFailed, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
2405
|
-
/** Call connection ID. */
|
|
2406
|
-
callConnectionId: string;
|
|
2407
|
-
/** Server call ID. */
|
|
2408
|
-
serverCallId: string;
|
|
2409
|
-
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
2410
|
-
correlationId: string;
|
|
2411
|
-
/** Contains the resulting SIP code, sub-code and message. */
|
|
2412
|
-
resultInformation?: RestResultInformation;
|
|
2413
|
-
/** kind of this event. */
|
|
2414
|
-
kind: "TranscriptionFailed";
|
|
2415
|
-
}
|
|
2416
|
-
|
|
2417
|
-
/**
|
|
2418
|
-
* Metadata for Transcription Streaming.
|
|
2419
|
-
*/
|
|
2420
|
-
export declare interface TranscriptionMetadata {
|
|
2421
|
-
/** Transcription Subscription Id.*/
|
|
2422
|
-
subscriptionId: string;
|
|
2423
|
-
/** The target locale in which the translated text needs to be.*/
|
|
2424
|
-
locale: string;
|
|
2425
|
-
/** call connection Id.*/
|
|
2426
|
-
callConnectionId: string;
|
|
2427
|
-
/** correlation Id.*/
|
|
2428
|
-
correlationId: string;
|
|
2429
|
-
}
|
|
2430
|
-
|
|
2431
|
-
/** Configuration of live transcription. */
|
|
2432
|
-
export declare interface TranscriptionOptions {
|
|
2433
|
-
/** Transport URL for live transcription */
|
|
2434
|
-
transportUrl: string;
|
|
2435
|
-
/** The type of transport to be used for live transcription, eg. Websocket */
|
|
2436
|
-
transportType: TranscriptionTransportType;
|
|
2437
|
-
/** Defines the locale for the data e.g en-CA, en-AU */
|
|
2438
|
-
locale: string;
|
|
2439
|
-
/** Endpoint where the custom model was deployed. */
|
|
2440
|
-
speechRecognitionModelEndpointId?: string;
|
|
2441
|
-
/** Determines if the transcription should be started immediately after call is answered or not. */
|
|
2442
|
-
startTranscription: boolean;
|
|
2443
|
-
/** Enables intermediate results for the transcribed speech. */
|
|
2444
|
-
enableIntermediateResults?: boolean;
|
|
2445
|
-
}
|
|
2446
|
-
|
|
2447
|
-
/**
|
|
2448
|
-
* Defines values for TranscriptionResultState. \
|
|
2449
|
-
* {@link KnownTranscriptionResultState} can be used interchangeably with TranscriptionResultState,
|
|
2450
|
-
* this enum contains the known values that the service supports.
|
|
2451
|
-
* ### Known values supported by the service
|
|
2452
|
-
* **final** \
|
|
2453
|
-
* **intermediate**
|
|
2454
|
-
*/
|
|
2455
|
-
declare type TranscriptionResultState = string;
|
|
2456
|
-
|
|
2457
|
-
export declare interface TranscriptionStarted extends Omit<RestTranscriptionStarted, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
2458
|
-
/** Call connection ID. */
|
|
2459
|
-
callConnectionId: string;
|
|
2460
|
-
/** Server call ID. */
|
|
2461
|
-
serverCallId: string;
|
|
2462
|
-
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
2463
|
-
correlationId: string;
|
|
2464
|
-
/** Contains the resulting SIP code, sub-code and message. */
|
|
2465
|
-
resultInformation?: RestResultInformation;
|
|
2466
|
-
/** kind of this event. */
|
|
2467
|
-
kind: "TranscriptionStarted";
|
|
2468
|
-
}
|
|
2469
|
-
|
|
2470
|
-
/**
|
|
2471
|
-
* Defines values for TranscriptionStatus. \
|
|
2472
|
-
* {@link KnownTranscriptionStatus} can be used interchangeably with TranscriptionStatus,
|
|
2473
|
-
* this enum contains the known values that the service supports.
|
|
2474
|
-
* ### Known values supported by the service
|
|
2475
|
-
* **transcriptionStarted** \
|
|
2476
|
-
* **transcriptionFailed** \
|
|
2477
|
-
* **transcriptionResumed** \
|
|
2478
|
-
* **transcriptionUpdated** \
|
|
2479
|
-
* **transcriptionStopped** \
|
|
2480
|
-
* **unspecifiedError**
|
|
2481
|
-
*/
|
|
2482
|
-
declare type TranscriptionStatus = string;
|
|
2483
|
-
|
|
2484
|
-
/**
|
|
2485
|
-
* Defines values for TranscriptionStatusDetails. \
|
|
2486
|
-
* {@link KnownTranscriptionStatusDetails} can be used interchangeably with TranscriptionStatusDetails,
|
|
2487
|
-
* this enum contains the known values that the service supports.
|
|
2488
|
-
* ### Known values supported by the service
|
|
2489
|
-
* **subscriptionStarted** \
|
|
2490
|
-
* **streamConnectionReestablished** \
|
|
2491
|
-
* **streamConnectionUnsuccessful** \
|
|
2492
|
-
* **streamUrlMissing** \
|
|
2493
|
-
* **serviceShutdown** \
|
|
2494
|
-
* **streamConnectionInterrupted** \
|
|
2495
|
-
* **speechServicesConnectionError** \
|
|
2496
|
-
* **subscriptionStopped** \
|
|
2497
|
-
* **unspecifiedError** \
|
|
2498
|
-
* **authenticationFailure** \
|
|
2499
|
-
* **badRequest** \
|
|
2500
|
-
* **tooManyRequests** \
|
|
2501
|
-
* **forbidden** \
|
|
2502
|
-
* **serviceTimeout** \
|
|
2503
|
-
* **transcriptionLocaleUpdated**
|
|
2504
|
-
*/
|
|
2505
|
-
declare type TranscriptionStatusDetails = string;
|
|
2506
|
-
|
|
2507
|
-
export declare interface TranscriptionStopped extends Omit<RestTranscriptionStopped, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
2508
|
-
/** Call connection ID. */
|
|
2509
|
-
callConnectionId: string;
|
|
2510
|
-
/** Server call ID. */
|
|
2511
|
-
serverCallId: string;
|
|
2512
|
-
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
2513
|
-
correlationId: string;
|
|
2514
|
-
/** Contains the resulting SIP code, sub-code and message. */
|
|
2515
|
-
resultInformation?: RestResultInformation;
|
|
2516
|
-
/** kind of this event. */
|
|
2517
|
-
kind: "TranscriptionStopped";
|
|
2518
|
-
}
|
|
2519
|
-
|
|
2520
|
-
/** Transcription Subscription Object. */
|
|
2521
|
-
export declare interface TranscriptionSubscription {
|
|
2522
|
-
/** Subscription Id. */
|
|
2523
|
-
id?: string;
|
|
2524
|
-
/** Transcription subscription state. */
|
|
2525
|
-
state?: TranscriptionSubscriptionState;
|
|
2526
|
-
/** Subscribed transcription result types. */
|
|
2527
|
-
subscribedResultStates?: TranscriptionResultState[];
|
|
2528
|
-
}
|
|
2529
|
-
|
|
2530
|
-
/**
|
|
2531
|
-
* Defines values for TranscriptionSubscriptionState. \
|
|
2532
|
-
* {@link KnownTranscriptionSubscriptionState} can be used interchangeably with TranscriptionSubscriptionState,
|
|
2533
|
-
* this enum contains the known values that the service supports.
|
|
2534
|
-
* ### Known values supported by the service
|
|
2535
|
-
* **disabled** \
|
|
2536
|
-
* **inactive** \
|
|
2537
|
-
* **active**
|
|
2538
|
-
*/
|
|
2539
|
-
declare type TranscriptionSubscriptionState = string;
|
|
2540
|
-
|
|
2541
|
-
/**
|
|
2542
|
-
* Defines values for TranscriptionTransportType. \
|
|
2543
|
-
* {@link KnownTranscriptionTransportType} can be used interchangeably with TranscriptionTransportType,
|
|
2544
|
-
* this enum contains the known values that the service supports.
|
|
2545
|
-
* ### Known values supported by the service
|
|
2546
|
-
* **websocket**
|
|
2547
|
-
*/
|
|
2548
|
-
export declare type TranscriptionTransportType = string;
|
|
2549
|
-
|
|
2550
|
-
declare interface TranscriptionUpdate {
|
|
2551
|
-
transcriptionStatus?: TranscriptionStatus;
|
|
2552
|
-
transcriptionStatusDetails?: TranscriptionStatusDetails;
|
|
2553
|
-
}
|
|
2554
|
-
|
|
2555
|
-
export declare interface TranscriptionUpdated extends Omit<RestTranscriptionUpdated, "callConnectionId" | "serverCallId" | "correlationId" | "resultInformation"> {
|
|
2556
|
-
/** Call connection ID. */
|
|
2557
|
-
callConnectionId: string;
|
|
2558
|
-
/** Server call ID. */
|
|
2559
|
-
serverCallId: string;
|
|
2560
|
-
/** Correlation ID for event to call correlation. Also called ChainId for skype chain ID. */
|
|
2561
|
-
correlationId: string;
|
|
2562
|
-
/** Contains the resulting SIP code, sub-code and message. */
|
|
2563
|
-
resultInformation?: RestResultInformation;
|
|
2564
|
-
/** kind of this event. */
|
|
2565
|
-
kind: "TranscriptionUpdated";
|
|
2566
|
-
}
|
|
2567
|
-
|
|
2568
1968
|
/** The response payload for transferring the call. */
|
|
2569
1969
|
export declare interface TransferCallResult {
|
|
2570
1970
|
/** The operation context provided by client. */
|
|
@@ -2598,16 +1998,6 @@ export declare interface UnholdOptions extends OperationOptions {
|
|
|
2598
1998
|
operationContext?: string;
|
|
2599
1999
|
}
|
|
2600
2000
|
|
|
2601
|
-
/**
|
|
2602
|
-
* Options to update transcription
|
|
2603
|
-
*/
|
|
2604
|
-
export declare interface UpdateTranscriptionOptions extends OperationOptions {
|
|
2605
|
-
/** Endpoint where the custom model was deployed. */
|
|
2606
|
-
speechRecognitionModelEndpointId?: string;
|
|
2607
|
-
/** The value to identify context of the operation. */
|
|
2608
|
-
operationContext?: string;
|
|
2609
|
-
}
|
|
2610
|
-
|
|
2611
2001
|
/** Defines values for VoiceKind that the service accepts. */
|
|
2612
2002
|
export declare enum VoiceKind {
|
|
2613
2003
|
/** Male */
|
|
@@ -2621,16 +2011,4 @@ export declare interface VoipHeader extends CustomCallingContextHeader {
|
|
|
2621
2011
|
kind: "voip";
|
|
2622
2012
|
}
|
|
2623
2013
|
|
|
2624
|
-
/**
|
|
2625
|
-
* Text in the phrase.
|
|
2626
|
-
*/
|
|
2627
|
-
export declare interface WordData {
|
|
2628
|
-
/** Text in the phrase.*/
|
|
2629
|
-
text: string;
|
|
2630
|
-
/** The word's position within the phrase.*/
|
|
2631
|
-
offsetInTicks: number;
|
|
2632
|
-
/** Duration in ticks. 1 tick = 100 nanoseconds.*/
|
|
2633
|
-
durationInTicks: number;
|
|
2634
|
-
}
|
|
2635
|
-
|
|
2636
2014
|
export { }
|