Skip to content

Commit f469d8a

Browse files
author
tariq zafar
committed
acrolinx suggestions
1 parent 2abb9b8 commit f469d8a

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

articles/communication-services/quickstarts/chat/quickstart-botframework-integration.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ You will learn how to:
4040

4141
To use Azure Communication Services chat as a channel in Azure Bot Service, the first step is to deploy a bot. You can do so by following below steps:
4242

43-
### Provision an Azure bot service resource in Azure
43+
### Create an Azure bot service resource in Azure
4444

4545
Refer to the Azure Bot Service documentation on how to [create a bot](/azure/bot-service/abs-quickstart?tabs=userassigned).
4646

@@ -49,11 +49,11 @@ To use Azure Communication Services chat as a channel in Azure Bot Service, the
4949

5050
### Get Bot's MicrosoftAppId and MicrosoftAppPassword
5151

52-
Fetch your Azure bot's [Microsoft App Id and secret](/azure/bot-service/abs-quickstart?tabs=userassigned#to-get-your-app-or-tenant-id) as you will need those values for configurations.
52+
Fetch your Azure bot's [Microsoft App ID and secret](/azure/bot-service/abs-quickstart?tabs=userassigned#to-get-your-app-or-tenant-id) as you will need those values for configurations.
5353

5454
### Create a Web App where the bot logic resides
5555

