Add get_call api.

Author: zihzhan-msft

sdk/communication/azure-communication-callingserver/README.md

@@ -96,7 +96,7 @@ from azure.communication.callingserver import (
     )
 
 add_participant_result = await call_connection_async.add_participant(
-    participant=CommunicationUserIdentifier("<user-id>")
+    participant=CommunicationUserIdentifier("<id>")
     )
 ```
 
@@ -106,10 +106,12 @@ add_participant_result = await call_connection_async.add_participant(
 Once the participant_id is provided, the `remove_participant` method can be invoked:
 
 ```Python
-await call_connection_async.remove_participant(participant_id)
+await call_connection_async.remove_participant(
+    participant=CommunicationUserIdentifier("<id>")
+    )
 ```
 
-- `participant_id`: The participant to be removed from the call.
+- `participant`: The identifier of participant to be removed from the call.
 
 ### Play audio in the call connection
 Once the call is establised, the `play_audio` method can be invoked:
@@ -132,10 +134,6 @@ play_audio_result = await call_connection_async.play_audio(
 Once the call is establised, the `cancel_all_media_operations` method can be invoked:
 
 ```Python
-from azure.communication.callingserver import (
-    PlayAudioOptions
-    )
-
 cancel_all_media_operations_result = await call_connection_async.cancel_all_media_operations()
 ```
 
@@ -159,7 +157,7 @@ from azure.communication.callingserver import (
 call_locator = ServerCallLocator("<server-call-id>")
 call_connection = await callingserver_client.join_call(
     call_locator=call_locator,
-    source=CommunicationUserIdentifier("<user-id>"),
+    source=CommunicationUserIdentifier("<id>"),
     join_call_options=JoinCallOptions"<...>"))
     )
 ```
