From 17a88dbcdc4c01f3a756a0604ec458e2df52cd1f Mon Sep 17 00:00:00 2001 From: Amari West Date: Thu, 5 Oct 2023 18:44:23 -0500 Subject: [PATCH 01/20] generated files using swagger --- .../src/CallRecording.cs | 2 + .../src/Generated/CallConnectionRestClient.cs | 4 +- ...lRecordingRequestInternal.Serialization.cs | 5 + .../StartCallRecordingRequestInternal.cs | 2 + .../src/Models/StartRecordingOptions.cs | 5 + .../src/SwaggerPauseOnStart.json | 4135 +++++++++++++++++ .../src/autorest.md | 2 +- 7 files changed, 4152 insertions(+), 3 deletions(-) create mode 100644 sdk/communication/Azure.Communication.CallAutomation/src/SwaggerPauseOnStart.json diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/CallRecording.cs b/sdk/communication/Azure.Communication.CallAutomation/src/CallRecording.cs index b75ace67fe1a2..0bc3dde7c40d6 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/CallRecording.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/CallRecording.cs @@ -62,6 +62,7 @@ public virtual Response Start(StartRecordingOptions option RecordingChannelType = options.RecordingChannel, RecordingContentType = options.RecordingContent, RecordingFormatType = options.RecordingFormat, + PauseOnStart = options.PauseOnStart, }; if (options.AudioChannelParticipantOrdering != null && options.AudioChannelParticipantOrdering.Any()) @@ -119,6 +120,7 @@ public virtual async Task> StartAsync(StartRecord RecordingChannelType = options.RecordingChannel, RecordingContentType = options.RecordingContent, RecordingFormatType = options.RecordingFormat, + PauseOnStart = options.PauseOnStart, }; if (options.AudioChannelParticipantOrdering != null && options.AudioChannelParticipantOrdering.Any()) diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs index abbaf4191c22e..d15dd650db108 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs @@ -598,7 +598,7 @@ public async Task> MuteAsync(string callConnect await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); switch (message.Response.Status) { - case 202: + case 200: { MuteParticipantsResult value = default; using var document = await JsonDocument.ParseAsync(message.Response.ContentStream, default, cancellationToken).ConfigureAwait(false); @@ -630,7 +630,7 @@ public Response Mute(string callConnectionId, MutePartic _pipeline.Send(message, cancellationToken); switch (message.Response.Status) { - case 202: + case 200: { MuteParticipantsResult value = default; using var document = JsonDocument.Parse(message.Response.ContentStream); diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/StartCallRecordingRequestInternal.Serialization.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/StartCallRecordingRequestInternal.Serialization.cs index 233a426655f40..9e9a7a4cdc9ed 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/StartCallRecordingRequestInternal.Serialization.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/StartCallRecordingRequestInternal.Serialization.cs @@ -62,6 +62,11 @@ void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) writer.WritePropertyName("externalStorage"u8); writer.WriteObjectValue(ExternalStorage); } + if (Optional.IsDefined(PauseOnStart)) + { + writer.WritePropertyName("pauseOnStart"u8); + writer.WriteBooleanValue(PauseOnStart.Value); + } writer.WriteEndObject(); } } diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/StartCallRecordingRequestInternal.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/StartCallRecordingRequestInternal.cs index f6339c95c77a8..075434a3609ed 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/StartCallRecordingRequestInternal.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/StartCallRecordingRequestInternal.cs @@ -53,5 +53,7 @@ public StartCallRecordingRequestInternal(CallLocatorInternal callLocator) public IList ChannelAffinity { get; } /// Optional property to specify location where recording will be stored. public ExternalStorageInternal ExternalStorage { get; set; } + /// When set to true will start recording in Pause mode, which could be resumed. + public bool? PauseOnStart { get; set; } } } diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Models/StartRecordingOptions.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Models/StartRecordingOptions.cs index a2b92901a3850..f5f26ea926920 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Models/StartRecordingOptions.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Models/StartRecordingOptions.cs @@ -45,6 +45,11 @@ public StartRecordingOptions(CallLocator callLocator) /// public RecordingFormat RecordingFormat { get; set; } + /// + /// The pause on start option. + /// + public bool PauseOnStart { get; set; } + /// /// The sequential order in which audio channels are assigned to participants in the unmixed recording. /// When 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering is not specified, diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/SwaggerPauseOnStart.json b/sdk/communication/Azure.Communication.CallAutomation/src/SwaggerPauseOnStart.json new file mode 100644 index 0000000000000..c2ceb7cd8ee8d --- /dev/null +++ b/sdk/communication/Azure.Communication.CallAutomation/src/SwaggerPauseOnStart.json @@ -0,0 +1,4135 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-01-15-preview", + "title": "Azure Communication Service Call Automation APIs", + "description": "Azure Communication Service Call Automation APIs" + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/calling/callConnections": { + "post": { + "tags": [ + "PreConnections" + ], + "summary": "Create an outbound call.", + "description": "Create an outbound call.", + "operationId": "CreateCall", + "parameters": [ + { + "name": "createCallRequest", + "in": "body", + "description": "The create call request.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateCallRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "201": { + "description": "Returns details of the call properties once the CreateCall request is received by service. You will receive CallConnected event at your specified callback URI, once the call is connected.", + "schema": { + "$ref": "#/definitions/CallConnectionProperties" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CreateCall": { + "$ref": "./examples/CreateCall.json" + } + } + } + }, + "/calling/callConnections:answer": { + "post": { + "tags": [ + "PreConnections" + ], + "summary": "Answer a Call.", + "description": "Answer a call using the IncomingCallContext from Event Grid.", + "operationId": "AnswerCall", + "parameters": [ + { + "name": "answerCallRequest", + "in": "body", + "description": "The answer call request.", + "required": true, + "schema": { + "$ref": "#/definitions/AnswerCallRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "200": { + "description": "Returns details of the call properties once the AnswerCall request is received by service. You will receive CallConnected event at your specified callback URI, once the call is connected.", + "schema": { + "$ref": "#/definitions/CallConnectionProperties" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "AnswerCall": { + "$ref": "./examples/AnswerCall.json" + } + } + } + }, + "/calling/callConnections:redirect": { + "post": { + "tags": [ + "PreConnections" + ], + "summary": "Redirect a call.", + "description": "Redirect a call.", + "operationId": "RedirectCall", + "parameters": [ + { + "name": "redirectCallRequest", + "in": "body", + "description": "The redirect call request.", + "required": true, + "schema": { + "$ref": "#/definitions/RedirectCallRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "204": { + "description": "The service has redirected the call to specified endpoint." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "RedirectCall": { + "$ref": "./examples/RedirectCall.json" + } + } + } + }, + "/calling/callConnections:reject": { + "post": { + "tags": [ + "PreConnections" + ], + "summary": "Reject the call.", + "description": "Reject the call.", + "operationId": "RejectCall", + "parameters": [ + { + "name": "rejectCallRequest", + "in": "body", + "description": "The reject call request.", + "required": true, + "schema": { + "$ref": "#/definitions/RejectCallRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "204": { + "description": "The service has rejected the call." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "RejectCall": { + "$ref": "./examples/RejectCall.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}": { + "get": { + "tags": [ + "MidConnections" + ], + "summary": "Get call connection.", + "operationId": "CallConnection_GetCall", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns details of the call properties.", + "schema": { + "$ref": "#/definitions/CallConnectionProperties" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_GetCall": { + "$ref": "./examples/CallConnection_GetCall.json" + } + } + }, + "delete": { + "tags": [ + "MidConnections" + ], + "summary": "Hangup the call.", + "description": "Hangup the call.", + "operationId": "CallConnection_HangupCall", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Call automation service has left the call." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_HangupCall": { + "$ref": "./examples/CallConnection_HangupCall.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:terminate": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Terminate a call using CallConnectionId.", + "description": "Terminate a call using CallConnectionId.", + "operationId": "CallConnection_TerminateCall", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The terminate call request.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "204": { + "description": "The call is terminated." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_TerminateCall": { + "$ref": "./examples/CallConnection_TerminateCall.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:transferToParticipant": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Transfer the call to a participant.", + "description": "Transfer the call to a participant.", + "operationId": "CallConnection_TransferToParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "transferToParticipantRequest", + "in": "body", + "description": "The transfer to participant request.", + "required": true, + "schema": { + "$ref": "#/definitions/TransferToParticipantRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "202": { + "description": "The service has accepted the transfer request and will begin processing it. You will receive either CallTransferAccepted or CallTransferFailed event at your specified callback URI to update you on the status of the request.", + "schema": { + "$ref": "#/definitions/TransferCallResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_TransferToParticipant": { + "$ref": "./examples/CallConnection_TransferToParticipant.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:play": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Plays audio to participants in the call.", + "description": "Plays audio to participants in the call.", + "operationId": "CallMedia_Play", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "playRequest", + "in": "body", + "description": "play request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/PlayRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The service has accepted the play request and will begin processing it. You will receive either PlayCompleted or PlayFailed event at your specified callback URI to update you on the status of the request." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallMedia_Play": { + "$ref": "./examples/CallMedia_Play.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:StartTranscription": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Starts transcription in the call", + "description": "Starts transcription in the call", + "operationId": "CallMedia_StartTranscription", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "startTranscriptionRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StartTranscriptionRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The service has accepted the start transcription request and will begin processing it. You will receive either TranscriptionStarted or TranscriptionFailed event at your specified callback URI to update you on the status of the request." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallMedia_StartTranscription": { + "$ref": "./examples/CallMedia_StartTranscription.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:StopTranscription": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Stops transcription in the call.", + "description": "Stops transcription in the call.", + "operationId": "CallMedia_StopTranscription", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "stopTranscriptionRequest", + "in": "body", + "description": "stop transcription request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/StopTranscriptionRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The service has accepted the stop transcription request and will begin processing it. You will receive either TrannscriptionStopped event at your specified callback URI to update you on the status of the request." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallMedia_StopTranscription": { + "$ref": "./examples/CallMedia_StopTranscription.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:cancelAllMediaOperations": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Cancel all media operations in a call.", + "description": "Cancel all media operations in a call.", + "operationId": "CallMedia_CancelAllMediaOperations", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The service has accepted the cancel request and will begin processing it. RecognizeCanceled and/or PlayCanceled at your specified callback URI to update you on the status of the request, based on which media operation has been canceled by it." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallMedia_CancelAllMediaOperations": { + "$ref": "./examples/CallMedia_CancelAllMediaOperations.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:recognize": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Recognize media from call.", + "description": "Recognize media from call.", + "operationId": "CallMedia_Recognize", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "recognizeRequest", + "in": "body", + "description": "The media recognize request", + "required": true, + "schema": { + "$ref": "#/definitions/RecognizeRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The service has accepted the recognize request and will begin processing it. You will receive either RecognizeCompleted or RecognizeFailed event at your specified callback URI to update you on the status of the request." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallMedia_Recognize": { + "$ref": "./examples/CallMedia_Recognize.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:startContinuousDtmfRecognition": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Start continuous Dtmf recognition by subscribing to tones.", + "operationId": "CallMedia_StartContinuousDtmfRecognition", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "continuousDtmfRecognitionRequest", + "in": "body", + "description": "The continuous recognize request", + "required": true, + "schema": { + "$ref": "#/definitions/ContinuousDtmfRecognitionRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The service has accepted the start continuous recognize request and will begin processing it. You will receive events at your specified callback URI to update you on the status of the request." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallMedia_StartContinuousDtmfRecognition": { + "$ref": "./examples/CallMedia_StartContinuousDtmfRecognition.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:stopContinuousDtmfRecognition": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Stop continuous Dtmf recognition by unsubscribing to tones.", + "operationId": "CallMedia_StopContinuousDtmfRecognition", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "continuousDtmfRecognitionRequest", + "in": "body", + "description": "The continuous recognize request", + "required": true, + "schema": { + "$ref": "#/definitions/ContinuousDtmfRecognitionRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The service has accepted the stop continuous recognize request and will begin processing it. You will receive events at your specified callback URI to update you on the status of the request." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallMedia_StopContinuousDtmfRecognition": { + "$ref": "./examples/CallMedia_StopContinuousDtmfRecognition.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:sendDtmf": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Send dtmf tones.", + "description": "Send dtmf tones.", + "operationId": "CallMedia_SendDtmf", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "sendDtmfRequest", + "in": "body", + "description": "The send dtmf request", + "required": true, + "schema": { + "$ref": "#/definitions/SendDtmfRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Returns the send dtmf response" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallMedia_SendDtmf": { + "$ref": "./examples/CallMedia_SendDtmf.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}:updateTranscriptionData": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "UpdateTranscriptionData Api.", + "description": "API to change transcription language.", + "operationId": "CallMedia_UpdateTranscriptionData", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "updateTranscriptionDataRequest", + "in": "body", + "description": "The updateTranscriptionData request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateTranscriptionDataRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Returns the update transcription data response" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallMedia_UpdateTranscriptionData": { + "$ref": "./examples/CallMedia_UpdateTranscriptionData.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/dialogs/{dialogId}": { + "put": { + "tags": [ + "MidConnections" + ], + "summary": "Start a dialog targeting a particular participant on the call.", + "description": "Start a dialog.", + "operationId": "CallDialog_StartDialog", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "dialogId", + "in": "path", + "description": "The dialog id", + "required": true, + "type": "string" + }, + { + "name": "startDialogRequest", + "in": "body", + "description": "The start dialog request", + "required": true, + "schema": { + "$ref": "#/definitions/StartDialogRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Returns the start dialog response.", + "schema": { + "$ref": "#/definitions/DialogStateResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallDialog_StartDialog": { + "$ref": "./examples/CallDialog_StartDialog.json" + } + } + }, + "delete": { + "tags": [ + "MidConnections" + ], + "summary": "Stop a dialog.", + "description": "Stop a dialog.", + "operationId": "CallDialog_StopDialog", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id", + "required": true, + "type": "string" + }, + { + "name": "dialogId", + "in": "path", + "description": "The dialog id", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Returns no content for stop dialog response." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallDialog_StopDialog": { + "$ref": "./examples/CallDialog_StopDialog.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants": { + "get": { + "tags": [ + "MidConnections" + ], + "summary": "Get participants from a call. Recording and transcription bots are omitted from this list.", + "description": "Get participants from a call. Recording and transcription bots are omitted from this list.", + "operationId": "CallConnection_GetParticipants", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection Id", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns the get participants response.", + "schema": { + "$ref": "#/definitions/GetParticipantsResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_GetParticipants": { + "$ref": "./examples/CallConnection_GetParticipants.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "values" + } + } + }, + "/calling/callConnections/{callConnectionId}/participants:add": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Add participants to the call.", + "description": "Add participants to the call.", + "operationId": "CallConnection_AddParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection Id", + "required": true, + "type": "string" + }, + { + "name": "addParticipantRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AddParticipantRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "202": { + "description": "The service has accepted the add participant request and will begin processing it. You will receive either AddParticipantSucceeded or AddParticipantFailed event at your specified callback URI to update you on the status of the request.", + "schema": { + "$ref": "#/definitions/AddParticipantResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_AddParticipant": { + "$ref": "./examples/CallConnection_AddParticipant.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants:remove": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Remove participant from the call using identifier.", + "description": "Remove participant from the call using identifier.", + "operationId": "CallConnection_RemoveParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "removeParticipantRequest", + "in": "body", + "description": "The participant to be removed from the call.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveParticipantRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "202": { + "description": "The service has accepted the remove participant request and will begin processing it. You will receive either RemoveParticipantSucceeded or RemoveParticipantFailed event at your specified callback URI to update you on the status of the request.", + "schema": { + "$ref": "#/definitions/RemoveParticipantResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_RemoveParticipant": { + "$ref": "./examples/CallConnection_RemoveParticipant.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants:mute": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Mute participants from the call using identifier.", + "description": "Mute participants from the call using identifier.", + "operationId": "CallConnection_Mute", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "muteParticipantsRequest", + "in": "body", + "description": "The participants to be muted from the call.", + "required": true, + "schema": { + "$ref": "#/definitions/MuteParticipantsRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "202": { + "description": "Returns the mute participants response", + "schema": { + "$ref": "#/definitions/MuteParticipantsResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_Mute": { + "$ref": "./examples/CallConnection_Mute.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants:unmute": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Unmute participants from the call using identifier.", + "description": "Unmute participants from the call using identifier.", + "operationId": "CallConnection_Unmute", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection id.", + "required": true, + "type": "string" + }, + { + "name": "unmuteParticipantsRequest", + "in": "body", + "description": "The participants to be unmuted from the call.", + "required": true, + "schema": { + "$ref": "#/definitions/UnmuteParticipantsRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "202": { + "description": "Returns the unmute participants response", + "schema": { + "$ref": "#/definitions/UnmuteParticipantsResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_Unmute": { + "$ref": "./examples/CallConnection_Unmute.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants:cancelAddParticipant": { + "post": { + "tags": [ + "MidConnections" + ], + "summary": "Cancel add participant operation.", + "description": "Cancel add participant operation.", + "operationId": "CallConnection_CancelAddParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection Id", + "required": true, + "type": "string" + }, + { + "name": "cancelAddParticipantRequest", + "in": "body", + "description": "Cancellation request.", + "required": true, + "schema": { + "$ref": "#/definitions/CancelAddParticipantRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "202": { + "description": "Returns the cancelAddParticipant response", + "schema": { + "$ref": "#/definitions/CancelAddParticipantResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_CancelAddParticipant": { + "$ref": "./examples/CallConnection_CancelAddParticipant.json" + } + } + } + }, + "/calling/callConnections/{callConnectionId}/participants/{participantRawId}": { + "get": { + "tags": [ + "MidConnections" + ], + "summary": "Get participant from a call.", + "description": "Get participant from a call.", + "operationId": "CallConnection_GetParticipant", + "parameters": [ + { + "name": "callConnectionId", + "in": "path", + "description": "The call connection Id", + "required": true, + "type": "string" + }, + { + "name": "participantRawId", + "in": "path", + "description": "Raw id of the participant to retrieve.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns the detail of the requested participant.", + "schema": { + "$ref": "#/definitions/CallParticipant" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallConnection_GetParticipant": { + "$ref": "./examples/CallConnection_GetParticipant.json" + } + } + } + }, + "/calling/recordings": { + "post": { + "tags": [ + "Recording" + ], + "summary": "Start recording the call.", + "operationId": "CallRecording_StartRecording", + "parameters": [ + { + "name": "startCallRecording", + "in": "body", + "description": "The request body of start call recording request.", + "required": true, + "schema": { + "$ref": "#/definitions/StartCallRecordingRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "Repeatability-Request-ID", + "in": "header", + "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", + "type": "string", + "format": "uuid" + }, + { + "name": "Repeatability-First-Sent", + "in": "header", + "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", + "type": "string", + "format": "date-time-rfc1123" + } + ], + "responses": { + "200": { + "description": "Returns the start call recording response.", + "schema": { + "$ref": "#/definitions/RecordingStateResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallRecording_StartRecording": { + "$ref": "./examples/CallRecording_StartRecording.json" + } + } + } + }, + "/calling/recordings/{recordingId}": { + "get": { + "tags": [ + "Recording" + ], + "summary": "Get call recording properties.", + "operationId": "CallRecording_GetRecordingProperties", + "parameters": [ + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns the recording properties.", + "schema": { + "$ref": "#/definitions/RecordingStateResponse" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallRecording_GetRecordingProperties": { + "$ref": "./examples/CallRecording_GetRecordingProperties.json" + } + } + }, + "delete": { + "tags": [ + "Recording" + ], + "summary": "Stop recording the call.", + "operationId": "CallRecording_StopRecording", + "parameters": [ + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Returns the stop call recording response." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallRecording_StopRecording": { + "$ref": "./examples/CallRecording_StopRecording.json" + } + } + } + }, + "/calling/recordings/{recordingId}:pause": { + "post": { + "tags": [ + "Recording" + ], + "summary": "Pause recording the call.", + "operationId": "CallRecording_PauseRecording", + "parameters": [ + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The service has accepted the pause request and will begin processing it." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallRecording_PauseRecording": { + "$ref": "./examples/CallRecording_PauseRecording.json" + } + } + } + }, + "/calling/recordings/{recordingId}:resume": { + "post": { + "tags": [ + "Recording" + ], + "summary": "Resume recording the call.", + "operationId": "CallRecording_ResumeRecording", + "parameters": [ + { + "name": "recordingId", + "in": "path", + "description": "The recording id.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The service has accepted the resume request and will begin processing it." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/CommunicationErrorResponse" + } + } + }, + "x-ms-examples": { + "CallRecording_ResumeRecording": { + "$ref": "./examples/CallRecording_ResumeRecording.json" + } + } + } + } + }, + "definitions": { + "CreateCallRequest": { + "description": "The request payload for creating the call.", + "required": [ + "targets", + "callbackUri" + ], + "type": "object", + "properties": { + "targets": { + "description": "The targets of the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "sourceCallerIdNumber": { + "$ref": "#/definitions/PhoneNumberIdentifierModel", + "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when calling a PSTN callee." + }, + "sourceDisplayName": { + "description": "Display name of the call if dialing out to a pstn number", + "type": "string" + }, + "sourceIdentity": { + "$ref": "#/definitions/CommunicationUserIdentifierModel", + "description": "The identifier of the source of the call" + }, + "operationContext": { + "description": "A customer set value used to track the answering of a call.", + "type": "string" + }, + "callbackUri": { + "description": "The callback URI.", + "type": "string" + }, + "mediaStreamingConfiguration": { + "$ref": "#/definitions/MediaStreamingConfiguration", + "description": "Media Streaming Configuration." + }, + "transcriptionConfiguration": { + "$ref": "#/definitions/TranscriptionConfiguration", + "description": "Live Transcription Configuration." + }, + "azureCognitiveServicesEndpointUrl": { + "description": "The identifier of the Cognitive Service resource assigned to this call.", + "type": "string" + }, + "customContext": { + "$ref": "#/definitions/CustomContext", + "description": "Used by customer to send custom context to targets" + } + } + }, + "CommunicationIdentifierModel": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationIdentifierModel" + }, + "PhoneNumberIdentifierModel": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/PhoneNumberIdentifierModel" + }, + "CommunicationUserIdentifierModel": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationUserIdentifierModel" + }, + "MediaStreamingTransportType": { + "description": "The type of transport to be used for media streaming, eg. Websocket", + "enum": [ + "websocket" + ], + "type": "string", + "x-ms-enum": { + "name": "MediaStreamingTransportType", + "modelAsString": true + } + }, + "MediaStreamingContentType": { + "description": "Content type to stream, eg. audio, audio/video", + "enum": [ + "audio" + ], + "type": "string", + "x-ms-enum": { + "name": "MediaStreamingContentType", + "modelAsString": true + } + }, + "MediaStreamingAudioChannelType": { + "description": "Audio channel type to stream, eg. unmixed audio, mixed audio", + "enum": [ + "mixed", + "unmixed" + ], + "type": "string", + "x-ms-enum": { + "name": "MediaStreamingAudioChannelType", + "modelAsString": true + } + }, + "MediaStreamingConfiguration": { + "description": "Configuration of Media streaming.", + "required": [ + "transportUrl", + "transportType", + "contentType", + "audioChannelType" + ], + "type": "object", + "properties": { + "transportUrl": { + "description": "Transport URL for media streaming", + "type": "string" + }, + "transportType": { + "$ref": "#/definitions/MediaStreamingTransportType" + }, + "contentType": { + "$ref": "#/definitions/MediaStreamingContentType" + }, + "audioChannelType": { + "$ref": "#/definitions/MediaStreamingAudioChannelType" + } + } + }, + "TranscriptionTransportType": { + "description": "The type of transport to be used for live transcription, eg. Websocket", + "enum": [ + "websocket" + ], + "type": "string", + "x-ms-enum": { + "name": "TranscriptionTransportType", + "modelAsString": true + } + }, + "TranscriptionConfiguration": { + "description": "Configuration of live transcription.", + "required": [ + "transportUrl", + "transportType", + "locale", + "startTranscription" + ], + "type": "object", + "properties": { + "transportUrl": { + "description": "Transport URL for live transcription", + "type": "string" + }, + "transportType": { + "$ref": "#/definitions/TranscriptionTransportType" + }, + "locale": { + "description": "Defines the locale for the data e.g en-CA, en-AU", + "type": "string" + }, + "startTranscription": { + "description": "Determines if the transcription should be started immediately after call is answered or not.", + "type": "boolean" + } + } + }, + "CustomContext": { + "type": "object", + "properties": { + "voipHeaders": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sipHeaders": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CommunicationErrorResponse": { + "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse" + }, + "CallConnectionStateModel": { + "description": "The state of the call connection.", + "enum": [ + "unknown", + "connecting", + "connected", + "transferring", + "transferAccepted", + "disconnecting", + "disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "CallConnectionStateModel", + "modelAsString": true + } + }, + "CallConnectionProperties": { + "description": "Properties of a call connection", + "type": "object", + "properties": { + "callConnectionId": { + "description": "The call connection id.", + "type": "string" + }, + "serverCallId": { + "description": "The server call id.", + "type": "string" + }, + "targets": { + "description": "The targets of the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "callConnectionState": { + "$ref": "#/definitions/CallConnectionStateModel" + }, + "callbackUri": { + "description": "The callback URI.", + "type": "string" + }, + "mediaSubscriptionId": { + "description": "SubscriptionId for media streaming", + "type": "string" + }, + "dataSubscriptionId": { + "description": "SubscriptionId for transcription", + "type": "string" + }, + "sourceCallerIdNumber": { + "$ref": "#/definitions/PhoneNumberIdentifierModel", + "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when calling a PSTN callee." + }, + "sourceDisplayName": { + "description": "Display name of the call if dialing out to a pstn number.", + "type": "string" + }, + "sourceIdentity": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Source identity." + }, + "correlationId": { + "description": "The correlation ID.", + "type": "string" + }, + "answeredByIdentifier": { + "$ref": "#/definitions/CommunicationUserIdentifierModel", + "description": "Identity of the answering entity. Only populated when identity is provided in the request." + } + } + }, + "AnswerCallRequest": { + "description": "The request payload for answering the call.", + "required": [ + "incomingCallContext", + "callbackUri" + ], + "type": "object", + "properties": { + "incomingCallContext": { + "description": "The context associated with the call.", + "type": "string" + }, + "callbackUri": { + "description": "The callback uri.", + "type": "string" + }, + "operationContext": { + "description": "A customer set value used to track the answering of a call.", + "type": "string" + }, + "mediaStreamingConfiguration": { + "$ref": "#/definitions/MediaStreamingConfiguration", + "description": "Media Streaming Configuration." + }, + "transcriptionConfiguration": { + "$ref": "#/definitions/TranscriptionConfiguration", + "description": "Live Transcription Configuration." + }, + "azureCognitiveServicesEndpointUrl": { + "description": "The endpoint URL of the Azure Cognitive Services resource attached", + "type": "string" + }, + "answeredByIdentifier": { + "$ref": "#/definitions/CommunicationUserIdentifierModel", + "description": "The identifier of the call automation entity which answers the call" + } + } + }, + "RedirectCallRequest": { + "description": "The request payload for redirecting the call.", + "required": [ + "incomingCallContext", + "target" + ], + "type": "object", + "properties": { + "incomingCallContext": { + "description": "The context associated with the call.", + "type": "string" + }, + "target": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The target identity to redirect the call to." + }, + "customContext": { + "$ref": "#/definitions/CustomContext", + "description": "Used by customer to send custom context to targets" + } + } + }, + "CallRejectReason": { + "description": "The rejection reason.", + "enum": [ + "none", + "busy", + "forbidden" + ], + "type": "string", + "x-ms-enum": { + "name": "CallRejectReason", + "modelAsString": true + } + }, + "RejectCallRequest": { + "description": "The request payload for rejecting the call.", + "required": [ + "incomingCallContext" + ], + "type": "object", + "properties": { + "incomingCallContext": { + "description": "The context associated with the call.", + "type": "string" + }, + "callRejectReason": { + "$ref": "#/definitions/CallRejectReason" + } + } + }, + "TransferToParticipantRequest": { + "description": "The request payload for transferring call to a participant.", + "required": [ + "targetParticipant" + ], + "type": "object", + "properties": { + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The identity of the target where call should be transferred to." + }, + "customContext": { + "$ref": "#/definitions/CustomContext", + "description": "Used by customer to send custom context to targets" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "transferee": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Transferee is the participant who is transferring the call." + }, + "callbackUri": { + "description": "The callback URI to override the main callback URI.", + "type": "string" + } + } + }, + "TransferCallResponse": { + "description": "The response payload for transferring the call.", + "type": "object", + "properties": { + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + } + } + }, + "PlayRequest": { + "required": [ + "playSourceInfo" + ], + "type": "object", + "properties": { + "playSourceInfo": { + "$ref": "#/definitions/PlaySource", + "description": "The source of the audio to be played." + }, + "playTo": { + "description": "The list of call participants play provided audio to.\r\nPlays to everyone in the call when not provided.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "playOptions": { + "$ref": "#/definitions/PlayOptions", + "description": "Defines options for playing the audio." + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + }, + "callbackUri": { + "description": "The callback URI to override the main callback URI.", + "type": "string" + } + } + }, + "PlaySourceType": { + "description": "Defines the type of the play source", + "enum": [ + "file", + "text", + "ssml" + ], + "type": "string", + "x-ms-enum": { + "name": "PlaySourceType", + "modelAsString": true + } + }, + "PlaySource": { + "required": [ + "sourceType" + ], + "type": "object", + "properties": { + "sourceType": { + "$ref": "#/definitions/PlaySourceType" + }, + "playSourceId": { + "description": "Defines the identifier to be used for caching related media", + "type": "string" + }, + "fileSource": { + "$ref": "#/definitions/FileSource", + "description": "Defines the file source info to be used for play" + }, + "textSource": { + "$ref": "#/definitions/TextSource", + "description": "Defines the text source info to be used for play" + }, + "ssmlSource": { + "$ref": "#/definitions/SsmlSource", + "description": "Defines the ssml(Speech Synthesis Markup Language) source info to be used for play" + } + } + }, + "PlayOptions": { + "required": [ + "loop" + ], + "type": "object", + "properties": { + "loop": { + "description": "The option to play the provided audio source in loop when set to true", + "type": "boolean" + } + } + }, + "FileSource": { + "required": [ + "uri" + ], + "type": "object", + "properties": { + "uri": { + "description": "Uri for the audio file to be played", + "type": "string" + } + } + }, + "Gender": { + "description": "Voice gender type", + "enum": [ + "male", + "female" + ], + "type": "string", + "x-ms-enum": { + "name": "Gender", + "modelAsString": true + } + }, + "TextSource": { + "required": [ + "text" + ], + "type": "object", + "properties": { + "text": { + "description": "Text for the cognitive service to be played", + "type": "string" + }, + "sourceLocale": { + "description": "Source language locale to be played\r\nRefer to available locales here: ", + "type": "string" + }, + "voiceGender": { + "$ref": "#/definitions/Gender" + }, + "voiceName": { + "description": "Voice name to be played\r\nRefer to available Text-to-speech voices here: ", + "type": "string" + }, + "customVoiceEndpointId": { + "description": "Endpoint where the custom voice was deployed.", + "type": "string" + } + } + }, + "SsmlSource": { + "required": [ + "ssmlText" + ], + "type": "object", + "properties": { + "ssmlText": { + "description": "Ssml string for the cognitive service to be played", + "type": "string" + }, + "customVoiceEndpointId": { + "description": "Endpoint where the custom voice was deployed.", + "type": "string" + } + } + }, + "StartTranscriptionRequest": { + "type": "object", + "properties": { + "locale": { + "description": "Defines Locale for the transcription e,g en-US", + "type": "string" + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + } + } + }, + "StopTranscriptionRequest": { + "type": "object", + "properties": { + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + } + } + }, + "RecognizeInputType": { + "description": "Determines the type of the recognition.", + "enum": [ + "dtmf", + "speech", + "speechOrDtmf", + "choices" + ], + "type": "string", + "x-ms-enum": { + "name": "RecognizeInputType", + "modelAsString": true + } + }, + "RecognizeRequest": { + "required": [ + "recognizeInputType", + "recognizeOptions" + ], + "type": "object", + "properties": { + "recognizeInputType": { + "$ref": "#/definitions/RecognizeInputType" + }, + "playPrompt": { + "$ref": "#/definitions/PlaySource", + "description": "The source of the audio to be played for recognition." + }, + "interruptCallMediaOperation": { + "description": "If set recognize can barge into other existing queued-up/currently-processing requests.", + "type": "boolean" + }, + "recognizeOptions": { + "$ref": "#/definitions/RecognizeOptions", + "description": "Defines options for recognition." + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + }, + "callbackUri": { + "description": "The callback URI to override the main callback URI.", + "type": "string" + } + } + }, + "RecognizeOptions": { + "required": [ + "targetParticipant" + ], + "type": "object", + "properties": { + "interruptPrompt": { + "description": "Determines if we interrupt the prompt and start recognizing.", + "type": "boolean" + }, + "initialSilenceTimeoutInSeconds": { + "format": "int32", + "description": "Time to wait for first input after prompt (if any).", + "maximum": 300, + "minimum": 0, + "type": "integer" + }, + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Target participant of DTMF tone recognition." + }, + "speechLanguage": { + "description": "Speech language to be recognized, If not set default is en-US", + "type": "string" + }, + "speechRecognitionModelEndpointId": { + "description": "Endpoint where the custom model was deployed.", + "type": "string" + }, + "dtmfOptions": { + "$ref": "#/definitions/DtmfOptions", + "description": "Defines configurations for DTMF." + }, + "choices": { + "description": "Defines Ivr choices for recognize.", + "type": "array", + "items": { + "$ref": "#/definitions/Choice" + } + }, + "speechOptions": { + "$ref": "#/definitions/SpeechOptions", + "description": "Defines continuous speech recognition option." + } + } + }, + "Tone": { + "enum": [ + "zero", + "one", + "two", + "three", + "four", + "five", + "six", + "seven", + "eight", + "nine", + "a", + "b", + "c", + "d", + "pound", + "asterisk" + ], + "type": "string", + "x-ms-enum": { + "name": "Tone", + "modelAsString": true + } + }, + "DtmfOptions": { + "description": "Options for DTMF recognition", + "type": "object", + "properties": { + "interToneTimeoutInSeconds": { + "format": "int32", + "description": "Time to wait between DTMF inputs to stop recognizing.", + "maximum": 60, + "minimum": 1, + "type": "integer" + }, + "maxTonesToCollect": { + "format": "int32", + "description": "Maximum number of DTMF tones to be collected.", + "type": "integer" + }, + "stopTones": { + "description": "List of tones that will stop recognizing.", + "type": "array", + "items": { + "$ref": "#/definitions/Tone" + } + } + } + }, + "Choice": { + "required": [ + "label", + "phrases" + ], + "type": "object", + "properties": { + "label": { + "description": "Identifier for a given choice", + "type": "string" + }, + "phrases": { + "description": "List of phrases to recognize", + "type": "array", + "items": { + "type": "string" + } + }, + "tone": { + "$ref": "#/definitions/Tone" + } + } + }, + "SpeechOptions": { + "description": "Options for continuous speech recognition", + "type": "object", + "properties": { + "endSilenceTimeoutInMs": { + "format": "int64", + "description": "The length of end silence when user stops speaking and cogservice send response.", + "type": "integer" + } + } + }, + "ContinuousDtmfRecognitionRequest": { + "required": [ + "targetParticipant" + ], + "type": "object", + "properties": { + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Defines options for recognition." + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + }, + "callbackUri": { + "description": "The callback URI to override the main callback URI.", + "type": "string" + } + } + }, + "SendDtmfRequest": { + "required": [ + "tones", + "targetParticipant" + ], + "type": "object", + "properties": { + "tones": { + "description": "List of tones to be sent to target participant.", + "type": "array", + "items": { + "$ref": "#/definitions/Tone" + } + }, + "targetParticipant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Target participant of send DTMF." + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + }, + "callbackUri": { + "description": "The callback URI to override the main callback URI.", + "type": "string" + } + } + }, + "UpdateTranscriptionDataRequest": { + "required": [ + "locale" + ], + "type": "object", + "properties": { + "locale": { + "description": "Defines new locale for transcription.", + "type": "string" + } + } + }, + "DialogInputType": { + "description": "Determines the type of the dialog.", + "enum": [ + "powerVirtualAgents", + "azureOpenAI" + ], + "type": "string", + "x-ms-enum": { + "name": "DialogInputType", + "modelAsString": true + } + }, + "StartDialogRequest": { + "required": [ + "dialogOptions", + "dialogInputType" + ], + "type": "object", + "properties": { + "dialogOptions": { + "$ref": "#/definitions/DialogOptions", + "description": "Defines options for dialog." + }, + "dialogInputType": { + "$ref": "#/definitions/DialogInputType" + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + } + } + }, + "DialogOptions": { + "required": [ + "dialogContext" + ], + "type": "object", + "properties": { + "botAppId": { + "description": "Bot identifier.", + "type": "string" + }, + "dialogContext": { + "description": "Dialog context.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "DialogStateResponse": { + "type": "object", + "properties": { + "dialogId": { + "description": "The dialog ID.", + "type": "string" + }, + "dialogOptions": { + "$ref": "#/definitions/DialogOptions", + "description": "Defines options for dialog." + }, + "dialogInputType": { + "$ref": "#/definitions/DialogInputType" + }, + "operationContext": { + "description": "The value to identify context of the operation.", + "type": "string" + } + } + }, + "GetParticipantsResponse": { + "description": "The response payload for getting participants of the call.", + "type": "object", + "properties": { + "values": { + "description": "List of the current participants in the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CallParticipant" + } + }, + "nextLink": { + "description": "Continue of the list of participants", + "type": "string" + } + } + }, + "CallParticipant": { + "description": "Contract model of an ACS call participant", + "type": "object", + "properties": { + "identifier": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Communication identifier of the participant" + }, + "isMuted": { + "description": "Is participant muted", + "type": "boolean" + } + } + }, + "AddParticipantRequest": { + "description": "The request payload for adding participant to the call.", + "required": [ + "participantToAdd" + ], + "type": "object", + "properties": { + "sourceCallerIdNumber": { + "$ref": "#/definitions/PhoneNumberIdentifierModel", + "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when inviting a PSTN participant." + }, + "sourceDisplayName": { + "description": "(Optional) The display name of the source that is associated with this invite operation when\r\nadding a PSTN participant or teams user. Note: Will not update the display name in the roster.", + "type": "string" + }, + "participantToAdd": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The participant to invite." + }, + "invitationTimeoutInSeconds": { + "format": "int32", + "description": "Gets or sets the timeout to wait for the invited participant to pickup.\r\nThe maximum value of this is 180 seconds", + "maximum": 180, + "minimum": 0, + "type": "integer" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "customContext": { + "$ref": "#/definitions/CustomContext", + "description": "Used by customer to send custom context to targets" + }, + "callbackUri": { + "description": "The callback URI to override the main callback URI.", + "type": "string" + } + } + }, + "AddParticipantResponse": { + "description": "The response payload for adding participants to the call.", + "type": "object", + "properties": { + "participant": { + "$ref": "#/definitions/CallParticipant", + "description": "List of current participants in the call." + }, + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + }, + "invitationId": { + "description": "Invitation ID used to add a participant.", + "type": "string" + } + } + }, + "RemoveParticipantRequest": { + "description": "The remove participant by identifier request.", + "required": [ + "participantToRemove" + ], + "type": "object", + "properties": { + "participantToRemove": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The participants to be removed from the call." + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "callbackUri": { + "description": "The callback URI to override the main callback URI.", + "type": "string" + } + } + }, + "RemoveParticipantResponse": { + "description": "The response payload for removing participants of the call.", + "type": "object", + "properties": { + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + } + } + }, + "MuteParticipantsRequest": { + "description": "The request payload for muting participants from the call.", + "required": [ + "targetParticipants" + ], + "type": "object", + "properties": { + "targetParticipants": { + "description": "Participants to be muted from the call.\r\nOnly ACS Users are supported.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + } + } + }, + "MuteParticipantsResponse": { + "description": "The response payload for muting participants from the call.", + "type": "object", + "properties": { + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + } + } + }, + "UnmuteParticipantsRequest": { + "description": "The request payload for unmuting participant from the call.", + "required": [ + "targetParticipants" + ], + "type": "object", + "properties": { + "targetParticipants": { + "description": "Participants to be unmuted from the call.\r\nOnly ACS Users are supported.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + } + } + }, + "UnmuteParticipantsResponse": { + "description": "The response payload for unmuting participants from the call.", + "type": "object", + "properties": { + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + } + } + }, + "CancelAddParticipantRequest": { + "required": [ + "invitationId" + ], + "type": "object", + "properties": { + "invitationId": { + "description": "Invitation ID used to add a participant.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "callbackUri": { + "description": "The callback URI to override the main callback URI.", + "type": "string" + } + } + }, + "CancelAddParticipantResponse": { + "type": "object", + "properties": { + "invitationId": { + "description": "Invitation ID used to cancel the add participant action.", + "type": "string" + }, + "operationContext": { + "description": "The operation context provided by client.", + "type": "string" + } + } + }, + "RecordingContentType": { + "description": "The content type of call recording.", + "enum": [ + "audio", + "audioVideo" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingContentType", + "modelAsString": true + } + }, + "RecordingChannelType": { + "description": "The channel type of call recording.", + "enum": [ + "mixed", + "unmixed" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingChannelType", + "modelAsString": true + } + }, + "RecordingFormatType": { + "description": "The format type of call recording.", + "enum": [ + "wav", + "mp3", + "mp4" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingFormatType", + "modelAsString": true + } + }, + "StartCallRecordingRequest": { + "description": "The request payload start for call recording operation with call locator.", + "required": [ + "callLocator" + ], + "type": "object", + "properties": { + "callLocator": { + "$ref": "#/definitions/CallLocator", + "description": "The call locator." + }, + "recordingStateCallbackUri": { + "description": "The uri to send notifications to.", + "type": "string" + }, + "recordingContentType": { + "$ref": "#/definitions/RecordingContentType" + }, + "recordingChannelType": { + "$ref": "#/definitions/RecordingChannelType" + }, + "recordingFormatType": { + "$ref": "#/definitions/RecordingFormatType" + }, + "audioChannelParticipantOrdering": { + "description": "The sequential order in which audio channels are assigned to participants in the unmixed recording.\r\nWhen 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering is not specified,\r\nthe audio channel to participant mapping will be automatically assigned based on the order in which participant\r\nfirst audio was detected. Channel to participant mapping details can be found in the metadata of the recording.", + "type": "array", + "items": { + "$ref": "#/definitions/CommunicationIdentifierModel" + } + }, + "channelAffinity": { + "description": "The channel affinity of call recording\r\nWhen 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned.\r\nChannel-Participant mapping details can be found in the metadata of the recording.\r\n///", + "type": "array", + "items": { + "$ref": "#/definitions/ChannelAffinity" + } + }, + "externalStorage": { + "$ref": "#/definitions/ExternalStorage", + "description": "Optional property to specify location where recording will be stored" + }, + "pauseOnStart": { + "description": "When set to true will start recording in Pause mode, which could be resumed.", + "type": "boolean" + } + } + }, + "CallLocatorKind": { + "description": "The call locator kind.", + "enum": [ + "groupCallLocator", + "serverCallLocator" + ], + "type": "string", + "x-ms-enum": { + "name": "CallLocatorKind", + "modelAsString": true + } + }, + "CallLocator": { + "description": "The locator used for joining or taking action on a call.", + "type": "object", + "properties": { + "groupCallId": { + "description": "The group call id", + "type": "string" + }, + "serverCallId": { + "description": "The server call id.", + "type": "string" + }, + "kind": { + "$ref": "#/definitions/CallLocatorKind" + } + } + }, + "ChannelAffinity": { + "description": "Channel affinity for a participant", + "required": [ + "participant" + ], + "type": "object", + "properties": { + "channel": { + "format": "int32", + "description": "Channel number to which bitstream from a particular participant will be written.", + "maximum": 4, + "minimum": 0, + "type": "integer" + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The identifier for the participant whose bitstream will be written to the channel \r\nrepresented by the channel number." + } + } + }, + "RecordingStorageType": { + "description": "Defines the type of external storage", + "enum": [ + "acs", + "blobStorage" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingStorageType", + "modelAsString": true + } + }, + "ExternalStorage": { + "required": [ + "storageType" + ], + "type": "object", + "properties": { + "storageType": { + "$ref": "#/definitions/RecordingStorageType" + }, + "blobStorage": { + "$ref": "#/definitions/BlobStorage", + "description": "Defines the blob storage location where the recording will be stored" + } + } + }, + "BlobStorage": { + "description": "Used to specify Blob container url to recording storage", + "required": [ + "containerUri" + ], + "type": "object", + "properties": { + "containerUri": { + "description": "Url of a container or a location within a container", + "type": "string" + } + } + }, + "RecordingState": { + "enum": [ + "active", + "inactive" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingState", + "modelAsString": true + } + }, + "RecordingType": { + "enum": [ + "acs", + "teams" + ], + "type": "string", + "x-ms-enum": { + "name": "RecordingType", + "modelAsString": true + } + }, + "RecordingStateResponse": { + "type": "object", + "properties": { + "recordingId": { + "type": "string" + }, + "recordingState": { + "$ref": "#/definitions/RecordingState" + }, + "recordingType": { + "$ref": "#/definitions/RecordingType" + } + } + }, + "AddParticipantFailed": { + "description": "The failed to add participant event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services." + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Participant" + } + } + }, + "ResultInformation": { + "type": "object", + "properties": { + "code": { + "format": "int32", + "description": "Code of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected.", + "type": "integer" + }, + "subCode": { + "format": "int32", + "description": "Subcode of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected.", + "type": "integer" + }, + "message": { + "description": "Detail message that describes the current result.", + "type": "string" + } + } + }, + "AddParticipantSucceeded": { + "description": "The participant successfully added event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services." + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Participant" + } + } + }, + "CallConnected": { + "description": "The call connected event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers to set the context for creating a new call. This property will be null for answering a call.", + "type": "string" + } + } + }, + "CallDisconnected": { + "description": "The call disconnected event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers to set the context for creating a new call. This property will be null for answering a call.", + "type": "string" + } + } + }, + "CallTransferAccepted": { + "description": "The call transfer accepted event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services." + }, + "transferTarget": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Traffer target: the user that transferee will be transferred to", + "readOnly": true + }, + "transferee": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Transferee: the participant being transferred away", + "readOnly": true + } + } + }, + "CallTransferFailed": { + "description": "The call transfer failed event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services." + } + } + }, + "ParticipantsUpdated": { + "description": "The participants updated in a call event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "sequenceNumber": { + "format": "int32", + "description": "The Sequence Number of the event", + "type": "integer" + }, + "participants": { + "description": "The list of participants in the call.", + "type": "array", + "items": { + "$ref": "#/definitions/CallParticipant" + } + } + } + }, + "RemoveParticipantSucceeded": { + "description": "The participant removed event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services." + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Participant" + } + } + }, + "RemoveParticipantFailed": { + "description": "The failed to remove participant event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services." + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Participant" + } + } + }, + "AddParticipantCancelled": { + "description": "Successful cancel add participant event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "participant": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "Participant that has been cancelled." + }, + "invitationId": { + "description": "Invitation ID used to cancel the request.", + "type": "string" + } + } + }, + "CancelAddParticipantFailed": { + "description": "Failed cancel add participant event.", + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services." + }, + "invitationId": { + "description": "Invitation ID used to cancel the request.", + "type": "string" + } + } + }, + "RecordingStateChanged": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "recordingId": { + "description": "The call recording id", + "type": "string", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/RecordingState" + }, + "startDateTime": { + "format": "date-time", + "description": "The time of the recording started", + "type": "string", + "readOnly": true + } + } + }, + "PlayCompleted": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "PlayFailed": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "PlayCanceled": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + } + } + }, + "RecognitionType": { + "description": "Determines the sub-type of the recognize operation.\r\nIn case of cancel operation the this field is not set and is returned empty", + "enum": [ + "dtmf", + "speech", + "choices" + ], + "type": "string", + "x-ms-enum": { + "name": "RecognitionType", + "modelAsString": true + } + }, + "RecognizeCompleted": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + }, + "recognitionType": { + "$ref": "#/definitions/RecognitionType" + }, + "collectTonesResult": { + "$ref": "#/definitions/CollectTonesResult", + "description": "Defines the result for RecognitionType = Dtmf\r\nWould be replaced by DtmfResult after server sdk renewed" + }, + "dtmfResult": { + "$ref": "#/definitions/DtmfResult", + "description": "Defines the result for RecognitionType = Dtmf" + }, + "choiceResult": { + "$ref": "#/definitions/ChoiceResult", + "description": "Defines the result for RecognitionType = Choices" + }, + "speechResult": { + "$ref": "#/definitions/SpeechResult", + "description": "Defines the result for RecognitionType = Speech and SpeechOrDtmf", + "readOnly": true + } + } + }, + "CollectTonesResult": { + "type": "object", + "properties": { + "tones": { + "type": "array", + "items": { + "$ref": "#/definitions/Tone" + }, + "readOnly": true + } + } + }, + "DtmfResult": { + "type": "object", + "properties": { + "tones": { + "type": "array", + "items": { + "$ref": "#/definitions/Tone" + }, + "readOnly": true + } + } + }, + "ChoiceResult": { + "type": "object", + "properties": { + "label": { + "description": "Label is the primary identifier for the choice detected", + "type": "string" + }, + "recognizedPhrase": { + "description": "Phrases are set to the value if choice is selected via phrase detection.\r\nIf Dtmf input is recognized, then Label will be the identifier for the choice detected and phrases will be set to null", + "type": "string" + } + } + }, + "SpeechResult": { + "description": "The speech status as a result.", + "type": "object", + "properties": { + "speech": { + "description": "The recognized speech in string.", + "type": "string" + } + } + }, + "RecognizeFailed": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "RecognizeCanceled": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + } + } + }, + "DialogCompleted": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "dialogInputType": { + "$ref": "#/definitions/DialogInputType" + }, + "dialogId": { + "description": "Dialog ID", + "type": "string", + "readOnly": true + } + } + }, + "DialogFailed": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "dialogInputType": { + "$ref": "#/definitions/DialogInputType" + }, + "dialogId": { + "description": "Dialog ID", + "type": "string", + "readOnly": true + } + } + }, + "DialogConsent": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "dialogInputType": { + "$ref": "#/definitions/DialogInputType" + }, + "userConsent": { + "$ref": "#/definitions/UserConsent", + "description": "UserConsent data from the Conversation Conductor", + "readOnly": true + }, + "dialogId": { + "description": "Dialog ID", + "type": "string", + "readOnly": true + } + } + }, + "UserConsent": { + "type": "object", + "properties": { + "recording": { + "format": "int32", + "type": "integer" + } + } + }, + "DialogStarted": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "dialogInputType": { + "$ref": "#/definitions/DialogInputType" + }, + "dialogId": { + "description": "Dialog ID", + "type": "string", + "readOnly": true + } + } + }, + "DialogHangup": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "dialogInputType": { + "$ref": "#/definitions/DialogInputType" + }, + "dialogId": { + "description": "Dialog ID", + "type": "string", + "readOnly": true + }, + "ivrContext": { + "description": "Ivr Context", + "type": "object", + "readOnly": true + } + } + }, + "DialogTransfer": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "dialogInputType": { + "$ref": "#/definitions/DialogInputType" + }, + "dialogId": { + "description": "Dialog ID", + "type": "string", + "readOnly": true + }, + "transferType": { + "description": "Transfer type", + "type": "string", + "readOnly": true + }, + "transferDestination": { + "description": "Transfer destination", + "type": "string", + "readOnly": true + }, + "ivrContext": { + "description": "IVR context", + "type": "object", + "readOnly": true + } + } + }, + "DialogLanguageChange": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "dialogInputType": { + "$ref": "#/definitions/DialogInputType" + }, + "dialogId": { + "description": "Dialog ID", + "type": "string", + "readOnly": true + }, + "selectedLanguage": { + "description": "Selected Language", + "type": "string", + "readOnly": true + }, + "ivrContext": { + "description": "Ivr Context", + "type": "object", + "readOnly": true + } + } + }, + "DialogSensitivityUpdate": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "dialogInputType": { + "$ref": "#/definitions/DialogInputType" + }, + "dialogId": { + "description": "Dialog ID", + "type": "string", + "readOnly": true + }, + "sensitiveMask": { + "description": "SensitiveMask", + "type": "boolean", + "readOnly": true + } + } + }, + "ContinuousDtmfRecognitionToneFailed": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + } + } + }, + "ContinuousDtmfRecognitionToneReceived": { + "type": "object", + "properties": { + "toneInfo": { + "$ref": "#/definitions/ToneInfo", + "description": "Information about Tone." + }, + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId or skype chain ID.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + } + } + }, + "ToneInfo": { + "description": "The information about the tone.", + "required": [ + "sequenceId", + "tone" + ], + "type": "object", + "properties": { + "sequenceId": { + "format": "int32", + "description": "The sequence id which can be used to determine if the same tone was played multiple times or if any tones were missed.", + "type": "integer" + }, + "tone": { + "$ref": "#/definitions/Tone" + } + } + }, + "ContinuousDtmfRecognitionStopped": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "SendDtmfCompleted": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "SendDtmfFailed": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string" + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", + "type": "string" + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code, sub-code and message." + } + } + }, + "TranscriptionStarted": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "transcriptionUpdateResult": { + "$ref": "#/definitions/TranscriptionUpdate", + "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status", + "readOnly": true + } + } + }, + "TranscriptionStatus": { + "enum": [ + "transcriptionStarted", + "transcriptionFailed", + "transcriptionResumed", + "transcriptionLocaleUpdated", + "transcriptionStopped", + "unspecifiedError" + ], + "type": "string", + "x-ms-enum": { + "name": "TranscriptionStatus", + "modelAsString": true + } + }, + "TranscriptionStatusDetails": { + "enum": [ + "subscriptionStarted", + "streamConnectionReestablished", + "streamConnectionUnsuccessful", + "streamUrlMissing", + "serviceShutdown", + "streamConnectionInterrupted", + "speechServicesConnectionError", + "subscriptionStopped", + "unspecifiedError" + ], + "type": "string", + "x-ms-enum": { + "name": "TranscriptionStatusDetails", + "modelAsString": true + } + }, + "TranscriptionUpdate": { + "type": "object", + "properties": { + "transcriptionStatus": { + "$ref": "#/definitions/TranscriptionStatus" + }, + "transcriptionStatusDetails": { + "$ref": "#/definitions/TranscriptionStatusDetails" + } + } + }, + "TranscriptionStopped": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "transcriptionUpdateResult": { + "$ref": "#/definitions/TranscriptionUpdate", + "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status", + "readOnly": true + } + } + }, + "TranscriptionResumed": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "transcriptionUpdateResult": { + "$ref": "#/definitions/TranscriptionUpdate", + "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status", + "readOnly": true + } + } + }, + "TranscriptionFailed": { + "type": "object", + "properties": { + "callConnectionId": { + "description": "Call connection ID.", + "type": "string", + "readOnly": true + }, + "serverCallId": { + "description": "Server call ID.", + "type": "string" + }, + "correlationId": { + "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", + "type": "string" + }, + "operationContext": { + "description": "Used by customers when calling answerCall action to correlate the request to the response event.", + "type": "string", + "readOnly": true + }, + "resultInformation": { + "$ref": "#/definitions/ResultInformation", + "description": "Contains the resulting SIP code/sub-code and message from NGC services.", + "readOnly": true + }, + "transcriptionUpdateResult": { + "$ref": "#/definitions/TranscriptionUpdate", + "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status", + "readOnly": true + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Version of API to invoke.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "name": "endpoint", + "in": "path", + "description": "The endpoint of the Azure Communication resource.", + "required": true, + "type": "string", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "Authorization": { + "type": "apiKey", + "description": "An Azure Communication Services user access token.", + "name": "Authorization", + "in": "header" + } + }, + "security": [ + { + "Authorization": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} \ No newline at end of file diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/autorest.md b/sdk/communication/Azure.Communication.CallAutomation/src/autorest.md index 632070f1032a4..05780b53406c4 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/autorest.md +++ b/sdk/communication/Azure.Communication.CallAutomation/src/autorest.md @@ -10,7 +10,7 @@ model-namespace: false tag: package-2023-01-15-preview require: - - https://github.com/williamzhao87/azure-rest-api-specs/blob/e13717bd01daf5784c5923a2ebf54c32762b2051/specification/communication/data-plane/CallAutomation/readme.md + - https://github.com/williamzhao87/azure-rest-api-specs/blob/5b7321a923a30b83b978e3a30ed1d497e35052fd/specification/communication/data-plane/CallAutomation/readme.md title: Azure Communication Services From 97b1138b9c745048d027a143c61b52b6b729f456 Mon Sep 17 00:00:00 2001 From: Amari West Date: Fri, 6 Oct 2023 13:14:04 -0500 Subject: [PATCH 02/20] removed extra swagger file --- .../src/SwaggerPauseOnStart.json | 4135 ----------------- 1 file changed, 4135 deletions(-) delete mode 100644 sdk/communication/Azure.Communication.CallAutomation/src/SwaggerPauseOnStart.json diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/SwaggerPauseOnStart.json b/sdk/communication/Azure.Communication.CallAutomation/src/SwaggerPauseOnStart.json deleted file mode 100644 index c2ceb7cd8ee8d..0000000000000 --- a/sdk/communication/Azure.Communication.CallAutomation/src/SwaggerPauseOnStart.json +++ /dev/null @@ -1,4135 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-01-15-preview", - "title": "Azure Communication Service Call Automation APIs", - "description": "Azure Communication Service Call Automation APIs" - }, - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/calling/callConnections": { - "post": { - "tags": [ - "PreConnections" - ], - "summary": "Create an outbound call.", - "description": "Create an outbound call.", - "operationId": "CreateCall", - "parameters": [ - { - "name": "createCallRequest", - "in": "body", - "description": "The create call request.", - "required": true, - "schema": { - "$ref": "#/definitions/CreateCallRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "201": { - "description": "Returns details of the call properties once the CreateCall request is received by service. You will receive CallConnected event at your specified callback URI, once the call is connected.", - "schema": { - "$ref": "#/definitions/CallConnectionProperties" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CreateCall": { - "$ref": "./examples/CreateCall.json" - } - } - } - }, - "/calling/callConnections:answer": { - "post": { - "tags": [ - "PreConnections" - ], - "summary": "Answer a Call.", - "description": "Answer a call using the IncomingCallContext from Event Grid.", - "operationId": "AnswerCall", - "parameters": [ - { - "name": "answerCallRequest", - "in": "body", - "description": "The answer call request.", - "required": true, - "schema": { - "$ref": "#/definitions/AnswerCallRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "200": { - "description": "Returns details of the call properties once the AnswerCall request is received by service. You will receive CallConnected event at your specified callback URI, once the call is connected.", - "schema": { - "$ref": "#/definitions/CallConnectionProperties" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "AnswerCall": { - "$ref": "./examples/AnswerCall.json" - } - } - } - }, - "/calling/callConnections:redirect": { - "post": { - "tags": [ - "PreConnections" - ], - "summary": "Redirect a call.", - "description": "Redirect a call.", - "operationId": "RedirectCall", - "parameters": [ - { - "name": "redirectCallRequest", - "in": "body", - "description": "The redirect call request.", - "required": true, - "schema": { - "$ref": "#/definitions/RedirectCallRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "204": { - "description": "The service has redirected the call to specified endpoint." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "RedirectCall": { - "$ref": "./examples/RedirectCall.json" - } - } - } - }, - "/calling/callConnections:reject": { - "post": { - "tags": [ - "PreConnections" - ], - "summary": "Reject the call.", - "description": "Reject the call.", - "operationId": "RejectCall", - "parameters": [ - { - "name": "rejectCallRequest", - "in": "body", - "description": "The reject call request.", - "required": true, - "schema": { - "$ref": "#/definitions/RejectCallRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "204": { - "description": "The service has rejected the call." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "RejectCall": { - "$ref": "./examples/RejectCall.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}": { - "get": { - "tags": [ - "MidConnections" - ], - "summary": "Get call connection.", - "operationId": "CallConnection_GetCall", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Returns details of the call properties.", - "schema": { - "$ref": "#/definitions/CallConnectionProperties" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallConnection_GetCall": { - "$ref": "./examples/CallConnection_GetCall.json" - } - } - }, - "delete": { - "tags": [ - "MidConnections" - ], - "summary": "Hangup the call.", - "description": "Hangup the call.", - "operationId": "CallConnection_HangupCall", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Call automation service has left the call." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallConnection_HangupCall": { - "$ref": "./examples/CallConnection_HangupCall.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}:terminate": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Terminate a call using CallConnectionId.", - "description": "Terminate a call using CallConnectionId.", - "operationId": "CallConnection_TerminateCall", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The terminate call request.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "204": { - "description": "The call is terminated." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallConnection_TerminateCall": { - "$ref": "./examples/CallConnection_TerminateCall.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}:transferToParticipant": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Transfer the call to a participant.", - "description": "Transfer the call to a participant.", - "operationId": "CallConnection_TransferToParticipant", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" - }, - { - "name": "transferToParticipantRequest", - "in": "body", - "description": "The transfer to participant request.", - "required": true, - "schema": { - "$ref": "#/definitions/TransferToParticipantRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "202": { - "description": "The service has accepted the transfer request and will begin processing it. You will receive either CallTransferAccepted or CallTransferFailed event at your specified callback URI to update you on the status of the request.", - "schema": { - "$ref": "#/definitions/TransferCallResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallConnection_TransferToParticipant": { - "$ref": "./examples/CallConnection_TransferToParticipant.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}:play": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Plays audio to participants in the call.", - "description": "Plays audio to participants in the call.", - "operationId": "CallMedia_Play", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" - }, - { - "name": "playRequest", - "in": "body", - "description": "play request payload.", - "required": true, - "schema": { - "$ref": "#/definitions/PlayRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "The service has accepted the play request and will begin processing it. You will receive either PlayCompleted or PlayFailed event at your specified callback URI to update you on the status of the request." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallMedia_Play": { - "$ref": "./examples/CallMedia_Play.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}:StartTranscription": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Starts transcription in the call", - "description": "Starts transcription in the call", - "operationId": "CallMedia_StartTranscription", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" - }, - { - "name": "startTranscriptionRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/StartTranscriptionRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "The service has accepted the start transcription request and will begin processing it. You will receive either TranscriptionStarted or TranscriptionFailed event at your specified callback URI to update you on the status of the request." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallMedia_StartTranscription": { - "$ref": "./examples/CallMedia_StartTranscription.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}:StopTranscription": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Stops transcription in the call.", - "description": "Stops transcription in the call.", - "operationId": "CallMedia_StopTranscription", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" - }, - { - "name": "stopTranscriptionRequest", - "in": "body", - "description": "stop transcription request payload.", - "required": true, - "schema": { - "$ref": "#/definitions/StopTranscriptionRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "The service has accepted the stop transcription request and will begin processing it. You will receive either TrannscriptionStopped event at your specified callback URI to update you on the status of the request." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallMedia_StopTranscription": { - "$ref": "./examples/CallMedia_StopTranscription.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}:cancelAllMediaOperations": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Cancel all media operations in a call.", - "description": "Cancel all media operations in a call.", - "operationId": "CallMedia_CancelAllMediaOperations", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "The service has accepted the cancel request and will begin processing it. RecognizeCanceled and/or PlayCanceled at your specified callback URI to update you on the status of the request, based on which media operation has been canceled by it." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallMedia_CancelAllMediaOperations": { - "$ref": "./examples/CallMedia_CancelAllMediaOperations.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}:recognize": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Recognize media from call.", - "description": "Recognize media from call.", - "operationId": "CallMedia_Recognize", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id", - "required": true, - "type": "string" - }, - { - "name": "recognizeRequest", - "in": "body", - "description": "The media recognize request", - "required": true, - "schema": { - "$ref": "#/definitions/RecognizeRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "The service has accepted the recognize request and will begin processing it. You will receive either RecognizeCompleted or RecognizeFailed event at your specified callback URI to update you on the status of the request." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallMedia_Recognize": { - "$ref": "./examples/CallMedia_Recognize.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}:startContinuousDtmfRecognition": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Start continuous Dtmf recognition by subscribing to tones.", - "operationId": "CallMedia_StartContinuousDtmfRecognition", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id", - "required": true, - "type": "string" - }, - { - "name": "continuousDtmfRecognitionRequest", - "in": "body", - "description": "The continuous recognize request", - "required": true, - "schema": { - "$ref": "#/definitions/ContinuousDtmfRecognitionRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The service has accepted the start continuous recognize request and will begin processing it. You will receive events at your specified callback URI to update you on the status of the request." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallMedia_StartContinuousDtmfRecognition": { - "$ref": "./examples/CallMedia_StartContinuousDtmfRecognition.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}:stopContinuousDtmfRecognition": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Stop continuous Dtmf recognition by unsubscribing to tones.", - "operationId": "CallMedia_StopContinuousDtmfRecognition", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id", - "required": true, - "type": "string" - }, - { - "name": "continuousDtmfRecognitionRequest", - "in": "body", - "description": "The continuous recognize request", - "required": true, - "schema": { - "$ref": "#/definitions/ContinuousDtmfRecognitionRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The service has accepted the stop continuous recognize request and will begin processing it. You will receive events at your specified callback URI to update you on the status of the request." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallMedia_StopContinuousDtmfRecognition": { - "$ref": "./examples/CallMedia_StopContinuousDtmfRecognition.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}:sendDtmf": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Send dtmf tones.", - "description": "Send dtmf tones.", - "operationId": "CallMedia_SendDtmf", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id", - "required": true, - "type": "string" - }, - { - "name": "sendDtmfRequest", - "in": "body", - "description": "The send dtmf request", - "required": true, - "schema": { - "$ref": "#/definitions/SendDtmfRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Returns the send dtmf response" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallMedia_SendDtmf": { - "$ref": "./examples/CallMedia_SendDtmf.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}:updateTranscriptionData": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "UpdateTranscriptionData Api.", - "description": "API to change transcription language.", - "operationId": "CallMedia_UpdateTranscriptionData", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id", - "required": true, - "type": "string" - }, - { - "name": "updateTranscriptionDataRequest", - "in": "body", - "description": "The updateTranscriptionData request", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateTranscriptionDataRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Returns the update transcription data response" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallMedia_UpdateTranscriptionData": { - "$ref": "./examples/CallMedia_UpdateTranscriptionData.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}/dialogs/{dialogId}": { - "put": { - "tags": [ - "MidConnections" - ], - "summary": "Start a dialog targeting a particular participant on the call.", - "description": "Start a dialog.", - "operationId": "CallDialog_StartDialog", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id", - "required": true, - "type": "string" - }, - { - "name": "dialogId", - "in": "path", - "description": "The dialog id", - "required": true, - "type": "string" - }, - { - "name": "startDialogRequest", - "in": "body", - "description": "The start dialog request", - "required": true, - "schema": { - "$ref": "#/definitions/StartDialogRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "Returns the start dialog response.", - "schema": { - "$ref": "#/definitions/DialogStateResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallDialog_StartDialog": { - "$ref": "./examples/CallDialog_StartDialog.json" - } - } - }, - "delete": { - "tags": [ - "MidConnections" - ], - "summary": "Stop a dialog.", - "description": "Stop a dialog.", - "operationId": "CallDialog_StopDialog", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id", - "required": true, - "type": "string" - }, - { - "name": "dialogId", - "in": "path", - "description": "The dialog id", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Returns no content for stop dialog response." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallDialog_StopDialog": { - "$ref": "./examples/CallDialog_StopDialog.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}/participants": { - "get": { - "tags": [ - "MidConnections" - ], - "summary": "Get participants from a call. Recording and transcription bots are omitted from this list.", - "description": "Get participants from a call. Recording and transcription bots are omitted from this list.", - "operationId": "CallConnection_GetParticipants", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection Id", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Returns the get participants response.", - "schema": { - "$ref": "#/definitions/GetParticipantsResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallConnection_GetParticipants": { - "$ref": "./examples/CallConnection_GetParticipants.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "values" - } - } - }, - "/calling/callConnections/{callConnectionId}/participants:add": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Add participants to the call.", - "description": "Add participants to the call.", - "operationId": "CallConnection_AddParticipant", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection Id", - "required": true, - "type": "string" - }, - { - "name": "addParticipantRequest", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AddParticipantRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "202": { - "description": "The service has accepted the add participant request and will begin processing it. You will receive either AddParticipantSucceeded or AddParticipantFailed event at your specified callback URI to update you on the status of the request.", - "schema": { - "$ref": "#/definitions/AddParticipantResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallConnection_AddParticipant": { - "$ref": "./examples/CallConnection_AddParticipant.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}/participants:remove": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Remove participant from the call using identifier.", - "description": "Remove participant from the call using identifier.", - "operationId": "CallConnection_RemoveParticipant", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" - }, - { - "name": "removeParticipantRequest", - "in": "body", - "description": "The participant to be removed from the call.", - "required": true, - "schema": { - "$ref": "#/definitions/RemoveParticipantRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "202": { - "description": "The service has accepted the remove participant request and will begin processing it. You will receive either RemoveParticipantSucceeded or RemoveParticipantFailed event at your specified callback URI to update you on the status of the request.", - "schema": { - "$ref": "#/definitions/RemoveParticipantResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallConnection_RemoveParticipant": { - "$ref": "./examples/CallConnection_RemoveParticipant.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}/participants:mute": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Mute participants from the call using identifier.", - "description": "Mute participants from the call using identifier.", - "operationId": "CallConnection_Mute", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" - }, - { - "name": "muteParticipantsRequest", - "in": "body", - "description": "The participants to be muted from the call.", - "required": true, - "schema": { - "$ref": "#/definitions/MuteParticipantsRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "202": { - "description": "Returns the mute participants response", - "schema": { - "$ref": "#/definitions/MuteParticipantsResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallConnection_Mute": { - "$ref": "./examples/CallConnection_Mute.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}/participants:unmute": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Unmute participants from the call using identifier.", - "description": "Unmute participants from the call using identifier.", - "operationId": "CallConnection_Unmute", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection id.", - "required": true, - "type": "string" - }, - { - "name": "unmuteParticipantsRequest", - "in": "body", - "description": "The participants to be unmuted from the call.", - "required": true, - "schema": { - "$ref": "#/definitions/UnmuteParticipantsRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "202": { - "description": "Returns the unmute participants response", - "schema": { - "$ref": "#/definitions/UnmuteParticipantsResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallConnection_Unmute": { - "$ref": "./examples/CallConnection_Unmute.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}/participants:cancelAddParticipant": { - "post": { - "tags": [ - "MidConnections" - ], - "summary": "Cancel add participant operation.", - "description": "Cancel add participant operation.", - "operationId": "CallConnection_CancelAddParticipant", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection Id", - "required": true, - "type": "string" - }, - { - "name": "cancelAddParticipantRequest", - "in": "body", - "description": "Cancellation request.", - "required": true, - "schema": { - "$ref": "#/definitions/CancelAddParticipantRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "202": { - "description": "Returns the cancelAddParticipant response", - "schema": { - "$ref": "#/definitions/CancelAddParticipantResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallConnection_CancelAddParticipant": { - "$ref": "./examples/CallConnection_CancelAddParticipant.json" - } - } - } - }, - "/calling/callConnections/{callConnectionId}/participants/{participantRawId}": { - "get": { - "tags": [ - "MidConnections" - ], - "summary": "Get participant from a call.", - "description": "Get participant from a call.", - "operationId": "CallConnection_GetParticipant", - "parameters": [ - { - "name": "callConnectionId", - "in": "path", - "description": "The call connection Id", - "required": true, - "type": "string" - }, - { - "name": "participantRawId", - "in": "path", - "description": "Raw id of the participant to retrieve.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Returns the detail of the requested participant.", - "schema": { - "$ref": "#/definitions/CallParticipant" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallConnection_GetParticipant": { - "$ref": "./examples/CallConnection_GetParticipant.json" - } - } - } - }, - "/calling/recordings": { - "post": { - "tags": [ - "Recording" - ], - "summary": "Start recording the call.", - "operationId": "CallRecording_StartRecording", - "parameters": [ - { - "name": "startCallRecording", - "in": "body", - "description": "The request body of start call recording request.", - "required": true, - "schema": { - "$ref": "#/definitions/StartCallRecordingRequest" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "Repeatability-Request-ID", - "in": "header", - "description": "If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.", - "type": "string", - "format": "uuid" - }, - { - "name": "Repeatability-First-Sent", - "in": "header", - "description": "If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.", - "type": "string", - "format": "date-time-rfc1123" - } - ], - "responses": { - "200": { - "description": "Returns the start call recording response.", - "schema": { - "$ref": "#/definitions/RecordingStateResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallRecording_StartRecording": { - "$ref": "./examples/CallRecording_StartRecording.json" - } - } - } - }, - "/calling/recordings/{recordingId}": { - "get": { - "tags": [ - "Recording" - ], - "summary": "Get call recording properties.", - "operationId": "CallRecording_GetRecordingProperties", - "parameters": [ - { - "name": "recordingId", - "in": "path", - "description": "The recording id.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Returns the recording properties.", - "schema": { - "$ref": "#/definitions/RecordingStateResponse" - } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallRecording_GetRecordingProperties": { - "$ref": "./examples/CallRecording_GetRecordingProperties.json" - } - } - }, - "delete": { - "tags": [ - "Recording" - ], - "summary": "Stop recording the call.", - "operationId": "CallRecording_StopRecording", - "parameters": [ - { - "name": "recordingId", - "in": "path", - "description": "The recording id.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Returns the stop call recording response." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallRecording_StopRecording": { - "$ref": "./examples/CallRecording_StopRecording.json" - } - } - } - }, - "/calling/recordings/{recordingId}:pause": { - "post": { - "tags": [ - "Recording" - ], - "summary": "Pause recording the call.", - "operationId": "CallRecording_PauseRecording", - "parameters": [ - { - "name": "recordingId", - "in": "path", - "description": "The recording id.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "The service has accepted the pause request and will begin processing it." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallRecording_PauseRecording": { - "$ref": "./examples/CallRecording_PauseRecording.json" - } - } - } - }, - "/calling/recordings/{recordingId}:resume": { - "post": { - "tags": [ - "Recording" - ], - "summary": "Resume recording the call.", - "operationId": "CallRecording_ResumeRecording", - "parameters": [ - { - "name": "recordingId", - "in": "path", - "description": "The recording id.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "The service has accepted the resume request and will begin processing it." - }, - "default": { - "description": "Error", - "schema": { - "$ref": "#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "CallRecording_ResumeRecording": { - "$ref": "./examples/CallRecording_ResumeRecording.json" - } - } - } - } - }, - "definitions": { - "CreateCallRequest": { - "description": "The request payload for creating the call.", - "required": [ - "targets", - "callbackUri" - ], - "type": "object", - "properties": { - "targets": { - "description": "The targets of the call.", - "type": "array", - "items": { - "$ref": "#/definitions/CommunicationIdentifierModel" - } - }, - "sourceCallerIdNumber": { - "$ref": "#/definitions/PhoneNumberIdentifierModel", - "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when calling a PSTN callee." - }, - "sourceDisplayName": { - "description": "Display name of the call if dialing out to a pstn number", - "type": "string" - }, - "sourceIdentity": { - "$ref": "#/definitions/CommunicationUserIdentifierModel", - "description": "The identifier of the source of the call" - }, - "operationContext": { - "description": "A customer set value used to track the answering of a call.", - "type": "string" - }, - "callbackUri": { - "description": "The callback URI.", - "type": "string" - }, - "mediaStreamingConfiguration": { - "$ref": "#/definitions/MediaStreamingConfiguration", - "description": "Media Streaming Configuration." - }, - "transcriptionConfiguration": { - "$ref": "#/definitions/TranscriptionConfiguration", - "description": "Live Transcription Configuration." - }, - "azureCognitiveServicesEndpointUrl": { - "description": "The identifier of the Cognitive Service resource assigned to this call.", - "type": "string" - }, - "customContext": { - "$ref": "#/definitions/CustomContext", - "description": "Used by customer to send custom context to targets" - } - } - }, - "CommunicationIdentifierModel": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationIdentifierModel" - }, - "PhoneNumberIdentifierModel": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/PhoneNumberIdentifierModel" - }, - "CommunicationUserIdentifierModel": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationUserIdentifierModel" - }, - "MediaStreamingTransportType": { - "description": "The type of transport to be used for media streaming, eg. Websocket", - "enum": [ - "websocket" - ], - "type": "string", - "x-ms-enum": { - "name": "MediaStreamingTransportType", - "modelAsString": true - } - }, - "MediaStreamingContentType": { - "description": "Content type to stream, eg. audio, audio/video", - "enum": [ - "audio" - ], - "type": "string", - "x-ms-enum": { - "name": "MediaStreamingContentType", - "modelAsString": true - } - }, - "MediaStreamingAudioChannelType": { - "description": "Audio channel type to stream, eg. unmixed audio, mixed audio", - "enum": [ - "mixed", - "unmixed" - ], - "type": "string", - "x-ms-enum": { - "name": "MediaStreamingAudioChannelType", - "modelAsString": true - } - }, - "MediaStreamingConfiguration": { - "description": "Configuration of Media streaming.", - "required": [ - "transportUrl", - "transportType", - "contentType", - "audioChannelType" - ], - "type": "object", - "properties": { - "transportUrl": { - "description": "Transport URL for media streaming", - "type": "string" - }, - "transportType": { - "$ref": "#/definitions/MediaStreamingTransportType" - }, - "contentType": { - "$ref": "#/definitions/MediaStreamingContentType" - }, - "audioChannelType": { - "$ref": "#/definitions/MediaStreamingAudioChannelType" - } - } - }, - "TranscriptionTransportType": { - "description": "The type of transport to be used for live transcription, eg. Websocket", - "enum": [ - "websocket" - ], - "type": "string", - "x-ms-enum": { - "name": "TranscriptionTransportType", - "modelAsString": true - } - }, - "TranscriptionConfiguration": { - "description": "Configuration of live transcription.", - "required": [ - "transportUrl", - "transportType", - "locale", - "startTranscription" - ], - "type": "object", - "properties": { - "transportUrl": { - "description": "Transport URL for live transcription", - "type": "string" - }, - "transportType": { - "$ref": "#/definitions/TranscriptionTransportType" - }, - "locale": { - "description": "Defines the locale for the data e.g en-CA, en-AU", - "type": "string" - }, - "startTranscription": { - "description": "Determines if the transcription should be started immediately after call is answered or not.", - "type": "boolean" - } - } - }, - "CustomContext": { - "type": "object", - "properties": { - "voipHeaders": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "sipHeaders": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "CommunicationErrorResponse": { - "$ref": "../../../Common/stable/2022-07-13/common.json#/definitions/CommunicationErrorResponse" - }, - "CallConnectionStateModel": { - "description": "The state of the call connection.", - "enum": [ - "unknown", - "connecting", - "connected", - "transferring", - "transferAccepted", - "disconnecting", - "disconnected" - ], - "type": "string", - "x-ms-enum": { - "name": "CallConnectionStateModel", - "modelAsString": true - } - }, - "CallConnectionProperties": { - "description": "Properties of a call connection", - "type": "object", - "properties": { - "callConnectionId": { - "description": "The call connection id.", - "type": "string" - }, - "serverCallId": { - "description": "The server call id.", - "type": "string" - }, - "targets": { - "description": "The targets of the call.", - "type": "array", - "items": { - "$ref": "#/definitions/CommunicationIdentifierModel" - } - }, - "callConnectionState": { - "$ref": "#/definitions/CallConnectionStateModel" - }, - "callbackUri": { - "description": "The callback URI.", - "type": "string" - }, - "mediaSubscriptionId": { - "description": "SubscriptionId for media streaming", - "type": "string" - }, - "dataSubscriptionId": { - "description": "SubscriptionId for transcription", - "type": "string" - }, - "sourceCallerIdNumber": { - "$ref": "#/definitions/PhoneNumberIdentifierModel", - "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when calling a PSTN callee." - }, - "sourceDisplayName": { - "description": "Display name of the call if dialing out to a pstn number.", - "type": "string" - }, - "sourceIdentity": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Source identity." - }, - "correlationId": { - "description": "The correlation ID.", - "type": "string" - }, - "answeredByIdentifier": { - "$ref": "#/definitions/CommunicationUserIdentifierModel", - "description": "Identity of the answering entity. Only populated when identity is provided in the request." - } - } - }, - "AnswerCallRequest": { - "description": "The request payload for answering the call.", - "required": [ - "incomingCallContext", - "callbackUri" - ], - "type": "object", - "properties": { - "incomingCallContext": { - "description": "The context associated with the call.", - "type": "string" - }, - "callbackUri": { - "description": "The callback uri.", - "type": "string" - }, - "operationContext": { - "description": "A customer set value used to track the answering of a call.", - "type": "string" - }, - "mediaStreamingConfiguration": { - "$ref": "#/definitions/MediaStreamingConfiguration", - "description": "Media Streaming Configuration." - }, - "transcriptionConfiguration": { - "$ref": "#/definitions/TranscriptionConfiguration", - "description": "Live Transcription Configuration." - }, - "azureCognitiveServicesEndpointUrl": { - "description": "The endpoint URL of the Azure Cognitive Services resource attached", - "type": "string" - }, - "answeredByIdentifier": { - "$ref": "#/definitions/CommunicationUserIdentifierModel", - "description": "The identifier of the call automation entity which answers the call" - } - } - }, - "RedirectCallRequest": { - "description": "The request payload for redirecting the call.", - "required": [ - "incomingCallContext", - "target" - ], - "type": "object", - "properties": { - "incomingCallContext": { - "description": "The context associated with the call.", - "type": "string" - }, - "target": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The target identity to redirect the call to." - }, - "customContext": { - "$ref": "#/definitions/CustomContext", - "description": "Used by customer to send custom context to targets" - } - } - }, - "CallRejectReason": { - "description": "The rejection reason.", - "enum": [ - "none", - "busy", - "forbidden" - ], - "type": "string", - "x-ms-enum": { - "name": "CallRejectReason", - "modelAsString": true - } - }, - "RejectCallRequest": { - "description": "The request payload for rejecting the call.", - "required": [ - "incomingCallContext" - ], - "type": "object", - "properties": { - "incomingCallContext": { - "description": "The context associated with the call.", - "type": "string" - }, - "callRejectReason": { - "$ref": "#/definitions/CallRejectReason" - } - } - }, - "TransferToParticipantRequest": { - "description": "The request payload for transferring call to a participant.", - "required": [ - "targetParticipant" - ], - "type": "object", - "properties": { - "targetParticipant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The identity of the target where call should be transferred to." - }, - "customContext": { - "$ref": "#/definitions/CustomContext", - "description": "Used by customer to send custom context to targets" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "transferee": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Transferee is the participant who is transferring the call." - }, - "callbackUri": { - "description": "The callback URI to override the main callback URI.", - "type": "string" - } - } - }, - "TransferCallResponse": { - "description": "The response payload for transferring the call.", - "type": "object", - "properties": { - "operationContext": { - "description": "The operation context provided by client.", - "type": "string" - } - } - }, - "PlayRequest": { - "required": [ - "playSourceInfo" - ], - "type": "object", - "properties": { - "playSourceInfo": { - "$ref": "#/definitions/PlaySource", - "description": "The source of the audio to be played." - }, - "playTo": { - "description": "The list of call participants play provided audio to.\r\nPlays to everyone in the call when not provided.", - "type": "array", - "items": { - "$ref": "#/definitions/CommunicationIdentifierModel" - } - }, - "playOptions": { - "$ref": "#/definitions/PlayOptions", - "description": "Defines options for playing the audio." - }, - "operationContext": { - "description": "The value to identify context of the operation.", - "type": "string" - }, - "callbackUri": { - "description": "The callback URI to override the main callback URI.", - "type": "string" - } - } - }, - "PlaySourceType": { - "description": "Defines the type of the play source", - "enum": [ - "file", - "text", - "ssml" - ], - "type": "string", - "x-ms-enum": { - "name": "PlaySourceType", - "modelAsString": true - } - }, - "PlaySource": { - "required": [ - "sourceType" - ], - "type": "object", - "properties": { - "sourceType": { - "$ref": "#/definitions/PlaySourceType" - }, - "playSourceId": { - "description": "Defines the identifier to be used for caching related media", - "type": "string" - }, - "fileSource": { - "$ref": "#/definitions/FileSource", - "description": "Defines the file source info to be used for play" - }, - "textSource": { - "$ref": "#/definitions/TextSource", - "description": "Defines the text source info to be used for play" - }, - "ssmlSource": { - "$ref": "#/definitions/SsmlSource", - "description": "Defines the ssml(Speech Synthesis Markup Language) source info to be used for play" - } - } - }, - "PlayOptions": { - "required": [ - "loop" - ], - "type": "object", - "properties": { - "loop": { - "description": "The option to play the provided audio source in loop when set to true", - "type": "boolean" - } - } - }, - "FileSource": { - "required": [ - "uri" - ], - "type": "object", - "properties": { - "uri": { - "description": "Uri for the audio file to be played", - "type": "string" - } - } - }, - "Gender": { - "description": "Voice gender type", - "enum": [ - "male", - "female" - ], - "type": "string", - "x-ms-enum": { - "name": "Gender", - "modelAsString": true - } - }, - "TextSource": { - "required": [ - "text" - ], - "type": "object", - "properties": { - "text": { - "description": "Text for the cognitive service to be played", - "type": "string" - }, - "sourceLocale": { - "description": "Source language locale to be played\r\nRefer to available locales here: ", - "type": "string" - }, - "voiceGender": { - "$ref": "#/definitions/Gender" - }, - "voiceName": { - "description": "Voice name to be played\r\nRefer to available Text-to-speech voices here: ", - "type": "string" - }, - "customVoiceEndpointId": { - "description": "Endpoint where the custom voice was deployed.", - "type": "string" - } - } - }, - "SsmlSource": { - "required": [ - "ssmlText" - ], - "type": "object", - "properties": { - "ssmlText": { - "description": "Ssml string for the cognitive service to be played", - "type": "string" - }, - "customVoiceEndpointId": { - "description": "Endpoint where the custom voice was deployed.", - "type": "string" - } - } - }, - "StartTranscriptionRequest": { - "type": "object", - "properties": { - "locale": { - "description": "Defines Locale for the transcription e,g en-US", - "type": "string" - }, - "operationContext": { - "description": "The value to identify context of the operation.", - "type": "string" - } - } - }, - "StopTranscriptionRequest": { - "type": "object", - "properties": { - "operationContext": { - "description": "The value to identify context of the operation.", - "type": "string" - } - } - }, - "RecognizeInputType": { - "description": "Determines the type of the recognition.", - "enum": [ - "dtmf", - "speech", - "speechOrDtmf", - "choices" - ], - "type": "string", - "x-ms-enum": { - "name": "RecognizeInputType", - "modelAsString": true - } - }, - "RecognizeRequest": { - "required": [ - "recognizeInputType", - "recognizeOptions" - ], - "type": "object", - "properties": { - "recognizeInputType": { - "$ref": "#/definitions/RecognizeInputType" - }, - "playPrompt": { - "$ref": "#/definitions/PlaySource", - "description": "The source of the audio to be played for recognition." - }, - "interruptCallMediaOperation": { - "description": "If set recognize can barge into other existing queued-up/currently-processing requests.", - "type": "boolean" - }, - "recognizeOptions": { - "$ref": "#/definitions/RecognizeOptions", - "description": "Defines options for recognition." - }, - "operationContext": { - "description": "The value to identify context of the operation.", - "type": "string" - }, - "callbackUri": { - "description": "The callback URI to override the main callback URI.", - "type": "string" - } - } - }, - "RecognizeOptions": { - "required": [ - "targetParticipant" - ], - "type": "object", - "properties": { - "interruptPrompt": { - "description": "Determines if we interrupt the prompt and start recognizing.", - "type": "boolean" - }, - "initialSilenceTimeoutInSeconds": { - "format": "int32", - "description": "Time to wait for first input after prompt (if any).", - "maximum": 300, - "minimum": 0, - "type": "integer" - }, - "targetParticipant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Target participant of DTMF tone recognition." - }, - "speechLanguage": { - "description": "Speech language to be recognized, If not set default is en-US", - "type": "string" - }, - "speechRecognitionModelEndpointId": { - "description": "Endpoint where the custom model was deployed.", - "type": "string" - }, - "dtmfOptions": { - "$ref": "#/definitions/DtmfOptions", - "description": "Defines configurations for DTMF." - }, - "choices": { - "description": "Defines Ivr choices for recognize.", - "type": "array", - "items": { - "$ref": "#/definitions/Choice" - } - }, - "speechOptions": { - "$ref": "#/definitions/SpeechOptions", - "description": "Defines continuous speech recognition option." - } - } - }, - "Tone": { - "enum": [ - "zero", - "one", - "two", - "three", - "four", - "five", - "six", - "seven", - "eight", - "nine", - "a", - "b", - "c", - "d", - "pound", - "asterisk" - ], - "type": "string", - "x-ms-enum": { - "name": "Tone", - "modelAsString": true - } - }, - "DtmfOptions": { - "description": "Options for DTMF recognition", - "type": "object", - "properties": { - "interToneTimeoutInSeconds": { - "format": "int32", - "description": "Time to wait between DTMF inputs to stop recognizing.", - "maximum": 60, - "minimum": 1, - "type": "integer" - }, - "maxTonesToCollect": { - "format": "int32", - "description": "Maximum number of DTMF tones to be collected.", - "type": "integer" - }, - "stopTones": { - "description": "List of tones that will stop recognizing.", - "type": "array", - "items": { - "$ref": "#/definitions/Tone" - } - } - } - }, - "Choice": { - "required": [ - "label", - "phrases" - ], - "type": "object", - "properties": { - "label": { - "description": "Identifier for a given choice", - "type": "string" - }, - "phrases": { - "description": "List of phrases to recognize", - "type": "array", - "items": { - "type": "string" - } - }, - "tone": { - "$ref": "#/definitions/Tone" - } - } - }, - "SpeechOptions": { - "description": "Options for continuous speech recognition", - "type": "object", - "properties": { - "endSilenceTimeoutInMs": { - "format": "int64", - "description": "The length of end silence when user stops speaking and cogservice send response.", - "type": "integer" - } - } - }, - "ContinuousDtmfRecognitionRequest": { - "required": [ - "targetParticipant" - ], - "type": "object", - "properties": { - "targetParticipant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Defines options for recognition." - }, - "operationContext": { - "description": "The value to identify context of the operation.", - "type": "string" - }, - "callbackUri": { - "description": "The callback URI to override the main callback URI.", - "type": "string" - } - } - }, - "SendDtmfRequest": { - "required": [ - "tones", - "targetParticipant" - ], - "type": "object", - "properties": { - "tones": { - "description": "List of tones to be sent to target participant.", - "type": "array", - "items": { - "$ref": "#/definitions/Tone" - } - }, - "targetParticipant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Target participant of send DTMF." - }, - "operationContext": { - "description": "The value to identify context of the operation.", - "type": "string" - }, - "callbackUri": { - "description": "The callback URI to override the main callback URI.", - "type": "string" - } - } - }, - "UpdateTranscriptionDataRequest": { - "required": [ - "locale" - ], - "type": "object", - "properties": { - "locale": { - "description": "Defines new locale for transcription.", - "type": "string" - } - } - }, - "DialogInputType": { - "description": "Determines the type of the dialog.", - "enum": [ - "powerVirtualAgents", - "azureOpenAI" - ], - "type": "string", - "x-ms-enum": { - "name": "DialogInputType", - "modelAsString": true - } - }, - "StartDialogRequest": { - "required": [ - "dialogOptions", - "dialogInputType" - ], - "type": "object", - "properties": { - "dialogOptions": { - "$ref": "#/definitions/DialogOptions", - "description": "Defines options for dialog." - }, - "dialogInputType": { - "$ref": "#/definitions/DialogInputType" - }, - "operationContext": { - "description": "The value to identify context of the operation.", - "type": "string" - } - } - }, - "DialogOptions": { - "required": [ - "dialogContext" - ], - "type": "object", - "properties": { - "botAppId": { - "description": "Bot identifier.", - "type": "string" - }, - "dialogContext": { - "description": "Dialog context.", - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - }, - "DialogStateResponse": { - "type": "object", - "properties": { - "dialogId": { - "description": "The dialog ID.", - "type": "string" - }, - "dialogOptions": { - "$ref": "#/definitions/DialogOptions", - "description": "Defines options for dialog." - }, - "dialogInputType": { - "$ref": "#/definitions/DialogInputType" - }, - "operationContext": { - "description": "The value to identify context of the operation.", - "type": "string" - } - } - }, - "GetParticipantsResponse": { - "description": "The response payload for getting participants of the call.", - "type": "object", - "properties": { - "values": { - "description": "List of the current participants in the call.", - "type": "array", - "items": { - "$ref": "#/definitions/CallParticipant" - } - }, - "nextLink": { - "description": "Continue of the list of participants", - "type": "string" - } - } - }, - "CallParticipant": { - "description": "Contract model of an ACS call participant", - "type": "object", - "properties": { - "identifier": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Communication identifier of the participant" - }, - "isMuted": { - "description": "Is participant muted", - "type": "boolean" - } - } - }, - "AddParticipantRequest": { - "description": "The request payload for adding participant to the call.", - "required": [ - "participantToAdd" - ], - "type": "object", - "properties": { - "sourceCallerIdNumber": { - "$ref": "#/definitions/PhoneNumberIdentifierModel", - "description": "The source caller Id, a phone number, that's shown to the PSTN participant being invited.\r\nRequired only when inviting a PSTN participant." - }, - "sourceDisplayName": { - "description": "(Optional) The display name of the source that is associated with this invite operation when\r\nadding a PSTN participant or teams user. Note: Will not update the display name in the roster.", - "type": "string" - }, - "participantToAdd": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The participant to invite." - }, - "invitationTimeoutInSeconds": { - "format": "int32", - "description": "Gets or sets the timeout to wait for the invited participant to pickup.\r\nThe maximum value of this is 180 seconds", - "maximum": 180, - "minimum": 0, - "type": "integer" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "customContext": { - "$ref": "#/definitions/CustomContext", - "description": "Used by customer to send custom context to targets" - }, - "callbackUri": { - "description": "The callback URI to override the main callback URI.", - "type": "string" - } - } - }, - "AddParticipantResponse": { - "description": "The response payload for adding participants to the call.", - "type": "object", - "properties": { - "participant": { - "$ref": "#/definitions/CallParticipant", - "description": "List of current participants in the call." - }, - "operationContext": { - "description": "The operation context provided by client.", - "type": "string" - }, - "invitationId": { - "description": "Invitation ID used to add a participant.", - "type": "string" - } - } - }, - "RemoveParticipantRequest": { - "description": "The remove participant by identifier request.", - "required": [ - "participantToRemove" - ], - "type": "object", - "properties": { - "participantToRemove": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The participants to be removed from the call." - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "callbackUri": { - "description": "The callback URI to override the main callback URI.", - "type": "string" - } - } - }, - "RemoveParticipantResponse": { - "description": "The response payload for removing participants of the call.", - "type": "object", - "properties": { - "operationContext": { - "description": "The operation context provided by client.", - "type": "string" - } - } - }, - "MuteParticipantsRequest": { - "description": "The request payload for muting participants from the call.", - "required": [ - "targetParticipants" - ], - "type": "object", - "properties": { - "targetParticipants": { - "description": "Participants to be muted from the call.\r\nOnly ACS Users are supported.", - "type": "array", - "items": { - "$ref": "#/definitions/CommunicationIdentifierModel" - } - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - } - } - }, - "MuteParticipantsResponse": { - "description": "The response payload for muting participants from the call.", - "type": "object", - "properties": { - "operationContext": { - "description": "The operation context provided by client.", - "type": "string" - } - } - }, - "UnmuteParticipantsRequest": { - "description": "The request payload for unmuting participant from the call.", - "required": [ - "targetParticipants" - ], - "type": "object", - "properties": { - "targetParticipants": { - "description": "Participants to be unmuted from the call.\r\nOnly ACS Users are supported.", - "type": "array", - "items": { - "$ref": "#/definitions/CommunicationIdentifierModel" - } - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - } - } - }, - "UnmuteParticipantsResponse": { - "description": "The response payload for unmuting participants from the call.", - "type": "object", - "properties": { - "operationContext": { - "description": "The operation context provided by client.", - "type": "string" - } - } - }, - "CancelAddParticipantRequest": { - "required": [ - "invitationId" - ], - "type": "object", - "properties": { - "invitationId": { - "description": "Invitation ID used to add a participant.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "callbackUri": { - "description": "The callback URI to override the main callback URI.", - "type": "string" - } - } - }, - "CancelAddParticipantResponse": { - "type": "object", - "properties": { - "invitationId": { - "description": "Invitation ID used to cancel the add participant action.", - "type": "string" - }, - "operationContext": { - "description": "The operation context provided by client.", - "type": "string" - } - } - }, - "RecordingContentType": { - "description": "The content type of call recording.", - "enum": [ - "audio", - "audioVideo" - ], - "type": "string", - "x-ms-enum": { - "name": "RecordingContentType", - "modelAsString": true - } - }, - "RecordingChannelType": { - "description": "The channel type of call recording.", - "enum": [ - "mixed", - "unmixed" - ], - "type": "string", - "x-ms-enum": { - "name": "RecordingChannelType", - "modelAsString": true - } - }, - "RecordingFormatType": { - "description": "The format type of call recording.", - "enum": [ - "wav", - "mp3", - "mp4" - ], - "type": "string", - "x-ms-enum": { - "name": "RecordingFormatType", - "modelAsString": true - } - }, - "StartCallRecordingRequest": { - "description": "The request payload start for call recording operation with call locator.", - "required": [ - "callLocator" - ], - "type": "object", - "properties": { - "callLocator": { - "$ref": "#/definitions/CallLocator", - "description": "The call locator." - }, - "recordingStateCallbackUri": { - "description": "The uri to send notifications to.", - "type": "string" - }, - "recordingContentType": { - "$ref": "#/definitions/RecordingContentType" - }, - "recordingChannelType": { - "$ref": "#/definitions/RecordingChannelType" - }, - "recordingFormatType": { - "$ref": "#/definitions/RecordingFormatType" - }, - "audioChannelParticipantOrdering": { - "description": "The sequential order in which audio channels are assigned to participants in the unmixed recording.\r\nWhen 'recordingChannelType' is set to 'unmixed' and `audioChannelParticipantOrdering is not specified,\r\nthe audio channel to participant mapping will be automatically assigned based on the order in which participant\r\nfirst audio was detected. Channel to participant mapping details can be found in the metadata of the recording.", - "type": "array", - "items": { - "$ref": "#/definitions/CommunicationIdentifierModel" - } - }, - "channelAffinity": { - "description": "The channel affinity of call recording\r\nWhen 'recordingChannelType' is set to 'unmixed', if channelAffinity is not specified, 'channel' will be automatically assigned.\r\nChannel-Participant mapping details can be found in the metadata of the recording.\r\n///", - "type": "array", - "items": { - "$ref": "#/definitions/ChannelAffinity" - } - }, - "externalStorage": { - "$ref": "#/definitions/ExternalStorage", - "description": "Optional property to specify location where recording will be stored" - }, - "pauseOnStart": { - "description": "When set to true will start recording in Pause mode, which could be resumed.", - "type": "boolean" - } - } - }, - "CallLocatorKind": { - "description": "The call locator kind.", - "enum": [ - "groupCallLocator", - "serverCallLocator" - ], - "type": "string", - "x-ms-enum": { - "name": "CallLocatorKind", - "modelAsString": true - } - }, - "CallLocator": { - "description": "The locator used for joining or taking action on a call.", - "type": "object", - "properties": { - "groupCallId": { - "description": "The group call id", - "type": "string" - }, - "serverCallId": { - "description": "The server call id.", - "type": "string" - }, - "kind": { - "$ref": "#/definitions/CallLocatorKind" - } - } - }, - "ChannelAffinity": { - "description": "Channel affinity for a participant", - "required": [ - "participant" - ], - "type": "object", - "properties": { - "channel": { - "format": "int32", - "description": "Channel number to which bitstream from a particular participant will be written.", - "maximum": 4, - "minimum": 0, - "type": "integer" - }, - "participant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "The identifier for the participant whose bitstream will be written to the channel \r\nrepresented by the channel number." - } - } - }, - "RecordingStorageType": { - "description": "Defines the type of external storage", - "enum": [ - "acs", - "blobStorage" - ], - "type": "string", - "x-ms-enum": { - "name": "RecordingStorageType", - "modelAsString": true - } - }, - "ExternalStorage": { - "required": [ - "storageType" - ], - "type": "object", - "properties": { - "storageType": { - "$ref": "#/definitions/RecordingStorageType" - }, - "blobStorage": { - "$ref": "#/definitions/BlobStorage", - "description": "Defines the blob storage location where the recording will be stored" - } - } - }, - "BlobStorage": { - "description": "Used to specify Blob container url to recording storage", - "required": [ - "containerUri" - ], - "type": "object", - "properties": { - "containerUri": { - "description": "Url of a container or a location within a container", - "type": "string" - } - } - }, - "RecordingState": { - "enum": [ - "active", - "inactive" - ], - "type": "string", - "x-ms-enum": { - "name": "RecordingState", - "modelAsString": true - } - }, - "RecordingType": { - "enum": [ - "acs", - "teams" - ], - "type": "string", - "x-ms-enum": { - "name": "RecordingType", - "modelAsString": true - } - }, - "RecordingStateResponse": { - "type": "object", - "properties": { - "recordingId": { - "type": "string" - }, - "recordingState": { - "$ref": "#/definitions/RecordingState" - }, - "recordingType": { - "$ref": "#/definitions/RecordingType" - } - } - }, - "AddParticipantFailed": { - "description": "The failed to add participant event.", - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services." - }, - "participant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Participant" - } - } - }, - "ResultInformation": { - "type": "object", - "properties": { - "code": { - "format": "int32", - "description": "Code of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected.", - "type": "integer" - }, - "subCode": { - "format": "int32", - "description": "Subcode of the current result. This can be helpful to Call Automation team to troubleshoot the issue if this result was unexpected.", - "type": "integer" - }, - "message": { - "description": "Detail message that describes the current result.", - "type": "string" - } - } - }, - "AddParticipantSucceeded": { - "description": "The participant successfully added event.", - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services." - }, - "participant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Participant" - } - } - }, - "CallConnected": { - "description": "The call connected event.", - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers to set the context for creating a new call. This property will be null for answering a call.", - "type": "string" - } - } - }, - "CallDisconnected": { - "description": "The call disconnected event.", - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers to set the context for creating a new call. This property will be null for answering a call.", - "type": "string" - } - } - }, - "CallTransferAccepted": { - "description": "The call transfer accepted event.", - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services." - }, - "transferTarget": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Traffer target: the user that transferee will be transferred to", - "readOnly": true - }, - "transferee": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Transferee: the participant being transferred away", - "readOnly": true - } - } - }, - "CallTransferFailed": { - "description": "The call transfer failed event.", - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services." - } - } - }, - "ParticipantsUpdated": { - "description": "The participants updated in a call event.", - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "sequenceNumber": { - "format": "int32", - "description": "The Sequence Number of the event", - "type": "integer" - }, - "participants": { - "description": "The list of participants in the call.", - "type": "array", - "items": { - "$ref": "#/definitions/CallParticipant" - } - } - } - }, - "RemoveParticipantSucceeded": { - "description": "The participant removed event.", - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services." - }, - "participant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Participant" - } - } - }, - "RemoveParticipantFailed": { - "description": "The failed to remove participant event.", - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services." - }, - "participant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Participant" - } - } - }, - "AddParticipantCancelled": { - "description": "Successful cancel add participant event.", - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "participant": { - "$ref": "#/definitions/CommunicationIdentifierModel", - "description": "Participant that has been cancelled." - }, - "invitationId": { - "description": "Invitation ID used to cancel the request.", - "type": "string" - } - } - }, - "CancelAddParticipantFailed": { - "description": "Failed cancel add participant event.", - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services." - }, - "invitationId": { - "description": "Invitation ID used to cancel the request.", - "type": "string" - } - } - }, - "RecordingStateChanged": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" - }, - "recordingId": { - "description": "The call recording id", - "type": "string", - "readOnly": true - }, - "state": { - "$ref": "#/definitions/RecordingState" - }, - "startDateTime": { - "format": "date-time", - "description": "The time of the recording started", - "type": "string", - "readOnly": true - } - } - }, - "PlayCompleted": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - } - } - }, - "PlayFailed": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - } - } - }, - "PlayCanceled": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - } - } - }, - "RecognitionType": { - "description": "Determines the sub-type of the recognize operation.\r\nIn case of cancel operation the this field is not set and is returned empty", - "enum": [ - "dtmf", - "speech", - "choices" - ], - "type": "string", - "x-ms-enum": { - "name": "RecognitionType", - "modelAsString": true - } - }, - "RecognizeCompleted": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - }, - "recognitionType": { - "$ref": "#/definitions/RecognitionType" - }, - "collectTonesResult": { - "$ref": "#/definitions/CollectTonesResult", - "description": "Defines the result for RecognitionType = Dtmf\r\nWould be replaced by DtmfResult after server sdk renewed" - }, - "dtmfResult": { - "$ref": "#/definitions/DtmfResult", - "description": "Defines the result for RecognitionType = Dtmf" - }, - "choiceResult": { - "$ref": "#/definitions/ChoiceResult", - "description": "Defines the result for RecognitionType = Choices" - }, - "speechResult": { - "$ref": "#/definitions/SpeechResult", - "description": "Defines the result for RecognitionType = Speech and SpeechOrDtmf", - "readOnly": true - } - } - }, - "CollectTonesResult": { - "type": "object", - "properties": { - "tones": { - "type": "array", - "items": { - "$ref": "#/definitions/Tone" - }, - "readOnly": true - } - } - }, - "DtmfResult": { - "type": "object", - "properties": { - "tones": { - "type": "array", - "items": { - "$ref": "#/definitions/Tone" - }, - "readOnly": true - } - } - }, - "ChoiceResult": { - "type": "object", - "properties": { - "label": { - "description": "Label is the primary identifier for the choice detected", - "type": "string" - }, - "recognizedPhrase": { - "description": "Phrases are set to the value if choice is selected via phrase detection.\r\nIf Dtmf input is recognized, then Label will be the identifier for the choice detected and phrases will be set to null", - "type": "string" - } - } - }, - "SpeechResult": { - "description": "The speech status as a result.", - "type": "object", - "properties": { - "speech": { - "description": "The recognized speech in string.", - "type": "string" - } - } - }, - "RecognizeFailed": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - } - } - }, - "RecognizeCanceled": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - } - } - }, - "DialogCompleted": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "dialogInputType": { - "$ref": "#/definitions/DialogInputType" - }, - "dialogId": { - "description": "Dialog ID", - "type": "string", - "readOnly": true - } - } - }, - "DialogFailed": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "dialogInputType": { - "$ref": "#/definitions/DialogInputType" - }, - "dialogId": { - "description": "Dialog ID", - "type": "string", - "readOnly": true - } - } - }, - "DialogConsent": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "dialogInputType": { - "$ref": "#/definitions/DialogInputType" - }, - "userConsent": { - "$ref": "#/definitions/UserConsent", - "description": "UserConsent data from the Conversation Conductor", - "readOnly": true - }, - "dialogId": { - "description": "Dialog ID", - "type": "string", - "readOnly": true - } - } - }, - "UserConsent": { - "type": "object", - "properties": { - "recording": { - "format": "int32", - "type": "integer" - } - } - }, - "DialogStarted": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "dialogInputType": { - "$ref": "#/definitions/DialogInputType" - }, - "dialogId": { - "description": "Dialog ID", - "type": "string", - "readOnly": true - } - } - }, - "DialogHangup": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "dialogInputType": { - "$ref": "#/definitions/DialogInputType" - }, - "dialogId": { - "description": "Dialog ID", - "type": "string", - "readOnly": true - }, - "ivrContext": { - "description": "Ivr Context", - "type": "object", - "readOnly": true - } - } - }, - "DialogTransfer": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "dialogInputType": { - "$ref": "#/definitions/DialogInputType" - }, - "dialogId": { - "description": "Dialog ID", - "type": "string", - "readOnly": true - }, - "transferType": { - "description": "Transfer type", - "type": "string", - "readOnly": true - }, - "transferDestination": { - "description": "Transfer destination", - "type": "string", - "readOnly": true - }, - "ivrContext": { - "description": "IVR context", - "type": "object", - "readOnly": true - } - } - }, - "DialogLanguageChange": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "dialogInputType": { - "$ref": "#/definitions/DialogInputType" - }, - "dialogId": { - "description": "Dialog ID", - "type": "string", - "readOnly": true - }, - "selectedLanguage": { - "description": "Selected Language", - "type": "string", - "readOnly": true - }, - "ivrContext": { - "description": "Ivr Context", - "type": "object", - "readOnly": true - } - } - }, - "DialogSensitivityUpdate": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "dialogInputType": { - "$ref": "#/definitions/DialogInputType" - }, - "dialogId": { - "description": "Dialog ID", - "type": "string", - "readOnly": true - }, - "sensitiveMask": { - "description": "SensitiveMask", - "type": "boolean", - "readOnly": true - } - } - }, - "ContinuousDtmfRecognitionToneFailed": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - } - } - }, - "ContinuousDtmfRecognitionToneReceived": { - "type": "object", - "properties": { - "toneInfo": { - "$ref": "#/definitions/ToneInfo", - "description": "Information about Tone." - }, - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId or skype chain ID.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - } - } - }, - "ToneInfo": { - "description": "The information about the tone.", - "required": [ - "sequenceId", - "tone" - ], - "type": "object", - "properties": { - "sequenceId": { - "format": "int32", - "description": "The sequence id which can be used to determine if the same tone was played multiple times or if any tones were missed.", - "type": "integer" - }, - "tone": { - "$ref": "#/definitions/Tone" - } - } - }, - "ContinuousDtmfRecognitionStopped": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - } - } - }, - "SendDtmfCompleted": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - } - } - }, - "SendDtmfFailed": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string" - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling mid-call actions to correlate the request to the response event.", - "type": "string" - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code, sub-code and message." - } - } - }, - "TranscriptionStarted": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "transcriptionUpdateResult": { - "$ref": "#/definitions/TranscriptionUpdate", - "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status", - "readOnly": true - } - } - }, - "TranscriptionStatus": { - "enum": [ - "transcriptionStarted", - "transcriptionFailed", - "transcriptionResumed", - "transcriptionLocaleUpdated", - "transcriptionStopped", - "unspecifiedError" - ], - "type": "string", - "x-ms-enum": { - "name": "TranscriptionStatus", - "modelAsString": true - } - }, - "TranscriptionStatusDetails": { - "enum": [ - "subscriptionStarted", - "streamConnectionReestablished", - "streamConnectionUnsuccessful", - "streamUrlMissing", - "serviceShutdown", - "streamConnectionInterrupted", - "speechServicesConnectionError", - "subscriptionStopped", - "unspecifiedError" - ], - "type": "string", - "x-ms-enum": { - "name": "TranscriptionStatusDetails", - "modelAsString": true - } - }, - "TranscriptionUpdate": { - "type": "object", - "properties": { - "transcriptionStatus": { - "$ref": "#/definitions/TranscriptionStatus" - }, - "transcriptionStatusDetails": { - "$ref": "#/definitions/TranscriptionStatusDetails" - } - } - }, - "TranscriptionStopped": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "transcriptionUpdateResult": { - "$ref": "#/definitions/TranscriptionUpdate", - "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status", - "readOnly": true - } - } - }, - "TranscriptionResumed": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "transcriptionUpdateResult": { - "$ref": "#/definitions/TranscriptionUpdate", - "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status", - "readOnly": true - } - } - }, - "TranscriptionFailed": { - "type": "object", - "properties": { - "callConnectionId": { - "description": "Call connection ID.", - "type": "string", - "readOnly": true - }, - "serverCallId": { - "description": "Server call ID.", - "type": "string" - }, - "correlationId": { - "description": "Correlation ID for event to call correlation. Also called ChainId for skype chain ID.", - "type": "string" - }, - "operationContext": { - "description": "Used by customers when calling answerCall action to correlate the request to the response event.", - "type": "string", - "readOnly": true - }, - "resultInformation": { - "$ref": "#/definitions/ResultInformation", - "description": "Contains the resulting SIP code/sub-code and message from NGC services.", - "readOnly": true - }, - "transcriptionUpdateResult": { - "$ref": "#/definitions/TranscriptionUpdate", - "description": "Defines the result for TranscriptionUpdate with the current status and the details about the status", - "readOnly": true - } - } - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Version of API to invoke.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "Endpoint": { - "name": "endpoint", - "in": "path", - "description": "The endpoint of the Azure Communication resource.", - "required": true, - "type": "string", - "format": "url", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "client" - } - }, - "securityDefinitions": { - "Authorization": { - "type": "apiKey", - "description": "An Azure Communication Services user access token.", - "name": "Authorization", - "in": "header" - } - }, - "security": [ - { - "Authorization": [] - } - ], - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - } -} \ No newline at end of file From 538be666989b88c07f776ec70b5f8ad777003c62 Mon Sep 17 00:00:00 2001 From: Amari West Date: Fri, 6 Oct 2023 15:05:35 -0500 Subject: [PATCH 03/20] modified unit tests --- .../tests/CallRecordings/CallRecordingTests.cs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/sdk/communication/Azure.Communication.CallAutomation/tests/CallRecordings/CallRecordingTests.cs b/sdk/communication/Azure.Communication.CallAutomation/tests/CallRecordings/CallRecordingTests.cs index d0d20d894be01..e8f90df0f85fd 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/tests/CallRecordings/CallRecordingTests.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/tests/CallRecordings/CallRecordingTests.cs @@ -194,7 +194,8 @@ private CallRecording getMockCallRecording(int statusCode, string? responseConte RecordingChannel = RecordingChannel.Mixed, RecordingFormat = RecordingFormat.Mp4, AudioChannelParticipantOrdering = { new CommunicationUserIdentifier("test") }, - ChannelAffinity = testChannelAffinities + ChannelAffinity = testChannelAffinities, + PauseOnStart = false, }) }, new Func?[] @@ -236,6 +237,7 @@ private CallRecording getMockCallRecording(int statusCode, string? responseConte RecordingChannel = RecordingChannel.Mixed, RecordingFormat = RecordingFormat.Mp4, ChannelAffinity = testChannelAffinities, + PauseOnStart = false, AudioChannelParticipantOrdering = { new CommunicationUserIdentifier("test"),} }).ConfigureAwait(false), }, From 1bf007875c66cf0628504b1b4cb0867ad90849ea Mon Sep 17 00:00:00 2001 From: Amari West Date: Fri, 6 Oct 2023 17:30:51 -0500 Subject: [PATCH 04/20] undo status code change for mute participant in generated files --- .../src/Generated/CallConnectionRestClient.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs index d15dd650db108..abbaf4191c22e 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs @@ -598,7 +598,7 @@ public async Task> MuteAsync(string callConnect await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); switch (message.Response.Status) { - case 200: + case 202: { MuteParticipantsResult value = default; using var document = await JsonDocument.ParseAsync(message.Response.ContentStream, default, cancellationToken).ConfigureAwait(false); @@ -630,7 +630,7 @@ public Response Mute(string callConnectionId, MutePartic _pipeline.Send(message, cancellationToken); switch (message.Response.Status) { - case 200: + case 202: { MuteParticipantsResult value = default; using var document = JsonDocument.Parse(message.Response.ContentStream); From ac33fbaa18b6d8baf288e7ef81629b5f731db4fd Mon Sep 17 00:00:00 2001 From: Amari West Date: Mon, 9 Oct 2023 10:37:02 -0500 Subject: [PATCH 05/20] merged with main --- .../src/Generated/CallConnectionRestClient.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs index abbaf4191c22e..d15dd650db108 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs @@ -598,7 +598,7 @@ public async Task> MuteAsync(string callConnect await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); switch (message.Response.Status) { - case 202: + case 200: { MuteParticipantsResult value = default; using var document = await JsonDocument.ParseAsync(message.Response.ContentStream, default, cancellationToken).ConfigureAwait(false); @@ -630,7 +630,7 @@ public Response Mute(string callConnectionId, MutePartic _pipeline.Send(message, cancellationToken); switch (message.Response.Status) { - case 202: + case 200: { MuteParticipantsResult value = default; using var document = JsonDocument.Parse(message.Response.ContentStream); From 045b65635b9851cf40f20ba7ed2f7e3d503cc632 Mon Sep 17 00:00:00 2001 From: Amari West Date: Mon, 9 Oct 2023 10:46:30 -0500 Subject: [PATCH 06/20] merged with main --- .../src/Generated/CallConnectionRestClient.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs index d15dd650db108..abbaf4191c22e 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs @@ -598,7 +598,7 @@ public async Task> MuteAsync(string callConnect await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); switch (message.Response.Status) { - case 200: + case 202: { MuteParticipantsResult value = default; using var document = await JsonDocument.ParseAsync(message.Response.ContentStream, default, cancellationToken).ConfigureAwait(false); @@ -630,7 +630,7 @@ public Response Mute(string callConnectionId, MutePartic _pipeline.Send(message, cancellationToken); switch (message.Response.Status) { - case 200: + case 202: { MuteParticipantsResult value = default; using var document = JsonDocument.Parse(message.Response.ContentStream); From 87eb601786155981519222f3350a0d747aa16542 Mon Sep 17 00:00:00 2001 From: Amari West Date: Tue, 10 Oct 2023 18:58:47 -0500 Subject: [PATCH 07/20] reverted 202 change --- .../src/Generated/CallConnectionRestClient.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs index abbaf4191c22e..d15dd650db108 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs @@ -598,7 +598,7 @@ public async Task> MuteAsync(string callConnect await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); switch (message.Response.Status) { - case 202: + case 200: { MuteParticipantsResult value = default; using var document = await JsonDocument.ParseAsync(message.Response.ContentStream, default, cancellationToken).ConfigureAwait(false); @@ -630,7 +630,7 @@ public Response Mute(string callConnectionId, MutePartic _pipeline.Send(message, cancellationToken); switch (message.Response.Status) { - case 202: + case 200: { MuteParticipantsResult value = default; using var document = JsonDocument.Parse(message.Response.ContentStream); From 6cda95f5e1a8e02457ffd56747f137556ef7e369 Mon Sep 17 00:00:00 2001 From: Amari West Date: Wed, 11 Oct 2023 12:14:58 -0500 Subject: [PATCH 08/20] Both status code changed to 202 --- .../src/Generated/CallConnectionRestClient.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs index d15dd650db108..abbaf4191c22e 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs @@ -598,7 +598,7 @@ public async Task> MuteAsync(string callConnect await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); switch (message.Response.Status) { - case 200: + case 202: { MuteParticipantsResult value = default; using var document = await JsonDocument.ParseAsync(message.Response.ContentStream, default, cancellationToken).ConfigureAwait(false); @@ -630,7 +630,7 @@ public Response Mute(string callConnectionId, MutePartic _pipeline.Send(message, cancellationToken); switch (message.Response.Status) { - case 200: + case 202: { MuteParticipantsResult value = default; using var document = JsonDocument.Parse(message.Response.ContentStream); From 88d7f95060795b354a0e76ee508b8abfe974157a Mon Sep 17 00:00:00 2001 From: Amari West Date: Wed, 11 Oct 2023 13:02:53 -0500 Subject: [PATCH 09/20] modified test cases to check for 200 status code --- .../src/Generated/CallConnectionRestClient.cs | 4 ++-- .../CallConnections/CallConnectionTests.cs | 24 +++++++++---------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs index abbaf4191c22e..d15dd650db108 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallConnectionRestClient.cs @@ -598,7 +598,7 @@ public async Task> MuteAsync(string callConnect await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); switch (message.Response.Status) { - case 202: + case 200: { MuteParticipantsResult value = default; using var document = await JsonDocument.ParseAsync(message.Response.ContentStream, default, cancellationToken).ConfigureAwait(false); @@ -630,7 +630,7 @@ public Response Mute(string callConnectionId, MutePartic _pipeline.Send(message, cancellationToken); switch (message.Response.Status) { - case 202: + case 200: { MuteParticipantsResult value = default; using var document = JsonDocument.Parse(message.Response.ContentStream); diff --git a/sdk/communication/Azure.Communication.CallAutomation/tests/CallConnections/CallConnectionTests.cs b/sdk/communication/Azure.Communication.CallAutomation/tests/CallConnections/CallConnectionTests.cs index fc3a3b93c6319..7a3ecb793aa51 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/tests/CallConnections/CallConnectionTests.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/tests/CallConnections/CallConnectionTests.cs @@ -397,12 +397,12 @@ public void GetCallMediaTest() } [TestCaseSource(nameof(TestData_MuteParticipant))] - public void MuteParticipant_202Accepted(CommunicationIdentifier participant) + public void MuteParticipant_200Accepted(CommunicationIdentifier participant) { - var callConnection = CreateMockCallConnection(202, OperationContextPayload); + var callConnection = CreateMockCallConnection(200, OperationContextPayload); var response = callConnection.MuteParticipants(participant, OperationContext); - Assert.AreEqual((int)HttpStatusCode.Accepted, response.GetRawResponse().Status); + Assert.AreEqual((int)HttpStatusCode.OK, response.GetRawResponse().Status); Assert.AreEqual(OperationContext, response.Value.OperationContext); } @@ -417,15 +417,15 @@ public void UnmuteParticipant_202Accepted(CommunicationIdentifier participant) } [TestCaseSource(nameof(TestData_MuteParticipant))] - public void MuteParticipant_WithOptions_202Accepted(CommunicationIdentifier participant) + public void MuteParticipant_WithOptions_200Accepted(CommunicationIdentifier participant) { - var callConnection = CreateMockCallConnection(202, OperationContextPayload); + var callConnection = CreateMockCallConnection(200, OperationContextPayload); var options = new MuteParticipantsOptions(new List { participant }) { OperationContext = OperationContext }; var response = callConnection.MuteParticipants(options); - Assert.AreEqual((int)HttpStatusCode.Accepted, response.GetRawResponse().Status); + Assert.AreEqual((int)HttpStatusCode.OK, response.GetRawResponse().Status); Assert.AreEqual(OperationContext, response.Value.OperationContext); } @@ -444,12 +444,12 @@ public void UnmuteParticipant_WithOptions_202Accepted(CommunicationIdentifier pa } [TestCaseSource(nameof(TestData_MuteParticipant))] - public async Task MuteParticipantAsync_202Accepted(CommunicationIdentifier participant) + public async Task MuteParticipantAsync_200Accepted(CommunicationIdentifier participant) { - var callConnection = CreateMockCallConnection(202, OperationContextPayload); + var callConnection = CreateMockCallConnection(200, OperationContextPayload); var response = await callConnection.MuteParticipantsAsync(participant, OperationContext); - Assert.AreEqual((int)HttpStatusCode.Accepted, response.GetRawResponse().Status); + Assert.AreEqual((int)HttpStatusCode.OK, response.GetRawResponse().Status); Assert.AreEqual(OperationContext, response.Value.OperationContext); } @@ -480,16 +480,16 @@ public void UnmuteParticipantAsync_NotAcsUser_400BadRequest() } [TestCaseSource(nameof(TestData_MuteParticipant))] - public async Task MuteParticipantAsync_WithOptions_202Accepted(CommunicationIdentifier participant) + public async Task MuteParticipantAsync_WithOptions_200Accepted(CommunicationIdentifier participant) { - var callConnection = CreateMockCallConnection(202, OperationContextPayload); + var callConnection = CreateMockCallConnection(200, OperationContextPayload); var options = new MuteParticipantsOptions(new List { participant }) { OperationContext = OperationContext, }; var response = await callConnection.MuteParticipantsAsync(options); - Assert.AreEqual((int)HttpStatusCode.Accepted, response.GetRawResponse().Status); + Assert.AreEqual((int)HttpStatusCode.OK, response.GetRawResponse().Status); Assert.AreEqual(OperationContext, response.Value.OperationContext); } From 5f62ec5126a17229f292a2f24aad4035423645e9 Mon Sep 17 00:00:00 2001 From: Amari West Date: Wed, 11 Oct 2023 16:22:30 -0500 Subject: [PATCH 10/20] regenerated code --- .../tests/CallConnections/CallConnectionTests.cs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/sdk/communication/Azure.Communication.CallAutomation/tests/CallConnections/CallConnectionTests.cs b/sdk/communication/Azure.Communication.CallAutomation/tests/CallConnections/CallConnectionTests.cs index 7a3ecb793aa51..df9631b1f37a2 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/tests/CallConnections/CallConnectionTests.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/tests/CallConnections/CallConnectionTests.cs @@ -397,7 +397,7 @@ public void GetCallMediaTest() } [TestCaseSource(nameof(TestData_MuteParticipant))] - public void MuteParticipant_200Accepted(CommunicationIdentifier participant) + public void MuteParticipant_200OK(CommunicationIdentifier participant) { var callConnection = CreateMockCallConnection(200, OperationContextPayload); @@ -417,7 +417,7 @@ public void UnmuteParticipant_202Accepted(CommunicationIdentifier participant) } [TestCaseSource(nameof(TestData_MuteParticipant))] - public void MuteParticipant_WithOptions_200Accepted(CommunicationIdentifier participant) + public void MuteParticipant_WithOptions_200OK(CommunicationIdentifier participant) { var callConnection = CreateMockCallConnection(200, OperationContextPayload); var options = new MuteParticipantsOptions(new List { participant }) @@ -444,7 +444,7 @@ public void UnmuteParticipant_WithOptions_202Accepted(CommunicationIdentifier pa } [TestCaseSource(nameof(TestData_MuteParticipant))] - public async Task MuteParticipantAsync_200Accepted(CommunicationIdentifier participant) + public async Task MuteParticipantAsync_200OK(CommunicationIdentifier participant) { var callConnection = CreateMockCallConnection(200, OperationContextPayload); @@ -480,7 +480,7 @@ public void UnmuteParticipantAsync_NotAcsUser_400BadRequest() } [TestCaseSource(nameof(TestData_MuteParticipant))] - public async Task MuteParticipantAsync_WithOptions_200Accepted(CommunicationIdentifier participant) + public async Task MuteParticipantAsync_WithOptions_200OK(CommunicationIdentifier participant) { var callConnection = CreateMockCallConnection(200, OperationContextPayload); var options = new MuteParticipantsOptions(new List { participant }) From a5a9e0e5b8296fbf90a49dc8ebacd62f75298690 Mon Sep 17 00:00:00 2001 From: Amari West Date: Wed, 11 Oct 2023 17:15:55 -0500 Subject: [PATCH 11/20] regenerated code --- .../src/Generated/CallMediaRestClient.cs | 38 +++++++++---------- ...TranscriptionDataRequest.Serialization.cs} | 2 +- ...l.cs => UpdateTranscriptionDataRequest.cs} | 8 ++-- 3 files changed, 24 insertions(+), 24 deletions(-) rename sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/{UpdateTranscriptionRequestInternal.Serialization.cs => UpdateTranscriptionDataRequest.Serialization.cs} (85%) rename sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/{UpdateTranscriptionRequestInternal.cs => UpdateTranscriptionDataRequest.cs} (75%) diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs index 52474a5d420f2..829efa83413e0 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs @@ -120,7 +120,7 @@ internal HttpMessage CreateStartTranscriptionRequest(string callConnectionId, St uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":startTranscription", false); + uri.AppendPath(":StartTranscription", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); @@ -194,7 +194,7 @@ internal HttpMessage CreateStopTranscriptionRequest(string callConnectionId, Sto uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":stopTranscription", false); + uri.AppendPath(":StopTranscription", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); @@ -615,7 +615,7 @@ public Response SendDtmf(string callConnectionId, SendDtmfRequestInternal sendDt } } - internal HttpMessage CreateUpdateTranscriptionRequest(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest) + internal HttpMessage CreateUpdateTranscriptionDataRequest(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest) { var message = _pipeline.CreateMessage(); var request = message.Request; @@ -624,35 +624,35 @@ internal HttpMessage CreateUpdateTranscriptionRequest(string callConnectionId, U uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":updateTranscription", false); + uri.AppendPath(":updateTranscriptionData", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); request.Headers.Add("Content-Type", "application/json"); var content = new Utf8JsonRequestContent(); - content.JsonWriter.WriteObjectValue(updateTranscriptionRequest); + content.JsonWriter.WriteObjectValue(updateTranscriptionDataRequest); request.Content = content; return message; } - /// UpdateTranscription Api. + /// UpdateTranscriptionData Api. /// The call connection id. - /// The updateTranscription request. + /// The updateTranscriptionData request. /// The cancellation token to use. - /// or is null. + /// or is null. /// API to change transcription language. - public async Task UpdateTranscriptionAsync(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest, CancellationToken cancellationToken = default) + public async Task UpdateTranscriptionDataAsync(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest, CancellationToken cancellationToken = default) { if (callConnectionId == null) { throw new ArgumentNullException(nameof(callConnectionId)); } - if (updateTranscriptionRequest == null) + if (updateTranscriptionDataRequest == null) { - throw new ArgumentNullException(nameof(updateTranscriptionRequest)); + throw new ArgumentNullException(nameof(updateTranscriptionDataRequest)); } - using var message = CreateUpdateTranscriptionRequest(callConnectionId, updateTranscriptionRequest); + using var message = CreateUpdateTranscriptionDataRequest(callConnectionId, updateTranscriptionDataRequest); await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); switch (message.Response.Status) { @@ -663,24 +663,24 @@ public async Task UpdateTranscriptionAsync(string callConnectionId, Up } } - /// UpdateTranscription Api. + /// UpdateTranscriptionData Api. /// The call connection id. - /// The updateTranscription request. + /// The updateTranscriptionData request. /// The cancellation token to use. - /// or is null. + /// or is null. /// API to change transcription language. - public Response UpdateTranscription(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest, CancellationToken cancellationToken = default) + public Response UpdateTranscriptionData(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest, CancellationToken cancellationToken = default) { if (callConnectionId == null) { throw new ArgumentNullException(nameof(callConnectionId)); } - if (updateTranscriptionRequest == null) + if (updateTranscriptionDataRequest == null) { - throw new ArgumentNullException(nameof(updateTranscriptionRequest)); + throw new ArgumentNullException(nameof(updateTranscriptionDataRequest)); } - using var message = CreateUpdateTranscriptionRequest(callConnectionId, updateTranscriptionRequest); + using var message = CreateUpdateTranscriptionDataRequest(callConnectionId, updateTranscriptionDataRequest); _pipeline.Send(message, cancellationToken); switch (message.Response.Status) { diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs similarity index 85% rename from sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs rename to sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs index 973bb8756b584..0f76b6afdc77b 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.CallAutomation { - internal partial class UpdateTranscriptionRequestInternal : IUtf8JsonSerializable + public partial class UpdateTranscriptionDataRequest : IUtf8JsonSerializable { void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) { diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs similarity index 75% rename from sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs rename to sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs index 2a1d3954d6ceb..abc8246a960ba 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs @@ -10,13 +10,13 @@ namespace Azure.Communication.CallAutomation { - /// The UpdateTranscriptionRequest. - internal partial class UpdateTranscriptionRequestInternal + /// The UpdateTranscriptionDataRequest. + public partial class UpdateTranscriptionDataRequest { - /// Initializes a new instance of UpdateTranscriptionRequestInternal. + /// Initializes a new instance of UpdateTranscriptionDataRequest. /// Defines new locale for transcription. /// is null. - public UpdateTranscriptionRequestInternal(string locale) + public UpdateTranscriptionDataRequest(string locale) { Argument.AssertNotNull(locale, nameof(locale)); From 097e62230204e9c1cdad0bb7c898c80115f03c2a Mon Sep 17 00:00:00 2001 From: Amari West Date: Wed, 11 Oct 2023 17:39:05 -0500 Subject: [PATCH 12/20] Revert "regenerated code" This reverts commit a5a9e0e5b8296fbf90a49dc8ebacd62f75298690. --- .../src/Generated/CallMediaRestClient.cs | 38 +++++++++---------- ...scriptionRequestInternal.Serialization.cs} | 2 +- ... => UpdateTranscriptionRequestInternal.cs} | 8 ++-- 3 files changed, 24 insertions(+), 24 deletions(-) rename sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/{UpdateTranscriptionDataRequest.Serialization.cs => UpdateTranscriptionRequestInternal.Serialization.cs} (85%) rename sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/{UpdateTranscriptionDataRequest.cs => UpdateTranscriptionRequestInternal.cs} (75%) diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs index 829efa83413e0..52474a5d420f2 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs @@ -120,7 +120,7 @@ internal HttpMessage CreateStartTranscriptionRequest(string callConnectionId, St uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":StartTranscription", false); + uri.AppendPath(":startTranscription", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); @@ -194,7 +194,7 @@ internal HttpMessage CreateStopTranscriptionRequest(string callConnectionId, Sto uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":StopTranscription", false); + uri.AppendPath(":stopTranscription", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); @@ -615,7 +615,7 @@ public Response SendDtmf(string callConnectionId, SendDtmfRequestInternal sendDt } } - internal HttpMessage CreateUpdateTranscriptionDataRequest(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest) + internal HttpMessage CreateUpdateTranscriptionRequest(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest) { var message = _pipeline.CreateMessage(); var request = message.Request; @@ -624,35 +624,35 @@ internal HttpMessage CreateUpdateTranscriptionDataRequest(string callConnectionI uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":updateTranscriptionData", false); + uri.AppendPath(":updateTranscription", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); request.Headers.Add("Content-Type", "application/json"); var content = new Utf8JsonRequestContent(); - content.JsonWriter.WriteObjectValue(updateTranscriptionDataRequest); + content.JsonWriter.WriteObjectValue(updateTranscriptionRequest); request.Content = content; return message; } - /// UpdateTranscriptionData Api. + /// UpdateTranscription Api. /// The call connection id. - /// The updateTranscriptionData request. + /// The updateTranscription request. /// The cancellation token to use. - /// or is null. + /// or is null. /// API to change transcription language. - public async Task UpdateTranscriptionDataAsync(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest, CancellationToken cancellationToken = default) + public async Task UpdateTranscriptionAsync(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest, CancellationToken cancellationToken = default) { if (callConnectionId == null) { throw new ArgumentNullException(nameof(callConnectionId)); } - if (updateTranscriptionDataRequest == null) + if (updateTranscriptionRequest == null) { - throw new ArgumentNullException(nameof(updateTranscriptionDataRequest)); + throw new ArgumentNullException(nameof(updateTranscriptionRequest)); } - using var message = CreateUpdateTranscriptionDataRequest(callConnectionId, updateTranscriptionDataRequest); + using var message = CreateUpdateTranscriptionRequest(callConnectionId, updateTranscriptionRequest); await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); switch (message.Response.Status) { @@ -663,24 +663,24 @@ public async Task UpdateTranscriptionDataAsync(string callConnectionId } } - /// UpdateTranscriptionData Api. + /// UpdateTranscription Api. /// The call connection id. - /// The updateTranscriptionData request. + /// The updateTranscription request. /// The cancellation token to use. - /// or is null. + /// or is null. /// API to change transcription language. - public Response UpdateTranscriptionData(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest, CancellationToken cancellationToken = default) + public Response UpdateTranscription(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest, CancellationToken cancellationToken = default) { if (callConnectionId == null) { throw new ArgumentNullException(nameof(callConnectionId)); } - if (updateTranscriptionDataRequest == null) + if (updateTranscriptionRequest == null) { - throw new ArgumentNullException(nameof(updateTranscriptionDataRequest)); + throw new ArgumentNullException(nameof(updateTranscriptionRequest)); } - using var message = CreateUpdateTranscriptionDataRequest(callConnectionId, updateTranscriptionDataRequest); + using var message = CreateUpdateTranscriptionRequest(callConnectionId, updateTranscriptionRequest); _pipeline.Send(message, cancellationToken); switch (message.Response.Status) { diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs similarity index 85% rename from sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs rename to sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs index 0f76b6afdc77b..973bb8756b584 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.CallAutomation { - public partial class UpdateTranscriptionDataRequest : IUtf8JsonSerializable + internal partial class UpdateTranscriptionRequestInternal : IUtf8JsonSerializable { void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) { diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs similarity index 75% rename from sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs rename to sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs index abc8246a960ba..2a1d3954d6ceb 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs @@ -10,13 +10,13 @@ namespace Azure.Communication.CallAutomation { - /// The UpdateTranscriptionDataRequest. - public partial class UpdateTranscriptionDataRequest + /// The UpdateTranscriptionRequest. + internal partial class UpdateTranscriptionRequestInternal { - /// Initializes a new instance of UpdateTranscriptionDataRequest. + /// Initializes a new instance of UpdateTranscriptionRequestInternal. /// Defines new locale for transcription. /// is null. - public UpdateTranscriptionDataRequest(string locale) + public UpdateTranscriptionRequestInternal(string locale) { Argument.AssertNotNull(locale, nameof(locale)); From ac59d9bb03ba170c93d39959b7af03977433991d Mon Sep 17 00:00:00 2001 From: Amari West Date: Wed, 11 Oct 2023 18:06:05 -0500 Subject: [PATCH 13/20] Added TransciptionDataRequest Change --- .../src/CallMedia.cs | 8 ++-- .../src/Generated/CallMediaRestClient.cs | 38 +++++++++---------- ...TranscriptionDataRequest.Serialization.cs} | 2 +- ...l.cs => UpdateTranscriptionDataRequest.cs} | 8 ++-- 4 files changed, 28 insertions(+), 28 deletions(-) rename sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/{UpdateTranscriptionRequestInternal.Serialization.cs => UpdateTranscriptionDataRequest.Serialization.cs} (85%) rename sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/{UpdateTranscriptionRequestInternal.cs => UpdateTranscriptionDataRequest.cs} (75%) diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/CallMedia.cs b/sdk/communication/Azure.Communication.CallAutomation/src/CallMedia.cs index bf628870819fe..45dd86eb910ec 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/CallMedia.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/CallMedia.cs @@ -969,8 +969,8 @@ public virtual Response UpdateTranscription(String locale, CancellationToken can scope.Start(); try { - UpdateTranscriptionRequestInternal request = new UpdateTranscriptionRequestInternal(locale); - return CallMediaRestClient.UpdateTranscription(CallConnectionId, request, cancellationToken); + UpdateTranscriptionDataRequest request = new UpdateTranscriptionDataRequest(locale); + return CallMediaRestClient.UpdateTranscriptionData(CallConnectionId, request, cancellationToken); } catch (Exception ex) { @@ -991,8 +991,8 @@ public virtual async Task UpdateTranscriptionAsync(String locale, Canc scope.Start(); try { - UpdateTranscriptionRequestInternal request = new UpdateTranscriptionRequestInternal(locale); - return await CallMediaRestClient.UpdateTranscriptionAsync(CallConnectionId, request, cancellationToken).ConfigureAwait(false); + UpdateTranscriptionDataRequest request = new UpdateTranscriptionDataRequest(locale); + return await CallMediaRestClient.UpdateTranscriptionDataAsync(CallConnectionId, request, cancellationToken).ConfigureAwait(false); } catch (Exception ex) { diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs index 52474a5d420f2..829efa83413e0 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs @@ -120,7 +120,7 @@ internal HttpMessage CreateStartTranscriptionRequest(string callConnectionId, St uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":startTranscription", false); + uri.AppendPath(":StartTranscription", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); @@ -194,7 +194,7 @@ internal HttpMessage CreateStopTranscriptionRequest(string callConnectionId, Sto uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":stopTranscription", false); + uri.AppendPath(":StopTranscription", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); @@ -615,7 +615,7 @@ public Response SendDtmf(string callConnectionId, SendDtmfRequestInternal sendDt } } - internal HttpMessage CreateUpdateTranscriptionRequest(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest) + internal HttpMessage CreateUpdateTranscriptionDataRequest(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest) { var message = _pipeline.CreateMessage(); var request = message.Request; @@ -624,35 +624,35 @@ internal HttpMessage CreateUpdateTranscriptionRequest(string callConnectionId, U uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":updateTranscription", false); + uri.AppendPath(":updateTranscriptionData", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); request.Headers.Add("Content-Type", "application/json"); var content = new Utf8JsonRequestContent(); - content.JsonWriter.WriteObjectValue(updateTranscriptionRequest); + content.JsonWriter.WriteObjectValue(updateTranscriptionDataRequest); request.Content = content; return message; } - /// UpdateTranscription Api. + /// UpdateTranscriptionData Api. /// The call connection id. - /// The updateTranscription request. + /// The updateTranscriptionData request. /// The cancellation token to use. - /// or is null. + /// or is null. /// API to change transcription language. - public async Task UpdateTranscriptionAsync(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest, CancellationToken cancellationToken = default) + public async Task UpdateTranscriptionDataAsync(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest, CancellationToken cancellationToken = default) { if (callConnectionId == null) { throw new ArgumentNullException(nameof(callConnectionId)); } - if (updateTranscriptionRequest == null) + if (updateTranscriptionDataRequest == null) { - throw new ArgumentNullException(nameof(updateTranscriptionRequest)); + throw new ArgumentNullException(nameof(updateTranscriptionDataRequest)); } - using var message = CreateUpdateTranscriptionRequest(callConnectionId, updateTranscriptionRequest); + using var message = CreateUpdateTranscriptionDataRequest(callConnectionId, updateTranscriptionDataRequest); await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); switch (message.Response.Status) { @@ -663,24 +663,24 @@ public async Task UpdateTranscriptionAsync(string callConnectionId, Up } } - /// UpdateTranscription Api. + /// UpdateTranscriptionData Api. /// The call connection id. - /// The updateTranscription request. + /// The updateTranscriptionData request. /// The cancellation token to use. - /// or is null. + /// or is null. /// API to change transcription language. - public Response UpdateTranscription(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest, CancellationToken cancellationToken = default) + public Response UpdateTranscriptionData(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest, CancellationToken cancellationToken = default) { if (callConnectionId == null) { throw new ArgumentNullException(nameof(callConnectionId)); } - if (updateTranscriptionRequest == null) + if (updateTranscriptionDataRequest == null) { - throw new ArgumentNullException(nameof(updateTranscriptionRequest)); + throw new ArgumentNullException(nameof(updateTranscriptionDataRequest)); } - using var message = CreateUpdateTranscriptionRequest(callConnectionId, updateTranscriptionRequest); + using var message = CreateUpdateTranscriptionDataRequest(callConnectionId, updateTranscriptionDataRequest); _pipeline.Send(message, cancellationToken); switch (message.Response.Status) { diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs similarity index 85% rename from sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs rename to sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs index 973bb8756b584..0f76b6afdc77b 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.CallAutomation { - internal partial class UpdateTranscriptionRequestInternal : IUtf8JsonSerializable + public partial class UpdateTranscriptionDataRequest : IUtf8JsonSerializable { void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) { diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs similarity index 75% rename from sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs rename to sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs index 2a1d3954d6ceb..abc8246a960ba 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs @@ -10,13 +10,13 @@ namespace Azure.Communication.CallAutomation { - /// The UpdateTranscriptionRequest. - internal partial class UpdateTranscriptionRequestInternal + /// The UpdateTranscriptionDataRequest. + public partial class UpdateTranscriptionDataRequest { - /// Initializes a new instance of UpdateTranscriptionRequestInternal. + /// Initializes a new instance of UpdateTranscriptionDataRequest. /// Defines new locale for transcription. /// is null. - public UpdateTranscriptionRequestInternal(string locale) + public UpdateTranscriptionDataRequest(string locale) { Argument.AssertNotNull(locale, nameof(locale)); From f03117f9bbf3819f4285cbbe7a5adc8d03525951 Mon Sep 17 00:00:00 2001 From: Amari West Date: Wed, 11 Oct 2023 18:35:25 -0500 Subject: [PATCH 14/20] generated from latest swagger --- .../src/CallMedia.cs | 8 ++-- .../src/Generated/CallMediaRestClient.cs | 38 +++++++++---------- ...scriptionRequestInternal.Serialization.cs} | 2 +- ... => UpdateTranscriptionRequestInternal.cs} | 8 ++-- .../src/autorest.md | 2 +- 5 files changed, 29 insertions(+), 29 deletions(-) rename sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/{UpdateTranscriptionDataRequest.Serialization.cs => UpdateTranscriptionRequestInternal.Serialization.cs} (85%) rename sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/{UpdateTranscriptionDataRequest.cs => UpdateTranscriptionRequestInternal.cs} (75%) diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/CallMedia.cs b/sdk/communication/Azure.Communication.CallAutomation/src/CallMedia.cs index 45dd86eb910ec..bf628870819fe 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/CallMedia.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/CallMedia.cs @@ -969,8 +969,8 @@ public virtual Response UpdateTranscription(String locale, CancellationToken can scope.Start(); try { - UpdateTranscriptionDataRequest request = new UpdateTranscriptionDataRequest(locale); - return CallMediaRestClient.UpdateTranscriptionData(CallConnectionId, request, cancellationToken); + UpdateTranscriptionRequestInternal request = new UpdateTranscriptionRequestInternal(locale); + return CallMediaRestClient.UpdateTranscription(CallConnectionId, request, cancellationToken); } catch (Exception ex) { @@ -991,8 +991,8 @@ public virtual async Task UpdateTranscriptionAsync(String locale, Canc scope.Start(); try { - UpdateTranscriptionDataRequest request = new UpdateTranscriptionDataRequest(locale); - return await CallMediaRestClient.UpdateTranscriptionDataAsync(CallConnectionId, request, cancellationToken).ConfigureAwait(false); + UpdateTranscriptionRequestInternal request = new UpdateTranscriptionRequestInternal(locale); + return await CallMediaRestClient.UpdateTranscriptionAsync(CallConnectionId, request, cancellationToken).ConfigureAwait(false); } catch (Exception ex) { diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs index 829efa83413e0..52474a5d420f2 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/CallMediaRestClient.cs @@ -120,7 +120,7 @@ internal HttpMessage CreateStartTranscriptionRequest(string callConnectionId, St uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":StartTranscription", false); + uri.AppendPath(":startTranscription", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); @@ -194,7 +194,7 @@ internal HttpMessage CreateStopTranscriptionRequest(string callConnectionId, Sto uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":StopTranscription", false); + uri.AppendPath(":stopTranscription", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); @@ -615,7 +615,7 @@ public Response SendDtmf(string callConnectionId, SendDtmfRequestInternal sendDt } } - internal HttpMessage CreateUpdateTranscriptionDataRequest(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest) + internal HttpMessage CreateUpdateTranscriptionRequest(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest) { var message = _pipeline.CreateMessage(); var request = message.Request; @@ -624,35 +624,35 @@ internal HttpMessage CreateUpdateTranscriptionDataRequest(string callConnectionI uri.Reset(_endpoint); uri.AppendPath("/calling/callConnections/", false); uri.AppendPath(callConnectionId, true); - uri.AppendPath(":updateTranscriptionData", false); + uri.AppendPath(":updateTranscription", false); uri.AppendQuery("api-version", _apiVersion, true); request.Uri = uri; request.Headers.Add("Accept", "application/json"); request.Headers.Add("Content-Type", "application/json"); var content = new Utf8JsonRequestContent(); - content.JsonWriter.WriteObjectValue(updateTranscriptionDataRequest); + content.JsonWriter.WriteObjectValue(updateTranscriptionRequest); request.Content = content; return message; } - /// UpdateTranscriptionData Api. + /// UpdateTranscription Api. /// The call connection id. - /// The updateTranscriptionData request. + /// The updateTranscription request. /// The cancellation token to use. - /// or is null. + /// or is null. /// API to change transcription language. - public async Task UpdateTranscriptionDataAsync(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest, CancellationToken cancellationToken = default) + public async Task UpdateTranscriptionAsync(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest, CancellationToken cancellationToken = default) { if (callConnectionId == null) { throw new ArgumentNullException(nameof(callConnectionId)); } - if (updateTranscriptionDataRequest == null) + if (updateTranscriptionRequest == null) { - throw new ArgumentNullException(nameof(updateTranscriptionDataRequest)); + throw new ArgumentNullException(nameof(updateTranscriptionRequest)); } - using var message = CreateUpdateTranscriptionDataRequest(callConnectionId, updateTranscriptionDataRequest); + using var message = CreateUpdateTranscriptionRequest(callConnectionId, updateTranscriptionRequest); await _pipeline.SendAsync(message, cancellationToken).ConfigureAwait(false); switch (message.Response.Status) { @@ -663,24 +663,24 @@ public async Task UpdateTranscriptionDataAsync(string callConnectionId } } - /// UpdateTranscriptionData Api. + /// UpdateTranscription Api. /// The call connection id. - /// The updateTranscriptionData request. + /// The updateTranscription request. /// The cancellation token to use. - /// or is null. + /// or is null. /// API to change transcription language. - public Response UpdateTranscriptionData(string callConnectionId, UpdateTranscriptionDataRequest updateTranscriptionDataRequest, CancellationToken cancellationToken = default) + public Response UpdateTranscription(string callConnectionId, UpdateTranscriptionRequestInternal updateTranscriptionRequest, CancellationToken cancellationToken = default) { if (callConnectionId == null) { throw new ArgumentNullException(nameof(callConnectionId)); } - if (updateTranscriptionDataRequest == null) + if (updateTranscriptionRequest == null) { - throw new ArgumentNullException(nameof(updateTranscriptionDataRequest)); + throw new ArgumentNullException(nameof(updateTranscriptionRequest)); } - using var message = CreateUpdateTranscriptionDataRequest(callConnectionId, updateTranscriptionDataRequest); + using var message = CreateUpdateTranscriptionRequest(callConnectionId, updateTranscriptionRequest); _pipeline.Send(message, cancellationToken); switch (message.Response.Status) { diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs similarity index 85% rename from sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs rename to sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs index 0f76b6afdc77b..973bb8756b584 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.Serialization.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.Serialization.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.CallAutomation { - public partial class UpdateTranscriptionDataRequest : IUtf8JsonSerializable + internal partial class UpdateTranscriptionRequestInternal : IUtf8JsonSerializable { void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) { diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs similarity index 75% rename from sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs rename to sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs index abc8246a960ba..2a1d3954d6ceb 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionDataRequest.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/src/Generated/Models/UpdateTranscriptionRequestInternal.cs @@ -10,13 +10,13 @@ namespace Azure.Communication.CallAutomation { - /// The UpdateTranscriptionDataRequest. - public partial class UpdateTranscriptionDataRequest + /// The UpdateTranscriptionRequest. + internal partial class UpdateTranscriptionRequestInternal { - /// Initializes a new instance of UpdateTranscriptionDataRequest. + /// Initializes a new instance of UpdateTranscriptionRequestInternal. /// Defines new locale for transcription. /// is null. - public UpdateTranscriptionDataRequest(string locale) + public UpdateTranscriptionRequestInternal(string locale) { Argument.AssertNotNull(locale, nameof(locale)); diff --git a/sdk/communication/Azure.Communication.CallAutomation/src/autorest.md b/sdk/communication/Azure.Communication.CallAutomation/src/autorest.md index 456b73e165bfa..d1ad64ab63603 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/src/autorest.md +++ b/sdk/communication/Azure.Communication.CallAutomation/src/autorest.md @@ -10,7 +10,7 @@ model-namespace: false tag: package-2023-01-15-preview require: - - https://github.com/williamzhao87/azure-rest-api-specs/blob/5b7321a923a30b83b978e3a30ed1d497e35052fd/specification/communication/data-plane/CallAutomation/readme.md + - https://github.com/williamzhao87/azure-rest-api-specs/blob/e31fe487ab3f775d659edf3945b9239ac910314a/specification/communication/data-plane/CallAutomation/readme.md title: Azure Communication Services From 2a39b2d865a5a223e0edaf7e3615dc16562e85b7 Mon Sep 17 00:00:00 2001 From: Amari West Date: Thu, 12 Oct 2023 15:41:30 -0500 Subject: [PATCH 15/20] generated netstandard2.0.cs --- .../api/Azure.Communication.CallAutomation.netstandard2.0.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs b/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs index d1a78f11e0472..7ae2185d60bce 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs @@ -1317,6 +1317,7 @@ public StartRecordingOptions(Azure.Communication.CallAutomation.CallLocator call public System.Collections.Generic.IList AudioChannelParticipantOrdering { get { throw null; } } public System.Collections.Generic.IList ChannelAffinity { get { throw null; } set { } } public Azure.Communication.CallAutomation.ExternalStorage ExternalStorage { get { throw null; } set { } } + public bool PauseOnStart { get { throw null; } set { } } public Azure.Communication.CallAutomation.RecordingChannel RecordingChannel { get { throw null; } set { } } public Azure.Communication.CallAutomation.RecordingContent RecordingContent { get { throw null; } set { } } public Azure.Communication.CallAutomation.RecordingFormat RecordingFormat { get { throw null; } set { } } From 7eb14250f0a123983d82e606ed8c7fb5d4585a86 Mon Sep 17 00:00:00 2001 From: Amari West Date: Thu, 12 Oct 2023 16:04:21 -0500 Subject: [PATCH 16/20] edited changelog --- .../Azure.Communication.CallAutomation/CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md b/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md index 40a3e8a0d5624..ae996caa02aa1 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md +++ b/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md @@ -3,6 +3,7 @@ ## 1.1.0-beta.1 (Unreleased) ### Features Added +- StartRecording now accepts PauseOnStart. ### Breaking Changes From 74fcc900785bfc067d7328c2871e165bba1b1b24 Mon Sep 17 00:00:00 2001 From: Amari West Date: Thu, 12 Oct 2023 16:30:14 -0500 Subject: [PATCH 17/20] Revert "generated netstandard2.0.cs" This reverts commit 2a39b2d865a5a223e0edaf7e3615dc16562e85b7. --- .../api/Azure.Communication.CallAutomation.netstandard2.0.cs | 1 - 1 file changed, 1 deletion(-) diff --git a/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs b/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs index 7ae2185d60bce..d1a78f11e0472 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs @@ -1317,7 +1317,6 @@ public StartRecordingOptions(Azure.Communication.CallAutomation.CallLocator call public System.Collections.Generic.IList AudioChannelParticipantOrdering { get { throw null; } } public System.Collections.Generic.IList ChannelAffinity { get { throw null; } set { } } public Azure.Communication.CallAutomation.ExternalStorage ExternalStorage { get { throw null; } set { } } - public bool PauseOnStart { get { throw null; } set { } } public Azure.Communication.CallAutomation.RecordingChannel RecordingChannel { get { throw null; } set { } } public Azure.Communication.CallAutomation.RecordingContent RecordingContent { get { throw null; } set { } } public Azure.Communication.CallAutomation.RecordingFormat RecordingFormat { get { throw null; } set { } } From dbf99321e54b1a3f6ccc71a7777b446c5e14895f Mon Sep 17 00:00:00 2001 From: Amari West Date: Thu, 12 Oct 2023 16:31:06 -0500 Subject: [PATCH 18/20] Revert "edited changelog" This reverts commit 7eb14250f0a123983d82e606ed8c7fb5d4585a86. --- .../Azure.Communication.CallAutomation/CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md b/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md index ae996caa02aa1..40a3e8a0d5624 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md +++ b/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md @@ -3,7 +3,6 @@ ## 1.1.0-beta.1 (Unreleased) ### Features Added -- StartRecording now accepts PauseOnStart. ### Breaking Changes From def7f4aaa0bda3b762b4193eb33fd74df0865f94 Mon Sep 17 00:00:00 2001 From: Amari West Date: Thu, 12 Oct 2023 16:43:15 -0500 Subject: [PATCH 19/20] added line to changelog and standard2.0.cs --- .../Azure.Communication.CallAutomation/CHANGELOG.md | 1 + .../api/Azure.Communication.CallAutomation.netstandard2.0.cs | 1 + 2 files changed, 2 insertions(+) diff --git a/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md b/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md index 40a3e8a0d5624..c1cb4bc520720 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md +++ b/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md @@ -3,6 +3,7 @@ ## 1.1.0-beta.1 (Unreleased) ### Features Added +- StartRecording now accepts ChannelAffinity. ### Breaking Changes diff --git a/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs b/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs index d1a78f11e0472..7ae2185d60bce 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs +++ b/sdk/communication/Azure.Communication.CallAutomation/api/Azure.Communication.CallAutomation.netstandard2.0.cs @@ -1317,6 +1317,7 @@ public StartRecordingOptions(Azure.Communication.CallAutomation.CallLocator call public System.Collections.Generic.IList AudioChannelParticipantOrdering { get { throw null; } } public System.Collections.Generic.IList ChannelAffinity { get { throw null; } set { } } public Azure.Communication.CallAutomation.ExternalStorage ExternalStorage { get { throw null; } set { } } + public bool PauseOnStart { get { throw null; } set { } } public Azure.Communication.CallAutomation.RecordingChannel RecordingChannel { get { throw null; } set { } } public Azure.Communication.CallAutomation.RecordingContent RecordingContent { get { throw null; } set { } } public Azure.Communication.CallAutomation.RecordingFormat RecordingFormat { get { throw null; } set { } } From d8da07374039f9afcde3c382477c33f82fb99142 Mon Sep 17 00:00:00 2001 From: amariwest-msft <139818906+amariwest-msft@users.noreply.github.com> Date: Thu, 12 Oct 2023 16:44:27 -0500 Subject: [PATCH 20/20] Update CHANGELOG.md --- .../Azure.Communication.CallAutomation/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md b/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md index c1cb4bc520720..ae996caa02aa1 100644 --- a/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md +++ b/sdk/communication/Azure.Communication.CallAutomation/CHANGELOG.md @@ -3,7 +3,7 @@ ## 1.1.0-beta.1 (Unreleased) ### Features Added -- StartRecording now accepts ChannelAffinity. +- StartRecording now accepts PauseOnStart. ### Breaking Changes