56-
You can check out some samples at [Bot Builder Samples](https://github.com/Microsoft/BotBuilder-Samples) and tweak them or use [Bot Builder SDK](/composer/introduction) to create one. One of the simplest samples is [Echo Bot](https://github.com/microsoft/BotBuilder-Samples/tree/main/samples/csharp_dotnetcore/02.echo-bot). Generally, the Azure Bot Service expects the Bot Application Web App Controller to expose an endpoint `/api/messages`, which handles all the messages reaching the bot. To create the bot application, you can either use Azure CLI to [provision an App Service](/azure/bot-service/provision-app-service?tabs=singletenant%2Cexistingplan) or provision from the portal using below steps.
56+
You can check out some samples at [Bot Builder Samples](https://github.com/Microsoft/BotBuilder-Samples) and tweak them or use [Bot Builder SDK](/composer/introduction) to create one. One of the simplest samples is [Echo Bot](https://github.com/microsoft/BotBuilder-Samples/tree/main/samples/csharp_dotnetcore/02.echo-bot). Generally, the Azure Bot Service expects the Bot Application Web App Controller to expose an endpoint `/api/messages`, which handles all the messages reaching the bot. To create the bot application, you can either use Azure CLI to [create an App Service](/azure/bot-service/provision-app-service?tabs=singletenant%2Cexistingplan) or directly create from the portal using below steps.
5757

5858
1. Select `Create a resource` and in the search box, search for web app and select `Web App`.
5959

@@ -64,7 +64,7 @@ To use Azure Communication Services chat as a channel in Azure Bot Service, the
6464

6565
:::image type="content" source="./media/web-app-create-options.png" alt-text="Web App Create Options":::
6666

67-
3. Review your options and create the Web App and once it has been provisioned, copy the hostname URL exposed by the Web App.
67+
3. Review your options and create the Web App and once it has been created, copy the hostname URL exposed by the Web App.
6868

6969
:::image type="content" source="./media/web-app-endpoint.png" alt-text="Web App endpoint":::
7070

@@ -106,7 +106,7 @@ The final step would be to deploy the Web App we created. The Echo bot functiona
106106
107107
:::image type="content" source="./media/select-app-service.png" alt-text="Select App Service":::
108108
109-
3. Lastly, the above option opens the deployment config. Choose the Web App we had provisioned from the list of options it comes up with after signing into your Azure account. Once ready select `Finish` to complete the profile, and then select `Publish` to start the deployment.
109+
3. Lastly, the above option opens the deployment config. Choose the Web App we had created from the list of options it comes up with after signing into your Azure account. Once ready select `Finish` to complete the profile, and then select `Publish` to start the deployment.
110110
111111
:::image type="content" source="./media/smaller-deployment-config.png" alt-text="Deployment config" lightbox="./media/deployment-config.png":::
112112
@@ -119,12 +119,12 @@ Now that bot is created and deployed, you will need an Azure Communication Servi
119119
## Step 3 - Enable Azure Communication Services Chat channel
120120
With the Azure Communication Services resource, you can set up the Azure Communication Services channel in Azure Bot to assign an Azure Communication Services User ID to a bot.
121121
122-
1. Go to your Bot Services resource on Azure portal. Navigate to `Channels` blade and select `Azure Communications Services - Chat` channel from the list provided.
122+
1. Go to your Bot Services resource on Azure portal. Navigate to `Channels` configuration on the left pane and select `Azure Communications Services - Chat` channel from the list provided.
123123
124124
:::image type="content" source="./media/smaller-demoapp-launch-acs-chat.png" alt-text="DemoApp Launch Acs Chat" lightbox="./media/demoapp-launch-acs-chat.png":::
125125
126126
127-
2. Click the connect button to see a list of ACS resources available under your subscriptions.
127+
2. Select the connect button to see a list of ACS resources available under your subscriptions.
128128
129129
:::image type="content" source="./media/smaller-bot-connect-acs-chat-channel.png" alt-text="DemoApp Connect Acs Resource" lightbox="./media/bot-connect-acs-chat-channel.png":::
130130
@@ -259,7 +259,7 @@ chatClient.DeleteChatThread(threadId);
259259
### Deploy the C# chat application
260260
Follow these steps to deploy the chat application:
261261
1. Open the chat project in Visual Studio.
262-
2. Select the ChatQuickstart project and from the right click menu, select Publish
262+
2. Select the ChatQuickstart project and from the right-click menu, select Publish
263263

264264
:::image type="content" source="./media/deploy-chat-application.png" alt-text="Deploy Chat Application":::
265265

@@ -276,7 +276,7 @@ In addition to sending a plain text message, a bot is also able to receive many
276276

277277
Below are some samples to illustrate these features:
278278

279-
* ### Send a welcome message when a new user is added to the thread
279+
### Send a welcome message when a new user is added to the thread
280280
The current Echo Bot logic accepts input from the user and echoes it back. If you would like to add extra logic such as responding to a participant added Azure Communication Services event, copy the following code snippets and paste into the source file: [EchoBot.cs](https://github.com/microsoft/BotBuilder-Samples/blob/main/samples/csharp_dotnetcore/02.echo-bot/Bots/EchoBot.cs)
281281

282282
```csharp
@@ -313,7 +313,7 @@ namespace Microsoft.BotBuilderSamples.Bots
313313
}
314314
}
315315
```
316-
* ### Send an adaptive card
316+
### Send an adaptive card
317317

318318
Sending adaptive cards to the chat thread can help you increase engagement and efficiency and communicate with users in a variety of ways. You can send adaptive cards from a bot by adding them as bot activity attachments.
319319

@@ -432,7 +432,7 @@ Event payload comprises all json fields in the message content except name field
432432
#### Activities and fields
433433

434434
- Message activity
435-
- `Id` (ACS Chat message Id)
435+
- `Id` (ACS Chat message ID)
436436
- `TimeStamp`
437437
- `Text`
438438
- `Attachments`
@@ -441,21 +441,21 @@ Event payload comprises all json fields in the message content except name field
441441
- `MembersRemoved`
442442
- `TopicName`
443443
- Message update activity
444-
- `Id` (Updated ACS Chat message Id)
444+
- `Id` (Updated ACS Chat message ID)
445445
- `Text`
446446
- `Attachments`
447447
- Message delete activity
448-
- `Id` (Deleted ACS Chat message Id)
448+
- `Id` (Deleted ACS Chat message ID)
449449
- Event activity
450450
- `Name`
451451
- `Value`
452452
- Typing activity
453453

454454
#### Other common fields
455455

456-
- `Recipient.Id` and `Recipeint.Name` (ACS Chat user id and display name)
457-
- `From.Id` and `From.Name` (ACS Chat user id and display name)
458-
- `Conversation.Id` (ACS Chat thread id)
456+
- `Recipient.Id` and `Recipeint.Name` (ACS Chat user ID and display name)
457+
- `From.Id` and `From.Name` (ACS Chat user ID and display name)
458+
- `Conversation.Id` (ACS Chat thread ID)
459459
- `ChannelId` (AcsChat if empty)
460460
- `ChannelData` (ACS Chat message metadata)
461461

@@ -481,11 +481,11 @@ Sometimes the bot wouldn't be able to understand or answer a question or a custo
481481

482482
### Bot gets a forbidden exception while replying to a message
483483

484-
- Verify that bot's Microsoft app id and secret are saved correctly in the bot configuration file uploaded to the webapp.
484+
- Verify that bot's Microsoft App ID and secret are saved correctly in the bot configuration file uploaded to the webapp.
485485

486486
### Bot is not able to be added as a participant
487487

488-
- Verify that bot's ACS Id is being used correctly while sending a request to add bot to a chat thread.
488+
- Verify that bot's ACS ID is being used correctly while sending a request to add bot to a chat thread.
489489

490490
## Next steps
491491

0 commit comments

Comments
 (0)