Incoming call sample

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "markdownlint.config": {
+        "MD028": false,
+        "MD025": {
+            "front_matter_title": ""
+        }
+    }
+}

README.md

@@ -26,4 +26,12 @@ Azure Communication Services enable developers to add communication capabilities
 
 8. [Call To Phone](https://docs.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/pstn-call?pivots=platform-web)
 
-9. [Use managed identities](https://docs.microsoft.com/azure/communication-services/quickstarts/managed-identity?pivots=programming-language-javascript)
+9. [Use managed identities](https://docs.microsoft.com/azure/communication-services/quickstarts/managed-identity?pivots=programming-language-javascript)
+
+10. [Get Started with UI Components](https://azure.github.io/communication-ui-library/?path=/story/quickstarts-uicomponents--page)
+
+11. [Get Started with Composites](https://azure.github.io/communication-ui-library/?path=/story/quickstarts-composites--page)
+
+12. [Get Started with Chat Stateful Client](https://azure.github.io/communication-ui-library/?path=/story/quickstarts-statefulclient--page)
+
+13. [Get Started with Call Stateful Client](https://azure.github.io/communication-ui-library/?path=/story/quickstarts-statefulclient--page)

add-1-on-1-phone-calling/README.md

@@ -9,7 +9,7 @@ products:
 
 # Add 1 on 1 phone calling to your application
 
-This code sample walks through the process of integration Azure Communication Services phone calling into your Javascript application.
+This code sample walks through the process of integration Azure Communication Services phone calling into your JavaScript application.
 
 This quickstart sample includes the code that is explained as part of [this document](https://docs.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/pstn-call?pivots=platform-web). See that document for additional details on how this sample works.
 

add-1-on-1-video-calling/README.md

@@ -9,7 +9,7 @@ products:
 
 # Add 1 on 1 video calling to your application
 
-This code sample walks through the process of integration Azure Communication Services video calling into your Javascript application.
+This code sample walks through the process of integration Azure Communication Services video calling into your JavaScript application.
 
 This quickstart sample includes the code that is explained as part of [this document](https://docs.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/get-started-with-video-calling). See that document for additional details on how this sample works.
 
@@ -22,7 +22,8 @@ This quickstart sample includes the code that is explained as part of [this docu
 
 ## Run the code
 1. Run `npm i` on the directory of the project to install dependencies
-2. Use the webpack-dev-server to build and run your app. Run the following command to bundle application host in on a local webserver:
+2. Add a [user access token](https://docs.microsoft.com/azure/communication-services/quickstarts/access-tokens?pivots=programming-language-javascript) in line 54 of the `client.js`.
+3. Use the webpack-dev-server to build and run your app. Run the following command to bundle application host in on a local webserver:
 
         npx webpack-dev-server --entry ./client.js --output bundle.js --debug --devtool inline-source-map
 

add-1-on-1-voice-calling/README.md

@@ -9,7 +9,7 @@ products:
 
 # Add 1 on 1 voice calling to your application
 
-This code sample walks through the process of integration Azure Communication Services voice calling into your Javascript application.
+This code sample walks through the process of integration Azure Communication Services voice calling into your JavaScript application.
 
 This quickstart sample includes the code that is explained as part of [this document](https://docs.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/getting-started-with-calling?pivots=platform-web). See that document for additional details on how this sample works.
 

add-chat/README.md

@@ -9,7 +9,7 @@ products:
 
 # Add chat to your application
 
-This code sample walks through the process of integration Azure Communication Services real time chat into your Javascript application.
+This code sample walks through the process of integration Azure Communication Services real time chat into your JavaScript application.
 
 This quickstart sample includes the code that is explained as part of [this document](https://docs.microsoft.com/azure/communication-services/quickstarts/chat/get-started?pivots=programming-language-javascript). See that document for additional details on how this sample works.
 

incoming-call-routing/.gitignore

@@ -0,0 +1,3 @@
+bin/*
+node_modules
+.vscode

incoming-call-routing/README.md

@@ -0,0 +1,41 @@
+How to run
+1. Create ACS resource from Azure Portal
+
+2. Create 3 ACS User Identities(MRI)
+Example
+```
+User 1: 8:acs:<ACS resource id>-<guid>
+User 2: 8:acs:<ACS resource id>-<guid>
+User 3: 8:acs:<ACS resource id>-<guid>
+```
+
+3. Put User2 MRI into the config AllowedRecipientList
+
+4. Put User3 MRI into the config TargetParticipant
+
+5. Start ngrok
+```
+ngrok http 3000
+```
+
+6. Update config with ngrok endpoint. Example
+```
+"appCallbackBaseUri": "https://4087-75-155-234-140.ngrok.io"
+```
+
+7. Start sample app locally
+```
+npm run start
+```
+
+or to hot reload
+```
+npm run dev
+```
+
+8. Register webhook to your ACS resource
+```
+armclient put "/subscriptions/<subscription id>/resourceGroups/<rg>/providers/Microsoft.Communication/CommunicationServices/<acs name>/providers/Microsoft.EventGrid/eventSubscriptions/IncomingCallEventSub?api-version=2020-06-01" "{'properties':{'destination':{'properties':{'endpointUrl':'https://<ngrok url>/OnIncomingCall'},'endpointType':'WebHook'},'filter':{'includedEventTypes': ['Microsoft.Communication.IncomingCall']}}}" -verbose
+```
+
+9. Make a call from User1 to User2

incoming-call-routing/appsettings.json

@@ -0,0 +1,7 @@
+{
+    "resourceConnectionString": "<ACS connection string>",
+    "appCallbackBaseUri": "<callback api uri>",
+    "audioFileUri": "<audio file path>",
+    "targetParticipant": "<transfer ACS mri>",
+    "allowedRecipientList": ["<allowed ACS mris>"]
+}

incoming-call-routing/clients/callingServerClient.ts

@@ -0,0 +1,4 @@
+import { CallingServerClient } from "@azure/communication-calling-server";
+import config from "../appsettings.json";
+
+export const getCallingServerClient = () => new CallingServerClient(config.resourceConnectionString);

incoming-call-routing/controllers/callingServerCallbackController.ts

@@ -0,0 +1,37 @@
+import { CloudEvent, EventGridDeserializer } from "@azure/eventgrid";
+import { Router } from "express";
+import { authorize } from "../eventHandlers/eventAuthHandler";
+import { processNotification } from "../eventHandlers/notificationHandler";
+import { IncomingCallEvent } from "../incomingCallEvent";
+
+const callingServerCallbackRoute = "/CallingServerAPICallbacks";
+const router = Router();
+const deserializer = new EventGridDeserializer();
+
+router.post(callingServerCallbackRoute, async (req, res) => {
+    try {
+        const secret = req.query["secret"]?.toString();
+
+        if (authorize(secret)) {
+            const events = await deserializer.deserializeCloudEvents(req.body[0]);
+
+            for (const event of events) {
+                console.log(`Incoming call event: ${event.type}`);
+                console.log(`incoming call data: ${JSON.stringify(event.data)}`);
+
+                processNotification(event as CloudEvent<IncomingCallEvent>);
+            }
+
+            return res.sendStatus(200);
+        } else {
+            return res.sendStatus(401);
+        }
+    } catch (e) {
+        return res.status(500).send(e);
+    }
+});
+
+export {
+    router as callingServerCallbackHandler,
+    callingServerCallbackRoute
+};

incoming-call-routing/controllers/incomingCallController.ts

@@ -0,0 +1,46 @@
+import config from "../appsettings.json";
+import { EventGridDeserializer, SubscriptionValidationEventData } from "@azure/eventgrid";
+import { Router } from "express";
+import { report } from "../incomingCallHandler";
+
+const incomingCallRoute = "/OnIncomingCall";
+const router = Router();
+const { deserializeEventGridEvents } = new EventGridDeserializer();
+
+router.post(incomingCallRoute, async (req, res) => {
+    try {
+        const events = await deserializeEventGridEvents(req.body[0]);
+
+        for (const { eventType, data } of events) {
+            console.log(`Incoming call event: ${eventType}`);
+            console.log(`incoming call data: ${JSON.stringify(data)}`);
+
+            if (eventType === "Microsoft.EventGrid.SubscriptionValidationEvent") {
+                const validationEventData = data as SubscriptionValidationEventData;
+
+                if (!validationEventData?.validationCode) {
+                    throw new Error("Unable to validate Event Grid subscription");
+                }
+
+                return res.status(200).send({ validationResponse: validationEventData.validationCode });
+            }
+
+            if (eventType === "Microsoft.Communication.IncomingCall") {
+                const { incomingCallContext, to } = data as any;
+
+                if (config.allowedRecipientList.includes(to?.communicationUser?.id)) {
+                    report(incomingCallContext);
+                }
+            }
+        }
+
+        return res.sendStatus(200);
+    } catch (e) {
+        return res.status(500).send(e);
+    }
+});
+
+export {
+    router as incomingCallHandler,
+    incomingCallRoute
+};

incoming-call-routing/eventHandlers/callConnectionHandler.ts

@@ -0,0 +1,34 @@
+import { CallingServerEventTypeValue } from "@azure/communication-calling-server";
+import { CallConnectionStateChangedEvent, KnownCallConnectionState } from "@azure/communication-calling-server/src/generated/src/models";
+import { IncomingCallEvent } from "../incomingCallEvent";
+import { subscribe, unsubscribeAll } from "./notificationHandler";
+
+function registerCallConnectionDisconnectedEvent(callConnectionId: string) {
+    subscribe(callConnectionId, CallingServerEventTypeValue.CallConnectionStateChangedEvent, async (eventData: IncomingCallEvent) => {
+        const { callConnectionState } = eventData as CallConnectionStateChangedEvent;
+
+        if (callConnectionState === KnownCallConnectionState.Disconnected) {
+            unsubscribeAll(callConnectionId);
+        }
+    });
+}
+
+function registerCallConnectionConnectedEvent(callConnecionId: string, notifyConnectionState: (value :boolean) => void) {
+    subscribe(callConnecionId, CallingServerEventTypeValue.CallConnectionStateChangedEvent, async (eventData: IncomingCallEvent) => {
+        const { callConnectionState } = eventData as CallConnectionStateChangedEvent;
+
+        if (callConnectionState === KnownCallConnectionState.Connected) {
+            notifyConnectionState(true);
+        }
+    });
+}
+
+function establishConnection(callConnecionId: string) {
+    return new Promise<boolean>(resolver => registerCallConnectionConnectedEvent(callConnecionId, resolver));
+}
+
+export { 
+    registerCallConnectionDisconnectedEvent,
+    registerCallConnectionConnectedEvent,
+    establishConnection
+ }

incoming-call-routing/eventHandlers/dtmfEventHandler.ts

@@ -0,0 +1,22 @@
+import { CallingServerEventTypeValue } from "@azure/communication-calling-server";
+import { KnownToneValue, ToneReceivedEvent } from "@azure/communication-calling-server/src/generated/src/models";
+import { IncomingCallEvent, InternalEventTypeValue } from "../incomingCallEvent";
+import { buildEventKey, subscribe, unsubscribe } from "./notificationHandler";
+import { completePlayAudioEvent } from "./playAudioHandler";
+import { transferCall } from "./transferParticipantHandler";
+
+function registerDtmfToneEvent(callConnectionId: string) {
+    subscribe(callConnectionId, CallingServerEventTypeValue.ToneReceivedEvent, async (eventData: IncomingCallEvent) => {
+        const toneReceivedEvent = eventData as ToneReceivedEvent;
+
+        if (toneReceivedEvent?.toneInfo?.tone === KnownToneValue.Tone1) {
+            await completePlayAudioEvent(callConnectionId);
+
+            unsubscribe(buildEventKey(callConnectionId, InternalEventTypeValue.InternalPlayAudioRunningEvent));
+
+            await transferCall(callConnectionId);
+        }
+    });
+}
+
+export { registerDtmfToneEvent }

incoming-call-routing/eventHandlers/eventAuthHandler.ts

@@ -0,0 +1,12 @@
+
+const secretKey = "secret";
+const secretValue = "h3lloW0rld";
+
+const getSecretQueryString = () => `${secretKey}=${encodeURIComponent(secretValue)}`;
+
+const authorize = (query: string | undefined) => query === secretValue;
+
+export {
+    getSecretQueryString,
+    authorize
+};

incoming-call-routing/eventHandlers/notificationHandler.ts

@@ -0,0 +1,71 @@
+import { CloudEvent } from "@azure/eventgrid";
+import {
+    PlayAudioResultEvent,
+    AddParticipantResultEvent,
+} from "@azure/communication-calling-server";
+import { IncomingCallEvent } from "../incomingCallEvent";
+
+interface NotificationEvent {
+    eventKey: string;
+    eventData: IncomingCallEvent;
+};
+
+const notificationCallbacks: Map<string, (eventData: IncomingCallEvent) => void> = new Map();
+
+async function processNotification(event: CloudEvent<IncomingCallEvent>) {
+    const { eventData, eventKey } = extractEvent(event);
+    const notificationCallback = notificationCallbacks.get(eventKey);
+
+    if (notificationCallback !== undefined) {
+        await notificationCallback(eventData);
+
+        return true;
+    }
+
+    return false;
+}
+
+function subscribe(
+    eventContext: string,
+    eventType: string,
+    notificationCallback: (event: IncomingCallEvent) => Promise<void>) {
+    notificationCallbacks.set(buildEventKey(eventContext, eventType), notificationCallback);
+}
+
+function unsubscribe(eventKey: string) {
+    notificationCallbacks.delete(eventKey);
+}
+
+function unsubscribeAll(eventKeyPrefix: string) {
+    notificationCallbacks.forEach((_, key, map) => {
+        if (key.includes(eventKeyPrefix)) {
+            map.delete(key);
+        }
+    });
+}
+
+function buildEventKey(eventContext: string, eventType: string) {
+    return `${eventContext}-${eventType}`;
+}
+
+function extractEvent(event: CloudEvent<IncomingCallEvent>): NotificationEvent {
+    const { type: eventType, data: eventData } = event;
+    const eventKeyPrefix = (hasOperationContext(eventData) ? eventData.operationContext : eventData?.callConnectionId) || "";
+
+    return {
+        eventKey: buildEventKey(eventKeyPrefix, eventType),
+        eventData
+    };
+}
+
+function hasOperationContext(eventData: IncomingCallEvent): eventData is AddParticipantResultEvent | PlayAudioResultEvent {
+    return (eventData as AddParticipantResultEvent || eventData as PlayAudioResultEvent)?.operationContext !== undefined;
+}
+
+export {
+    subscribe,
+    unsubscribe,
+    unsubscribeAll,
+    processNotification,
+    buildEventKey,
+};