From c1ec639fc6a8b8abc7702431d0904c5cb55640bb Mon Sep 17 00:00:00 2001 From: Victor Chapel Date: Tue, 21 Jan 2025 21:12:04 -0600 Subject: [PATCH 1/2] Update README.md Fixed telephony link and minor edits. --- direct-routing-quickstart/README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/direct-routing-quickstart/README.md b/direct-routing-quickstart/README.md index 2abab627..0f33e423 100644 --- a/direct-routing-quickstart/README.md +++ b/direct-routing-quickstart/README.md @@ -10,33 +10,33 @@ products: # Direct Routing Configuration -For full instructions on how to build this code sample from scratch, look at [Quickstart: Direct Routing](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/voice-routing-sdk-config?pivots=programming-language-javascript) +To build this code sample from scratch, see [Configure voice routing programmatically](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony/voice-routing-sdk-config?pivots=programming-language-javascript). ## Prerequisites -- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) . +- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F). - [Node.js](https://nodejs.org/en/) Active LTS and Maintenance LTS versions (8.11.1 and 10.14.1 recommended). - An active Communication Services resource and connection string. [Create a Communication Services resource](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource). ## Install the package -npm install @azure/communication-phone-numbers@1.2.0-alpha.20230214.1 --save +`npm install @azure/communication-phone-numbers@1.2.0-alpha.20230214.1 --save` ## Before running sample code -1. Open an instance of PowerShell, Windows Terminal, Command Prompt or equivalent and navigate to the directory that you'd like to clone the sample to. +1. Open an instance of PowerShell, Windows Terminal, Command Prompt or equivalent and navigate to the directory where you want to clone the sample. 2. `git clone https://github.com/Azure-Samples/communication-services-javascript-quickstarts.git` -3. With the Communication Services procured in pre-requisites, add connection string to environment variable using below command -With the `Connection String` procured in pre-requisites, add it to the *./direct-routing-quickstart* file. Assign your connection string in line 4: +3. Note your resource name and the connection string generated when you created a Communication Services resource during prerequisites. Replace variables with the appropriate values on line 4 of the *./direct-routing-quickstart* file. -```javascript -const connectionString = "endpoint=https://.communication.azure.com/;accesskey="; -``` + ```javascript + const connectionString = "endpoint=https://.communication.azure.com/;accesskey="; + ``` +4. Save and close the file. ## Run the code -From a console prompt, navigate to the directory containing the *direct-routing-quickstart.js* file, then execute the following node command to run the app. +From a console prompt, navigate to the directory containing the *direct-routing-quickstart.js* file. Use the following node command to run the app. ```console node direct-routing-quickstart.js -``` \ No newline at end of file +``` From 811e46354deb56524a1d85b917025f6b4b6b2eea Mon Sep 17 00:00:00 2001 From: vac0224 <101754834+vac0224@users.noreply.github.com> Date: Thu, 30 Jan 2025 19:19:54 -0600 Subject: [PATCH 2/2] More telephony link fixes ... --- README.md | 4 ++-- add-1-on-1-phone-calling/README.md | 12 +++++++----- phone-numbers-quickstart/README.md | 16 ++++++++-------- send-sms/README.md | 16 ++++++++-------- use-managed-Identity/README.md | 12 ++++++------ 5 files changed, 31 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index a19f97cb..3ce449cb 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,13 @@ Azure Communication Services enable developers to add communication capabilities 1. [Add Voice Calling to your Web App](https://docs.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/getting-started-with-calling?pivots=platform-javascript) -2. [Send SMS](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/send?pivots=programming-language-javascript) +2. [Send SMS](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony/send?pivots=programming-language-javascript) 3. [Add Chat to your app](https://docs.microsoft.com/azure/communication-services/quickstarts/chat/get-started?pivots=programming-language-javascript) 4. [Add Video Calling to your Web App](https://docs.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/get-started-with-video-calling) -5. [Manage Phone Numbers](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/get-phone-number?pivots=programming-language-javascript) +5. [Manage Phone Numbers](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony/get-phone-number?pivots=programming-language-javascript) 6. [Create and manage access tokens](https://docs.microsoft.com/azure/communication-services/quickstarts/access-tokens?pivots=programming-language-javascript) diff --git a/add-1-on-1-phone-calling/README.md b/add-1-on-1-phone-calling/README.md index 818623cb..2ca2af6a 100644 --- a/add-1-on-1-phone-calling/README.md +++ b/add-1-on-1-phone-calling/README.md @@ -9,16 +9,17 @@ 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 describes the process of integrating 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. +This sample includes the code that is explained as part of [Outbound call to a telephone number](https://docs.microsoft.com/azure/communication-services/quickstarts/voice-video-calling/pstn-call?pivots=platform-web). See that document for more information about how this sample works. ## Prerequisites + - An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F). - [Node.js](https://nodejs.org/en/) Active LTS and Maintenance LTS versions (8.11.1 and 10.14.1). - An active Communication Services resource. [Create a Communication Services resource](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource). - A user access token to instantiate the call client. [Learn how to create and manage user access tokens](https://docs.microsoft.com/azure/communication-services/quickstarts/access-tokens?pivots=programming-language-javascript). -- A phone number acquired in your Communication Services resource. [how to get a phone number](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/get-phone-number?pivots=programming-language-javascript). +- A phone number acquired in your Communication Services resource. [how to get a phone number](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony/get-phone-number?pivots=programming-language-javascript). ## Before running sample code @@ -27,13 +28,14 @@ This quickstart sample includes the code that is explained as part of [this docu ```call = callAgent.startCall([{phoneNumber: phoneToCall}], { alternateCallerId: {phoneNumber: 'ACS Number'}});```. ## 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: - npx webpack-dev-server --entry ./client.js --output bundle.js --debug --devtool inline-source-map + ```npx webpack-dev-server --entry ./client.js --output bundle.js --debug --devtool inline-source-map``` Open your browser and navigate to http://localhost:8080/. You should see the following: ![Render of sample application](../media/add-1-on-1-phone-calling.png) -You can make an 1:1 outgoing phone call by providing a phone number in the text field and clicking the Start Call button. +You can make a 1:1 outgoing phone call by providing a phone number in the text field and clicking **Start Call**. diff --git a/phone-numbers-quickstart/README.md b/phone-numbers-quickstart/README.md index 8b9b39ac..5be819a7 100644 --- a/phone-numbers-quickstart/README.md +++ b/phone-numbers-quickstart/README.md @@ -9,28 +9,28 @@ products: # Manage Phone Numbers -For full instructions on how to build this code sample from scratch, look at [Quickstart: Manage Phone Numbers](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/get-phone-number?pivots=programming-language-javascript) +For full instructions to build this code sample from scratch, see [Manage Phone Numbers](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony/get-phone-number?pivots=programming-language-javascript) ## Prerequisites -- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F) . +- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F). - [Node.js](https://nodejs.org/en/) Active LTS and Maintenance LTS versions (8.11.1 and 10.14.1 recommended). - An active Communication Services resource and connection string. [Create a Communication Services resource](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource). ## Install the package -npm install @azure/communication-phone-numbers --save +`npm install @azure/communication-phone-numbers --save` ## Before running sample code -1. Open an instance of PowerShell, Windows Terminal, Command Prompt or equivalent and navigate to the directory that you'd like to clone the sample to. +1. Open an instance of PowerShell, Windows Terminal, Command Prompt or equivalent and navigate to the directory where you want to clone the sample. 2. `git clone https://github.com/Azure-Samples/communication-services-javascript-quickstarts.git` -3. With the Communication Services procured in pre-requisites, add connection string to environment variable using below command +3. With the Communication Services procured in pre-requisites, add the connection string to environment variable using below command. -setx COMMUNICATION_SERVICES_CONNECTION_STRING +`setx COMMUNICATION_SERVICES_CONNECTION_STRING ` ## Run the code -From a console prompt, navigate to the directory containing the phone-numbers-quickstart.js file, then execute the following node command to run the app. +From a console prompt, navigate to the directory containing the `phone-numbers-quickstart.js` file, then execute the following node command to run the app. -node phone-numbers-quickstart.js \ No newline at end of file +`node phone-numbers-quickstart.js` \ No newline at end of file diff --git a/send-sms/README.md b/send-sms/README.md index 8d7665f9..efd18ee6 100644 --- a/send-sms/README.md +++ b/send-sms/README.md @@ -10,26 +10,26 @@ products: # Send an SMS Message Quickstart -For full instructions on how to build this code sample from scratch, look at [Quickstart: Send an SMS Message](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/send?pivots=programming-language-javascript) +For instructions to build this code sample from scratch, see [Send an SMS Message](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony/send?pivots=programming-language-javascript). ## Prerequisites -- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F). +- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F). - [Visual Studio Code](https://code.visualstudio.com/) on one of the [supported platforms](https://code.visualstudio.com/docs/supporting/requirements#_platforms). -- [Node.js](https://nodejs.org/), Active LTS and Maintenance LTS versions (10.14.1 recommended). Use the `node --version` command to check your version. +- [Node.js](https://nodejs.org/), Active LTS and Maintenance LTS versions (10.14.1 recommended). Use the `node --version` command to check your version. - An active Communication Services resource and connection string. [Create a Communication Services resource](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource). -- An SMS enabled telephone number. [Get a phone number](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/get-phone-number). +- An SMS enabled telephone number. [Get a phone number](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony/get-phone-number). ## Code Structure -- **./send-SMS/send-sms.js:** Core application code with send SMS implementation. +- `./send-SMS/send-sms.js:` Core application code with send SMS implementation. ## Before running sample code -1. Open an instance of PowerShell, Windows Terminal, Command Prompt or equivalent and navigate to the directory that you'd like to clone the sample to. +1. Open an instance of PowerShell, Windows Terminal, Command Prompt or equivalent and navigate to the directory where you'd like to clone the sample. 2. `git clone https://github.com/Azure-Samples/Communication-Services-javascript-quickstarts.git` -3. With the `Connection String` procured in pre-requisites, follow [instructions](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?pivots=#store-your-connection-string) to add it to your environment variables. -4. With the SMS enabled telephone number procured in pre-requisites, add it to the **send-SMS/send-sms.js** file. Assign your telephone number in line 7: +3. With the `Connection String` procured in pre-requisites, follow the instructions at [Create and manage Communication Services resources > Store your connection string](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?pivots=#store-your-connection-string) to add it to your environment variables. +4. With the SMS enabled telephone number procured in pre-requisites, add it to the `send-SMS/send-sms.js` file. Assign your telephone number in line 7: ```from: "",``` 5. Add a phone number to send the SMS to in line 8: ```to: ["", ""],``` diff --git a/use-managed-Identity/README.md b/use-managed-Identity/README.md index bfaa5065..8c277cf1 100644 --- a/use-managed-Identity/README.md +++ b/use-managed-Identity/README.md @@ -10,26 +10,26 @@ products: # Use managed identities Quickstart -For full instructions on how to build this code sample from scratch, look at [Quickstart: Use managed identities](https://docs.microsoft.com/azure/communication-services/quickstarts/managed-identity?pivots=programming-language-javascript) +For instructions to build this code sample from scratch, see [Use managed identities](https://docs.microsoft.com/azure/communication-services/quickstarts/managed-identity?pivots=programming-language-javascript). ## Prerequisites -- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F). +- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F). - An active Communication Services resource. [Create a Communication Services resource](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource). -- An SMS enabled telephone number. [Get a phone number](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony-sms/get-phone-number?pivots=programming-language-javascript). +- An SMS enabled telephone number. [Get a phone number](https://docs.microsoft.com/azure/communication-services/quickstarts/telephony/get-phone-number?pivots=programming-language-javascript). - A setup managed identity for a development environment,see [Authorize access with managed identity](https://docs.microsoft.com/azure/communication-services/quickstarts/managed-identity-from-cli). ## Code Structure -- **./use-managed-Identity/index.js:** Core application code with managed identity implementation. +- `./use-managed-Identity/index.js:` Core application code with managed identity implementation. ## Before running sample code 1. Open an instance of PowerShell, Windows Terminal, Command Prompt or equivalent and navigate to the directory that you'd like to clone the sample to. 2. git clone https://github.com/Azure-Samples/Communication-Services-javascript-quickstarts.git -3. With the `endpoint` procured in pre-requisites, add it to the **index.js** file. Assign your endpoint in line 28: +3. With the `endpoint` procured in pre-requisites, add it to the `index.js` file. Assign your endpoint in line 28: ```const endpoint = "https://.communication.azure.com/"``` -4. With the SMS enabled telephone number procured in pre-requisites, add it to the **index.js** file. Assign your ACS telephone number and sender number in line 38: +4. With the SMS enabled telephone number procured in pre-requisites, add it to the `index.js` file. Assign your ACS telephone number and sender number in line 38: ```const smsResult = await sendSms(endpoint, "", "", "Hello from Managed Identities");``` ## Run Locally