Added recording result api (#41704)

* init commit

* init commit

* run live tests

* run live tests

* fix linter

* run live tests

* run live tests

* remove whitespace

Author: amariwest-msft

sdk/communication/azure-communication-callautomation/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/communication/azure-communication-callautomation",
-  "Tag": "python/communication/azure-communication-callautomation_4be693f217"
+  "Tag": "python/communication/azure-communication-callautomation_2e3a66461b"
 }

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_call_automation_client.py

@@ -30,6 +30,7 @@
 from ._models import (
     CallConnectionProperties,
     RecordingProperties,
+    RecordingResult,
     ChannelAffinity,
     CallInvite,
     AzureCommunicationsRecordingStorage,
@@ -906,6 +907,20 @@ def get_recording_properties(self, recording_id: str, **kwargs) -> RecordingProp
         )
         return RecordingProperties._from_generated(recording_state_result)  # pylint:disable=protected-access
 
+    @distributed_trace
+    def get_recording_response(self, recording_id: str, **kwargs) -> RecordingResult:
+        """Get call recording result.
+        :param recording_id: The recording id.
+        :type recording_id: str
+        :return: recording result
+        :rtype: ~azure.communication.callautomation.RecordingResult
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        recording_result = self._call_recording_client.get_recording_result(
+            recording_id=recording_id, **kwargs
+        )
+        return RecordingResult._from_generated(recording_result)  # pylint:disable=protected-access
+
     @distributed_trace
     def download_recording(
         self, recording_url: str, *, offset: int = None, length: int = None, **kwargs

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/_models.py

@@ -3,6 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+from datetime import datetime
 from typing import List, Optional, Union, TYPE_CHECKING
 from typing_extensions import Literal
 from ._generated.models import (
@@ -16,7 +17,9 @@
     Choice as ChoiceInternal,
     ChannelAffinity as ChannelAffinityInternal,
     MediaStreamingSubscription as MediaStreamingSubscriptionInternal,
-    TranscriptionSubscription as TranscriptionSubscriptionInternal
+    TranscriptionSubscription as TranscriptionSubscriptionInternal,
+    RecordingStorageInfo,
+    Error
 )
 from ._shared.models import (
     CommunicationIdentifier,
@@ -25,6 +28,7 @@
 )
 from ._generated.models._enums import PlaySourceType
 from ._generated.models._enums import RecordingStorageKind
+from ._generated.models._enums import CallSessionEndReason
 from ._utils import (
     deserialize_phone_identifier,
     deserialize_identifier,
@@ -55,6 +59,7 @@
         RemoveParticipantResponse as RemoveParticipantResultRest,
         TransferCallResponse as TransferParticipantResultRest,
         RecordingStateResponse as RecordingStateResultRest,
+        RecordingResultResponse as RecordingResultRest,
         MuteParticipantsResult as MuteParticipantsResultRest,
         SendDtmfTonesResult as SendDtmfTonesResultRest,
         CancelAddParticipantResponse as CancelAddParticipantResultRest,
@@ -713,7 +718,6 @@ def _from_generated(cls, call_connection_properties_generated: "CallConnectionPr
             else None,
         )
 
-
 class RecordingProperties:
     """Detailed recording properties of the call.
 
@@ -740,6 +744,80 @@ def _from_generated(cls, recording_state_result: "RecordingStateResultRest"):
             recording_id=recording_state_result.recording_id, recording_state=recording_state_result.recording_state
         )
 