@@ -180,7 +178,7 @@ from azure.communication.callingserver import (
 call_locator = ServerCallLocator("<server-call-id>")
 add_participant_result = await callingserver_client.add_participant(
     call_locator=call_locator,
-    participant=CommunicationUserIdentifier("<user-id>")
+    participant=CommunicationUserIdentifier("<id>")
     callback_uri="<callback-uri>"
     )
 ```
@@ -200,14 +198,12 @@ from azure.communication.callingserver import (
 
 await callingserver_client.remove_participant(
     call_locator=call_locator,
-    participant=CommunicationUserIdentifier("<user-id>")
-    callback_uri="<callback-uri>"
+    participant=CommunicationUserIdentifier("<id>")
     )
 ```
 
 - `call_locator`: The callLocator contains the call id.
 - `participant`: The participant to be removed from the call.
-- `callback_uri`: The callback uri.
 
 ### Play audio with callLocator in the server call
 Once the call is establised, the `play_audio` method can be invoked:

sdk/communication/azure-communication-callingserver/azure/communication/callingserver/__init__.py

@@ -8,7 +8,7 @@
 
 from ._call_connection import CallConnection
 from ._callingserver_client import CallingServerClient
-from ._generated.models import (AddParticipantResult,
+from ._generated.models import (AddParticipantResult, CallConnectionProperties,
                                 CancelAllMediaOperationsRequest,
                                 CancelAllMediaOperationsResult,
                                 CreateCallRequest, PhoneNumberIdentifierModel,
@@ -33,6 +33,7 @@
 __all__ = [
     'AddParticipantResult',
     'CancelAllMediaOperationsRequest',
+    'CallConnectionProperties',
     'CallConnection',
     'CallingServerClient',
     'CancelAllMediaOperationsResult',

sdk/communication/azure-communication-callingserver/azure/communication/callingserver/_call_connection.py

@@ -16,10 +16,13 @@
     PlayAudioRequestConverter,
     PlayAudioToParticipantRequestConverter
     )
-from ._generated.models import (AddParticipantResult,
-                                CancelAllMediaOperationsResult,
-                                PhoneNumberIdentifierModel,
-                                PlayAudioResult)
+from ._generated.models import (
+    AddParticipantResult,
+    CallConnectionProperties,
+    CancelAllMediaOperationsResult,
+    PhoneNumberIdentifierModel,
+    PlayAudioResult
+    )
 from ._shared.models import CommunicationIdentifier
 
 if TYPE_CHECKING:
@@ -36,6 +39,17 @@ def __init__(
         self.call_connection_id = call_connection_id
         self._call_connection_client = call_connection_client
 
+    @distributed_trace()
+    def get_call(
+            self,
+            **kwargs  # type: Any
+        ): # type: (...) -> CallConnectionProperties
+
+        return self._call_connection_client.get_call(
+            call_connection_id=self.call_connection_id,
+            **kwargs
+        )
+
     @distributed_trace()
     def hang_up(
             self,

sdk/communication/azure-communication-callingserver/azure/communication/callingserver/_communication_identifier_serializer.py

@@ -46,7 +46,7 @@ def deserialize_identifier(identifier_model):
     raw_id = identifier_model.raw_id
 
     if identifier_model.communication_user:
-        return CommunicationUserIdentifier(raw_id, raw_id=raw_id)
+        return CommunicationUserIdentifier(identifier_model.communication_user.id, raw_id=raw_id)
     if identifier_model.phone_number:
         return PhoneNumberIdentifier(identifier_model.phone_number.value, raw_id=raw_id)
     if identifier_model.microsoft_teams_user:

sdk/communication/azure-communication-callingserver/azure/communication/callingserver/aio/_call_connection_async.py

@@ -21,9 +21,13 @@
     PlayAudioRequestConverter,
     PlayAudioToParticipantRequestConverter
     )
-from .._generated.models import (AddParticipantResult,
-                                 CancelAllMediaOperationsResult,
-                                 PhoneNumberIdentifierModel, PlayAudioResult)
+from .._generated.models import (
+    AddParticipantResult,
+    CallConnectionProperties,
+    CancelAllMediaOperationsResult,
+    PhoneNumberIdentifierModel,
+    PlayAudioResult
+    )
 from .._shared.models import CommunicationIdentifier
 from .._generated.aio._azure_communication_calling_server_service import \
     AzureCommunicationCallingServerService  # pylint: disable=unused-import
@@ -44,6 +48,16 @@ def __init__(
         self._call_connection_client = call_connection_client
         self._callingserver_service_client = callingserver_service_client
 
+    @distributed_trace_async()
+    async def get_call(
+            self,
+            **kwargs: Any
+        ) -> CallConnectionProperties:
+        return await self._call_connection_client.get_call(
+            call_connection_id=self.call_connection_id,
+            **kwargs
+        )
+
     @distributed_trace_async()
     async def hang_up(
             self,

sdk/communication/azure-communication-callingserver/tests/test_call_connection.py

@@ -18,6 +18,46 @@
 
 class TestCallConnection(unittest.TestCase):
 
+    @parameterized.expand(CallConnectionUnitTestUtils.data_source_test_get_call())
+    def test_get_call_succeed(
+        self,
+        test_name, # type: str
+        call_connection_id, # type: str
+        use_managed_identity = False, # type: bool
+        ):
+
+        call_connection = _mock_utils.create_mock_call_connection(
+            call_connection_id,
+            status_code=200,
+            payload=_test_constants.GetCallResponsePayload,
+            use_managed_identity=use_managed_identity
+            )
+
+        result = call_connection.get_call()
+        CallConnectionUnitTestUtils.verify_get_call_result(result)
+
+    @parameterized.expand(CallConnectionUnitTestUtils.data_source_test_get_call())
+    def test_get_call_failed(
+        self,
+        test_name, # type: str
+        call_connection_id, # type: str
+        use_managed_identity = False, # type: bool
+        ):
+
+        call_connection = _mock_utils.create_mock_call_connection(
+            call_connection_id,
+            status_code=404,
+            payload=_test_constants.ErrorPayload,
+            use_managed_identity = use_managed_identity
+            )
+
+        raised = False
+        try:
+            call_connection.get_call()
+        except:
+            raised = True
+        assert raised == True
+
     @parameterized.expand(CallConnectionUnitTestUtils.data_source_test_hang_up())
     def test_hang_up_succeed(
         self,

sdk/communication/azure-communication-callingserver/tests/test_call_connection_async.py

@@ -16,6 +16,46 @@
 
 from utils._unit_test_utils import CallConnectionUnitTestUtils
 
+@parameterized.expand(CallConnectionUnitTestUtils.data_source_test_get_call())
+@pytest.mark.asyncio
+async def test_get_call_succeed(
+    test_name, # type: str
+    call_connection_id, # type: str
+    use_managed_identity = False, # type: bool
+    ):
+
+    call_connection = _mock_utils_async.create_mock_call_connection(
+        call_connection_id,
+        status_code=200,
+        payload=_test_constants.GetCallResponsePayload,
+        use_managed_identity=use_managed_identity
+        )
+
+    result = await call_connection.get_call()
+    CallConnectionUnitTestUtils.verify_get_call_result(result)
+
+@parameterized.expand(CallConnectionUnitTestUtils.data_source_test_get_call())
+@pytest.mark.asyncio
+async def test_get_call_failed(
+    test_name, # type: str
+    call_connection_id, # type: str
+    use_managed_identity = False, # type: bool
+    ):
+
+    call_connection = _mock_utils_async.create_mock_call_connection(
+        call_connection_id,
+        status_code=404,
+        payload=_test_constants.ErrorPayload,
+        use_managed_identity = use_managed_identity
+        )
+
+    raised = False
+    try:
+        await call_connection.get_call()
+    except:
+        raised = True
+    assert raised == True
+
 @parameterized.expand(CallConnectionUnitTestUtils.data_source_test_hang_up())
 @pytest.mark.asyncio
 async def test_hang_up_succeed(

sdk/communication/azure-communication-callingserver/tests/utils/_test_constants.py

@@ -18,7 +18,7 @@
 FAKE_ENDPOINT = "https://endpoint"
 FAKE_TOKEN = "Fake Token"
 CALL_SUBJECT = "testsubject"
-
+OPERATION_ID = "dummyId"
 # System Environment Variables
 # Live Test Variables
 RESOURCE_IDENTIFIER = os.getenv(
@@ -45,7 +45,7 @@
 PHONE_NUMBER = "+14255550123"
 OPERATION_CONTEXT = "dummyOperationContext"
 ErrorPayload={
-    "operationId": "dummyId",
+    "operationId": OPERATION_ID,
     "status": "failed",
     "operationContext": OPERATION_CONTEXT,
     "resultInfo": {
@@ -62,21 +62,74 @@
 MEDIA_OPERATION_ID = "dummyMediaOperationId"
 USER_TO_USER_INFORMATION = "dummyUserToUserInformation"
 
+SEVERCALL_ID = "aHKW9HM6Ly9jb252ZXJzYXRpb24tc2VydmljZS11cmwvYXBpL3YyL2VwL2NvbnYvc2Rjc3NlaVdiUV8wLVNCTE9peG1NWHRRP2k9OSZlPTYzNzU1MDY4NDM3MDUzNTAwMQ=="
+GROUPCALL_ID = "507ad2dc-5a40-4d85-b2d9-cf214d469638"
+
+SERVER_CALL_LOCATOR = "serverCallLocator"
+GROUP_CALL_LOCATOR = "groupCallLocator"
+
+COMMUNICATION_USER_Id_01 = "8:acs:b9612345-fd0b-480c-8fd2-cb58b70eab9f_acacdeb5-dba7-479b-ab45-5e76469d87b2"
+COMMUNICATION_USER_Id_02 = "8:acs:b9612345-fd0b-480c-8fd2-cb58b70eab9f_f95c7b38-6c4e-4898-93b3-2553402304d6"
+
+COMMUNICATION_USER_KIND = "communication_user"
+PHONE_NUMBER_KIND = "phone_number"
+
+CALL_STATE_CONNECTED = "connected"
+MEDIA_TYPES_AUDIO = "audio"
+MEDIA_TYPES_VIDEO = "video"
+CALLEVENTS_DTMFRECEIVED = "dtmfReceived"
+CALLEVENTS_PARTICIPANTSUPDATED = "participantsUpdated"
+
+# GetCallResponsePayload
+GetCallResponsePayload = {
+    "callConnectionId": CALL_ID,
+    "source": {
+          "communicationUser": {
+            "id": COMMUNICATION_USER_Id_01
+          }
+        },
+    "targets": [
+        {
+        "communicationUser": {
+            "id": COMMUNICATION_USER_Id_02
+        }
+        },
+        {
+        "phoneNumber": {
+            "value": PHONE_NUMBER
+        }
+        }
+    ],
+    "callConnectionState": CALL_STATE_CONNECTED,
+    "subject": CALL_SUBJECT,
+    "callbackUri": AppCallbackUrl,
+    "requestedMediaTypes": [
+        MEDIA_TYPES_AUDIO,
+        MEDIA_TYPES_VIDEO
+    ],
+    "requestedCallEvents": [
+        CALLEVENTS_DTMFRECEIVED,
+        CALLEVENTS_PARTICIPANTSUPDATED
+    ],
+    "callLocator": {
+          "serverCallId": SEVERCALL_ID,
+          "kind": SERVER_CALL_LOCATOR
+        }
+    }
+
+
 # CancelAllMediaOperaions
 CancelAllMediaOperaionsResponsePayload = {
-    "operationId": "dummyId",
+    "operationId": OPERATION_ID,
     "status": "completed",
     "operationContext": OPERATION_CONTEXT,
     }
 
-SEVERCALL_ID = "b3ba87f4-9daf-4d0b-b95a-53d955a40577"
-GROUPCALL_ID = "507ad2dc-5a40-4d85-b2d9-cf214d469638"
-
 # PlayAudio
 AUDIO_FILE_URI = "https://bot.contoso.io/audio/sample-message.wav"
 AUDIO_FILE_ID = "sampleAudioFileId"
 PlayAudioResponsePayload = {
-    "operationId": "dummyId",
+    "operationId": OPERATION_ID,
     "status": "running",
     "operationContext": OPERATION_CONTEXT
     }