Merge branch 'Azure-Samples:main' into main

callautomation-live-transcription/.gitignore

@@ -0,0 +1,30 @@
+# Ignore node_modules directory
+node_modules/
+
+# Ignore environment variables file
+.env
+
+# Ignore build output directory
+dist/
+build/
+public/assets/
+
+# Ignore IDE/Editor-specific files
+.vscode/
+.vs
+.idea/
+
+# Ignore user-specific configuration files
+.npmrc
+.gitconfig
+
+# Ignore log files
+*.log
+
+# Ignore OS-generated files
+.DS_Store
+Thumbs.db
+
+# Ignore package lock files
+package-lock.json
+yarn.lock

callautomation-live-transcription/README.md

@@ -0,0 +1,74 @@
+|page_type|languages|products
+|---|---|---|
+|sample|<table><tr><td>Typescript</tr></td></table>|<table><tr><td>azure</td><td>azure-communication-services</td></tr></table>|
+
+# Call Automation - Quick Start Sample
+
+This sample application shows how the Azure Communication Services  - Call Automation SDK can be used generate the live transcription between PSTN calls. 
+It accepts an incoming call from a phone number, performs DTMF recognition, and transfer the call to agent. You can see the live transcription in websocket during the conversation between agent and user. The application is a web-based application built on .Net7 framework.
+
+## Prerequisites
+
+- Create an Azure account with an active subscription. For details, see [Create an account for free](https://azure.microsoft.com/free/)
+- [Visual Studio Code](https://code.visualstudio.com/download) installed
+- [Node.js](https://nodejs.org/en/download) installed
+- Create an Azure Communication Services resource. For details, see [Create an Azure Communication Resource](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource). You will need to record your resource **connection string** for this sample.
+- Get a phone number for your new Azure Communication Services resource. For details, see [Get a phone number](https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/telephony/get-phone-number?tabs=windows&pivots=programming-language-csharp)
+- Create Azure AI Multi Service resource. For details, see [Create an Azure AI Multi service](https://learn.microsoft.com/en-us/azure/cognitive-services/cognitive-services-apis-create-account).
+- Install ngrok. Instructions [here](https://ngrok.com/)
+- Setup websocket
+
+## Before running the sample for the first time
+
+1. Open an instance of PowerShell, Windows Terminal, Command Prompt or equivalent and navigate to the directory that you would like to clone the sample to.
+2. git clone `https://github.com/Azure-Samples/communication-services-javascript-quickstarts.git`.
+3. cd into the `callautomation-live-transcription` folder.
+4. From the root of the above folder, and with node installed, run `npm install`
+
+### Setup and host ngrok
+
+You can run multiple tunnels on ngrok by changing ngrok.yml file as follows:
+
+1. Open the ngrok.yml file from a powershell using the command ngrok config edit
+2. Update the ngrok.yml file as follows:
+    authtoken: xxxxxxxxxxxxxxxxxxxxxxxxxx
+    version: "2"
+    region: us
+    tunnels:
+    first:
+        addr: 8080
+        proto: http 
+        host_header: localhost:8080
+    second:
+        proto: http
+        addr: 5001
+        host_header: localhost:5001
+NOTE: Make sure the "addr:" field has only the port number, not the localhost url.
+3. Start all ngrok tunnels configured using the following command on a powershell - ngrok start --all
+4. Once you have setup the websocket server, note down the the ngrok url on your server's port as the websocket url in this application for incoming call scenario. Just replace the https:// with wss:// and update in the .env file.
+
+### Add a Managed Identity to the ACS Resource that connects to the Cognitive Services Resource
+
+Follow the instructions in the [documentation](https://learn.microsoft.com/en-us/azure/communication-services/concepts/call-automation/azure-communication-services-azure-cognitive-services-integration).
+
+### Configuring application
+
+Open the `.env` file to configure the following settings
+
+1. `CALLBACK_HOST_URI`:  Base url of the app. (For local development replace the above ngrok url from the above for the port 8080).
+1. `COGNITIVE_SERVICE_ENDPOINT`: Azure Multi Service endpoint.
+1. `ACS_CONNECTION_STRING`: Azure Communication Service resource's connection string.
+2. `ACS_PHONE_NUMBER`: Phone number associated with the Azure Communication Service resource. For e.g. "+1425XXXAAAA"
+3. `TRANSPORT_URL`: Ngrok url for the server port (in this example port 5001) make sure to replace https:// with wss://
+3. `LOCALE`: Transcription locale
+4. `AGENT_PHONE_NUMBER`: Phone number associated to with Agent
+
+### Run app locally
+
+1. Open a new Powershell window, cd into the `callautomation-live-transcription` folder and run `npm run dev:app`
+2. Browser should pop up with the below page. If not navigate it to `http://localhost:8080/`
+3. Open a new Powershell window, cd into the `callautomation-live-transcription` folder and run `npm run dev:websocket`
+4. Configure websocket url as transport url ex. `wss://localhost:5001`
+5. Register an EventGrid Webhook for the IncomingCall Event that points to your DevTunnel URI endpoint ex `{CALLBACK_HOST_URI}/api/incomingCall` and register Recording File Status Updated event to you recordingstatus api endpoint ex. `{CALLBACK_HOST_URI}/api/recordingFileStatus`. Instructions [here](https://learn.microsoft.com/en-us/azure/communication-services/concepts/call-automation/incoming-call-notification).
+
+Once that's completed you should have a running application. The best way to test this is to place a call to your ACS phone number and talk to your intelligent agent.

callautomation-live-transcription/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "callautomation_live_transcription",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "build": "tsc",
+    "dev:app": "nodemon ./src/app.ts",
+    "dev:websocket": "nodemon ./src/websocket.ts"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@azure/communication-call-automation": "^1.3.0-beta.2",
+    "@azure/communication-common": "^2.2.0",
+    "@azure/eventgrid": "^4.12.0",
+    "@azure/openai": "^1.0.0-beta.7",
+    "@types/express": "^4.17.17",
+    "@types/node": "^20.2.1",
+    "dotenv": "^16.3.1",
+    "express": "^4.18.2",
+    "uuid": "^9.0.1",
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "nodemon": "^3.0.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  }
+}