Juntuchen/ops outgoing call

sdk/communication/communication-call-automation/review/communication-call-automation.api.md

@@ -113,6 +113,7 @@ export class CallAutomationClient {
 
 // @public
 export interface CallAutomationClientOptions extends CommonClientOptions {
+    opsSourceIdentity?: MicrosoftTeamsAppIdentifier;
     sourceIdentity?: CommunicationUserIdentifier;
 }
 

sdk/communication/communication-call-automation/src/callAutomationClient.ts

@@ -7,13 +7,15 @@ import type { InternalPipelineOptions } from "@azure/core-rest-pipeline";
 import type {
   CommunicationIdentifier,
   CommunicationUserIdentifier,
+  MicrosoftTeamsAppIdentifier,
 } from "@azure/communication-common";
 import { parseClientArguments, isKeyCredential } from "@azure/communication-common";
 import { logger } from "./models/logger";
 import type {
   AnswerCallRequest,
   CallAutomationApiClient,
   CommunicationUserIdentifierModel,
+  MicrosoftTeamsAppIdentifierModel,
   CreateCallRequest,
   RedirectCallRequest,
   RejectCallRequest,
@@ -34,6 +36,7 @@ import {
   communicationIdentifierModelConverter,
   communicationUserIdentifierConverter,
   communicationUserIdentifierModelConverter,
+  microsoftTeamsAppIdentifierModelConverter,
   phoneNumberIdentifierConverter,
   PhoneNumberIdentifierModelConverter,
 } from "./utli/converters";
@@ -49,6 +52,11 @@ export interface CallAutomationClientOptions extends CommonClientOptions {
    * The identifier of the source of the call for call creating/answering/inviting operation.
    */
   sourceIdentity?: CommunicationUserIdentifier;
+  /**
+   * The identifier of the One Phone System bot for call creating operation.
+   * Should be mutually exclusive with sourceIdentity.
+   */
+  opsSourceIdentity?: MicrosoftTeamsAppIdentifier;
 }
 
 /**
@@ -65,6 +73,7 @@ const isCallAutomationClientOptions = (options: any): options is CallAutomationC
 export class CallAutomationClient {
   private readonly callAutomationApiClient: CallAutomationApiClient;
   private readonly sourceIdentity?: CommunicationUserIdentifierModel;
+  private readonly opsSourceIdentity?: MicrosoftTeamsAppIdentifierModel;
   private readonly credential: TokenCredential | KeyCredential;
   private readonly internalPipelineOptions: InternalPipelineOptions;
   private readonly callAutomationEventProcessor: CallAutomationEventProcessor;
@@ -127,6 +136,7 @@ export class CallAutomationClient {
     );
 
     this.sourceIdentity = communicationUserIdentifierModelConverter(options.sourceIdentity);
+    this.opsSourceIdentity = microsoftTeamsAppIdentifierModelConverter(options.opsSourceIdentity);
   }
 
   /**
@@ -245,6 +255,7 @@ export class CallAutomationClient {
   ): Promise<CreateCallResult> {
     const request: CreateCallRequest = {
       source: this.sourceIdentity,
+      opsSource: this.opsSourceIdentity,
       targets: [communicationIdentifierModelConverter(targetParticipant.targetParticipant)],
       callbackUri: callbackUrl,
       operationContext: options.operationContext,
@@ -277,6 +288,7 @@ export class CallAutomationClient {
   ): Promise<CreateCallResult> {
     const request: CreateCallRequest = {
       source: this.sourceIdentity,
+      opsSource: this.opsSourceIdentity,
       targets: targetParticipants.map((target) => communicationIdentifierModelConverter(target)),
       callbackUri: callbackUrl,
       operationContext: options.operationContext,

sdk/communication/communication-call-automation/src/utli/converters.ts

@@ -26,6 +26,7 @@ import type {
   KnownCommunicationCloudEnvironmentModel,
   PhoneNumberIdentifierModel,
   CommunicationUserIdentifierModel,
+  MicrosoftTeamsAppIdentifierModel,
 } from "../generated/src";
 import { KnownCommunicationIdentifierModelKind } from "../generated/src";
 import type { CallParticipant } from "../models/models";
@@ -221,3 +222,25 @@ export function communicationUserIdentifierConverter(
 
   return { communicationUserId: identifier.id };
 }
+
+/** Convert MicrosoftTeamsAppIdentifier to MicrosoftTeamsAppIdentifierModel (Internal usage class) */
+export function microsoftTeamsAppIdentifierModelConverter(
+  identifier: MicrosoftTeamsAppIdentifier | undefined,
+): MicrosoftTeamsAppIdentifierModel | undefined {
+  if (!identifier || !identifier.teamsAppId) {
+    return undefined;
+  }
+
+  return { appId: identifier.teamsAppId };
+}
+
+/** Convert MicrosoftTeamsAppIdentifierModel to MicrosoftTeamsAppIdentifier (Public usage class) */
+export function microsoftTeamsAppIdentifierConverter(
+  identifier: MicrosoftTeamsAppIdentifierModel | undefined,
+): MicrosoftTeamsAppIdentifier | undefined {
+  if (!identifier || !identifier.appId) {
+    return undefined;
+  }
+
+  return { teamsAppId: identifier.appId };
+}

sdk/communication/communication-call-automation/swagger/README.md

@@ -13,7 +13,7 @@ license-header: MICROSOFT_MIT_NO_VERSION
 output-folder: ../src/generated
 tag: package-2023-10-03-preview
 require:
-  - https://github.com/Azure/azure-rest-api-specs/blob/156ff363e44f764ddd8a0a6adcd371610240ba15/specification/communication/data-plane/CallAutomation/readme.md
+  - https://github.com/Azure/azure-rest-api-specs/blob/be2a0fa68829fcb15c4e6b47aa6bc4bdd566c1cf/specification/communication/data-plane/CallAutomation/readme.md
 package-version: 1.3.0-beta.1
 model-date-time-as-string: false
 optional-response-headers: true

sdk/communication/communication-call-automation/test/callAutomationClient.spec.ts

@@ -15,6 +15,7 @@ import {
 import type {
   CommunicationIdentifier,
   CommunicationUserIdentifier,
+  MicrosoftTeamsAppIdentifier,
 } from "@azure/communication-common";
 import { assert } from "chai";
 import type { Context } from "mocha";
@@ -39,6 +40,17 @@ import type {
   CreateCallEventResult,
 } from "../src/eventprocessor/eventResponses";
 import { randomUUID } from "@azure/core-util";
+import { KnownCommunicationCloudEnvironmentModel } from "../src/generated/src";
+
+function createOPSCallAutomationClient(
+  oPSSourceIdentity: MicrosoftTeamsAppIdentifier,
+): CallAutomationClient {
+  const connectionString = "endpoint=https://redacted.communication.azure.com/;accesskey=redacted";
+
+  return new CallAutomationClient(connectionString, {
+    opsSourceIdentity: oPSSourceIdentity,
+  });
+}
 
 describe("Call Automation Client Unit Tests", () => {
   let targets: CommunicationIdentifier[];
@@ -132,6 +144,57 @@ describe("Call Automation Client Unit Tests", () => {
       .catch((error) => console.error(error));
   });
 
+  it("CreateOPSCall", async () => {
+    // defined dummy variables
+    const appId = "28:acs:redacted";
+    const appCloud = KnownCommunicationCloudEnvironmentModel.Public;
+    const oPSSouceStub = {
+      teamsAppId: appId,
+      cloud: appCloud,
+    };
+
+    // stub an OPS CallAutomationClient
+    const createOPSClientStub = Sinon.stub().callsFake(() =>
+      createOPSCallAutomationClient(oPSSouceStub),
+    );
+
+    // Use the stubbed factory function to create the client
+    const oPSClient: SinonStubbedInstance<CallAutomationClient> & CallAutomationClient =
+      createOPSClientStub();
+
+    // Explicitly stub the createCall method
+    oPSClient.createCall = Sinon.stub();
+
+    // mocks
+    const createCallResultMock: CreateCallResult = {
+      callConnectionProperties: {
+        source: {
+          rawId: appId,
+          teamsAppId: appId,
+          cloud: appCloud,
+        } as MicrosoftTeamsAppIdentifier,
+      } as CallConnectionProperties,
+      callConnection: {} as CallConnection,
+      waitForEventProcessor: async () => {
+        return {} as CreateCallEventResult;
+      },
+    };
+
+    (oPSClient.createCall as Sinon.SinonStub).returns(Promise.resolve(createCallResultMock));
+
+    const promiseResult = oPSClient.createCall(target, CALL_CALLBACK_URL);
+
+    // asserts
+    promiseResult
+      .then((result: CreateCallResult) => {
+        assert.isNotNull(result);
+        assert.isTrue(oPSClient.createCall.calledWith(target, CALL_CALLBACK_URL));
+        assert.equal(result, createCallResultMock);
+        return;
+      })
+      .catch((error) => console.error(error));
+  });
+
   it("AnswerCall", async () => {
     // mocks
     const answerCallResultMock: AnswerCallResult = {