+class RecordingResult:
+    """Recording result data.
+    Variables are only populated by the server, and will be ignored when sending a request.
+    :ivar recording_id:
+    :vartype recording_id: str
+    :ivar recording_storage_info: Container for chunks.
+    :vartype recording_storage_info:
+     ~azure.communication.callautomation.models.RecordingStorageInfo
+    :ivar errors:
+    :vartype errors: list[~azure.communication.callautomation.models.Error]
+    :ivar recording_start_time:
+    :vartype recording_start_time: ~datetime.datetime
+    :ivar recording_duration_ms:
+    :vartype recording_duration_ms: int
+    :ivar session_end_reason: Known values are: "sessionStillOngoing", "callEnded",
+     "initiatorLeft", "handedOverOrTransferred", "maximumSessionTimeReached", "callStartTimeout",
+     "mediaTimeout", "audioStreamFailure", "allInstancesBusy", "teamsTokenConversionFailed",
+     "reportCallStateFailed", "reportCallStateFailedAndSessionMustBeDiscarded",
+     "couldNotRejoinCall", "invalidBotData", "couldNotStart",
+     "appHostedMediaFailureOutcomeWithError", "appHostedMediaFailureOutcomeGracefully",
+     "handedOverDueToMediaTimeout", "handedOverDueToAudioStreamFailure",
+     "speechRecognitionSessionNonRetriableError",
+     "speechRecognitionSessionRetriableErrorMaxRetryCountReached",
+     "handedOverDueToChunkCreationFailure", "chunkCreationFailed",
+     "handedOverDueToProcessingTimeout", "processingTimeout", and "transcriptObjectCreationFailed".
+    :vartype session_end_reason: str or
+     ~azure.communication.callautomation.models.CallSessionEndReason
+    :ivar recording_expiration_time:
+    :vartype recording_expiration_time: ~datetime.datetime
+    """
+
+    recording_id: Optional[str]
+    """Id of this recording operation."""
+    recording_storage_info: Optional[RecordingStorageInfo]
+    """recording storage info."""
+    errors: Optional[List[Error]]
+    """Error."""
+    session_end_reason: Optional[Union[str, 'CallSessionEndReason']]
+    """session end reason."""
+    recording_start_time: Optional[datetime]
+    """recording start time."""
+    recording_duration_ms: Optional[int]
+    """recording duration ms."""
+    recording_expiration_time: Optional[datetime]
+    """recording expiration time."""
+
+    def __init__(
+        self, *, recording_id: Optional[str] = None,
+        recording_storage_info: Optional[RecordingStorageInfo] = None,
+        session_end_reason: Optional[Union[str,  'CallSessionEndReason']] = None,
+        recording_start_time: Optional[datetime] = None,
+        recording_duration_ms: Optional[int] = None,
+        recording_expiration_time: Optional[datetime] = None,
+        errors: Optional[List[Error]]
+    ):
+        self.recording_id = recording_id
+        self.recording_storage_info = recording_storage_info
+        self.session_end_reason = session_end_reason
+        self.recording_start_time = recording_start_time
+        self.recording_duration_ms = recording_duration_ms
+        self.recording_expiration_time = recording_expiration_time
+        self.errors = errors
+
+    @classmethod
+    def _from_generated(cls, recording_result: "RecordingResultRest"):
+        return cls(
+            recording_id=recording_result.recording_id,
+            recording_storage_info=recording_result.recording_storage_info,
+            session_end_reason=recording_result.session_end_reason,
+            recording_start_time=recording_result.recording_start_time,
+            recording_duration_ms=recording_result.recording_duration_ms,
+            recording_expiration_time=recording_result.recording_expiration_time,
+            errors=recording_result.errors
+        )
 
 class CallParticipant:
     """Details of an Azure Communication Service call participant.

sdk/communication/azure-communication-callautomation/azure/communication/callautomation/aio/_call_automation_client_async.py

@@ -28,6 +28,7 @@
 from .._models import (
     CallConnectionProperties,
     RecordingProperties,
+    RecordingResult,
     ChannelAffinity,
     CallInvite,
     AzureCommunicationsRecordingStorage,
@@ -905,6 +906,20 @@ async def get_recording_properties(self, recording_id: str, **kwargs) -> Recordi
         )
         return RecordingProperties._from_generated(recording_state_result)  # pylint:disable=protected-access
 
+    @distributed_trace_async
+    async def get_recording_response(self, recording_id: str, **kwargs) -> RecordingResult:
+        """Get call recording result.
+        :param recording_id: The recording id.
+        :type recording_id: str
+        :return: recording result
+        :rtype: ~azure.communication.callautomation.RecordingResult
+        :raises ~azure.core.exceptions.HttpResponseError:
+        """
+        recording_result = await self._call_recording_client.get_recording_result(
+            recording_id=recording_id, **kwargs
+        )
+        return RecordingResult._from_generated(recording_result)  # pylint:disable=protected-access
+
     @distributed_trace_async
     async def download_recording(
         self, recording_url: str, *, offset: int = None, length: int = None, **kwargs

sdk/communication/azure-communication-callautomation/cspell.yaml

@@ -0,0 +1,12 @@
+# This file configures spell checking. Items in "words" were initially populated
+# with words that might be spelling errors. Review these words and take
+# appropriate action. For more information, see: https://aka.ms/ci-fix#spell-check
+
+# Spell checking is not case sensitive
+# Keep word lists in alphabetical order so the file is easier to manage
+version: "0.2"
+words:
+  - Retriable
+  - PSTN
+  - Dtmf
+  - ssml

sdk/communication/azure-communication-callautomation/tests/events/test_e2e_callautomation_client.pyTestCallAutomationClientAutomatedLiveTesttest_add_participant_then_cancel_request.event.json

@@ -1 +1 @@
-{"IncomingCall": {"to": {"kind": "communicationUser", "rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000026-4519-f268-85f4-343a0d000338", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000026-4519-f268-85f4-343a0d000338"}}, "from": {"kind": "communicationUser", "rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000026-4519-f16b-85f4-343a0d000337", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000026-4519-f16b-85f4-343a0d000337"}}, "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LWpwZWEtMDMtcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi9zb3haUEFtWFRVRy1OcDQzWWljTGZnP2k9MTAtNjAtMS04MyZlPTYzODc3NDA3OTU5ODEyODcxOQ==", "callerDisplayName": "REDACTED", "incomingCallContext": "REDACTED", "correlationId": "3d1b219c-677a-4a16-96c3-77cec088292a"}, "CallConnected": {"id": "b55ab8f8-38fb-473d-aa78-6c1fcda267d2", "source": "calling/callConnections/08002380-b89d-4304-a8dd-9f353482d7bf", "type": "Microsoft.Communication.CallConnected", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 0, "message": ""}, "callConnectionId": "08002380-b89d-4304-a8dd-9f353482d7bf", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LWpwZWEtMDMtcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi9zb3haUEFtWFRVRy1OcDQzWWljTGZnP2k9MTAtNjAtMS04MyZlPTYzODc3NDA3OTU5ODEyODcxOQ==", "correlationId": "3d1b219c-677a-4a16-96c3-77cec088292a", "publicEventType": "Microsoft.Communication.CallConnected"}, "time": "2025-03-17T17:48:16.384762+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/08002380-b89d-4304-a8dd-9f353482d7bf"}, "ParticipantsUpdated": {"id": "3ebb5150-1436-4451-8c76-54dc3b9ec6b8", "source": "calling/callConnections/08002380-b89d-4304-a8dd-9f353482d7bf", "type": "Microsoft.Communication.ParticipantsUpdated", "data": {"participants": [{"identifier": {"rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000026-4519-f16b-85f4-343a0d000337", "kind": "communicationUser", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000026-4519-f16b-85f4-343a0d000337"}}, "isMuted": false, "isOnHold": false}, {"identifier": {"rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000026-4519-f268-85f4-343a0d000338", "kind": "communicationUser", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000026-4519-f268-85f4-343a0d000338"}}, "isMuted": false, "isOnHold": false}], "sequenceNumber": 3, "resultInformation": {"code": 200, "subCode": 0, "message": ""}, "version": "2024-09-01-preview", "callConnectionId": "08002380-b89d-4304-a8dd-9f353482d7bf", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LWpwZWEtMDMtcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi9zb3haUEFtWFRVRy1OcDQzWWljTGZnP2k9MTAtNjAtMS04MyZlPTYzODc3NDA3OTU5ODEyODcxOQ==", "correlationId": "3d1b219c-677a-4a16-96c3-77cec088292a", "publicEventType": "Microsoft.Communication.ParticipantsUpdated"}, "time": "2025-03-17T17:48:20.1274372+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/08002380-b89d-4304-a8dd-9f353482d7bf"}, "CancelAddParticipantSucceeded": {"id": "522c611f-f4a1-4061-aaaa-629054d0dd75", "source": "calling/callConnections/08002380-b89d-4304-a8dd-9f353482d7bf", "type": "Microsoft.Communication.CancelAddParticipantSucceeded", "data": {"invitationId": "ec414aa2-e017-452e-a077-3d188382a0aa", "version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 5300, "message": "addParticipants failed for participant 8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000026-4519-f35e-85f4-343a0d000339. Underlying reason: The conversation has ended. DiagCode: 0#5300.@"}, "callConnectionId": "08002380-b89d-4304-a8dd-9f353482d7bf", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LWpwZWEtMDMtcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi9zb3haUEFtWFRVRy1OcDQzWWljTGZnP2k9MTAtNjAtMS04MyZlPTYzODc3NDA3OTU5ODEyODcxOQ==", "correlationId": "3d1b219c-677a-4a16-96c3-77cec088292a", "publicEventType": "Microsoft.Communication.CancelAddParticipantSucceeded"}, "time": "2025-03-17T17:48:22.0638623+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/08002380-b89d-4304-a8dd-9f353482d7bf"}, "CallDisconnected": {"id": "50806cde-a554-4e8c-8b05-e4bdd3bca645", "source": "calling/callConnections/08002380-b89d-4304-a8dd-9f353482d7bf", "type": "Microsoft.Communication.CallDisconnected", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 7000, "message": "The conversation has ended. DiagCode: 0#7000.@"}, "callConnectionId": "08002380-b89d-4304-a8dd-9f353482d7bf", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LWpwZWEtMDMtcHJvZC1ha3MuY29udi5za3lwZS5jb20vY29udi9zb3haUEFtWFRVRy1OcDQzWWljTGZnP2k9MTAtNjAtMS04MyZlPTYzODc3NDA3OTU5ODEyODcxOQ==", "correlationId": "3d1b219c-677a-4a16-96c3-77cec088292a", "publicEventType": "Microsoft.Communication.CallDisconnected"}, "time": "2025-03-17T17:48:23.1850512+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/08002380-b89d-4304-a8dd-9f353482d7bf"}}
+{"IncomingCall": {"to": {"kind": "communicationUser", "rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000028-2f1b-a487-e64a-5c3a0d006c62", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000028-2f1b-a487-e64a-5c3a0d006c62"}}, "from": {"kind": "communicationUser", "rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000028-2f1b-a45c-e64a-5c3a0d006c61", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000028-2f1b-a45c-e64a-5c3a0d006c61"}}, "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LXVzZWEtMDEtc2RmLWFrcy5jb252LnNreXBlLmNvbS9jb252L1RZSHdMQUtHTjBtY0V0VG5tNWRZMWc/aT0xMC0xMjgtMTQtMjM3JmU9NjM4ODU5NzI4MTc3OTEwNDQ2", "callerDisplayName": "REDACTED", "incomingCallContext": "REDACTED", "correlationId": "23a9616f-514c-429a-a15e-8f121fe62896"}, "CallConnected": {"id": "236db7d1-5d6c-41e4-99e5-15cb74599b58", "source": "calling/callConnections/15002280-703d-4a59-b921-7c4b641a4617", "type": "Microsoft.Communication.CallConnected", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 0, "message": ""}, "callConnectionId": "15002280-703d-4a59-b921-7c4b641a4617", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LXVzZWEtMDEtc2RmLWFrcy5jb252LnNreXBlLmNvbS9jb252L1RZSHdMQUtHTjBtY0V0VG5tNWRZMWc/aT0xMC0xMjgtMTQtMjM3JmU9NjM4ODU5NzI4MTc3OTEwNDQ2", "correlationId": "23a9616f-514c-429a-a15e-8f121fe62896", "publicEventType": "Microsoft.Communication.CallConnected"}, "time": "2025-06-20T21:23:57.2757696+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/15002280-703d-4a59-b921-7c4b641a4617"}, "ParticipantsUpdated": {"id": "4831e539-7566-4393-900b-1f9e45899c61", "source": "calling/callConnections/15002280-703d-4a59-b921-7c4b641a4617", "type": "Microsoft.Communication.ParticipantsUpdated", "data": {"participants": [{"identifier": {"rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000028-2f1b-a487-e64a-5c3a0d006c62", "kind": "communicationUser", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000028-2f1b-a487-e64a-5c3a0d006c62"}}, "isMuted": false, "isOnHold": false}, {"identifier": {"rawId": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000028-2f1b-a45c-e64a-5c3a0d006c61", "kind": "communicationUser", "communicationUser": {"id": "8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000028-2f1b-a45c-e64a-5c3a0d006c61"}}, "isMuted": false, "isOnHold": false}], "sequenceNumber": 3, "resultInformation": {"code": 200, "subCode": 0, "message": ""}, "version": "2024-09-01-preview", "callConnectionId": "15002280-703d-4a59-b921-7c4b641a4617", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LXVzZWEtMDEtc2RmLWFrcy5jb252LnNreXBlLmNvbS9jb252L1RZSHdMQUtHTjBtY0V0VG5tNWRZMWc/aT0xMC0xMjgtMTQtMjM3JmU9NjM4ODU5NzI4MTc3OTEwNDQ2", "correlationId": "23a9616f-514c-429a-a15e-8f121fe62896", "publicEventType": "Microsoft.Communication.ParticipantsUpdated"}, "time": "2025-06-20T21:23:59.7242617+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/15002280-703d-4a59-b921-7c4b641a4617"}, "CancelAddParticipantSucceeded": {"id": "bc5176dd-0b3e-4f6a-a250-b8fc8d1b5861", "source": "calling/callConnections/15002280-703d-4a59-b921-7c4b641a4617", "type": "Microsoft.Communication.CancelAddParticipantSucceeded", "data": {"invitationId": "cee7fd45-8adb-4543-a127-82bb5ac8be65", "version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 5300, "message": "addParticipants failed for participant 8:acs:6d889502-3d7a-41a8-befa-d21fd80e8767_00000028-2f1b-a4b2-e64a-5c3a0d006c63. Underlying reason: The conversation has ended. DiagCode: 0#5300.@"}, "callConnectionId": "15002280-703d-4a59-b921-7c4b641a4617", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LXVzZWEtMDEtc2RmLWFrcy5jb252LnNreXBlLmNvbS9jb252L1RZSHdMQUtHTjBtY0V0VG5tNWRZMWc/aT0xMC0xMjgtMTQtMjM3JmU9NjM4ODU5NzI4MTc3OTEwNDQ2", "correlationId": "23a9616f-514c-429a-a15e-8f121fe62896", "publicEventType": "Microsoft.Communication.CancelAddParticipantSucceeded"}, "time": "2025-06-20T21:24:01.9228096+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/15002280-703d-4a59-b921-7c4b641a4617"}, "CallDisconnected": {"id": "c9827aee-a8d0-4e89-a898-c856bce9f554", "source": "calling/callConnections/15002280-703d-4a59-b921-7c4b641a4617", "type": "Microsoft.Communication.CallDisconnected", "data": {"version": "2024-09-01-preview", "resultInformation": {"code": 200, "subCode": 7000, "message": "Call was ended by Azure Communication Service Call Automation API or a server bot. DiagCode: 0#7000.@"}, "callConnectionId": "15002280-703d-4a59-b921-7c4b641a4617", "serverCallId": "aHR0cHM6Ly9hcGkuZmxpZ2h0cHJveHkuc2t5cGUuY29tL2FwaS92Mi9jcC9jb252LXVzZWEtMDEtc2RmLWFrcy5jb252LnNreXBlLmNvbS9jb252L1RZSHdMQUtHTjBtY0V0VG5tNWRZMWc/aT0xMC0xMjgtMTQtMjM3JmU9NjM4ODU5NzI4MTc3OTEwNDQ2", "correlationId": "23a9616f-514c-429a-a15e-8f121fe62896", "publicEventType": "Microsoft.Communication.CallDisconnected"}, "time": "2025-06-20T21:24:02.9461645+00:00", "specversion": "1.0", "datacontenttype": "application/json", "subject": "calling/callConnections/15002280-703d-4a59-b921-7c4b641a4617"}}