Skip to content

Commit 8b636e6

Browse files
committed
Adding section for quickstarts
1 parent 2e9a2f5 commit 8b636e6

File tree

3 files changed

+273
-0
lines changed

3 files changed

+273
-0
lines changed
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: include file
3+
description: include file
4+
services: azure-communication-services
5+
author: jjsanchezms
6+
manager: chpalm
7+
ms.service: azure-communication-services
8+
ms.subservice: azure-communication-services
9+
ms.date: 07/20/2022
10+
ms.topic: include
11+
ms.custom: include file
12+
ms.author: sanchezjuan
13+
---
14+
15+
## Prerequisites
16+
17+
- An Azure account with an active subscription, or [create an Azure account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
18+
19+
- An active Azure Communication Services resource, or [create a Communication Services resource](../../create-communication-resource.md).
20+
21+
- An active Azure Logic Apps resource, or [create a blank logic app with the trigger that you want to use](../../../../logic-apps/quickstart-create-first-logic-app-workflow.md). Currently, the Communication Services Chat connector provides only actions, so your logic app requires a trigger, at minimum.
22+
23+
## Create user
24+
25+
Complete these steps in Power Automate with your Power Automate flow open in edit mode.
26+
27+
To add a new step in your workflow by using the Communication Services Identity connector:
28+
29+
1. In the designer, under the step where you want to add the new action, select **New step**. Alternatively, to add the new action between steps, move your pointer over the arrow between those steps, select the plus sign (+), and then select **Add an action**.
30+
31+
1. In the **Choose an operation** search box, enter **Communication Services Identity**. In the list of actions list, select **Create a user**.
32+
33+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-create-user.png" alt-text="Screenshot that shows the Azure Communication Services Identity connector Create user action.":::
34+
35+
1. Enter the connection string. To get the connection string URL in the [Azure portal](https://portal.azure.com/), go to the Azure Communication Services resource. In the resource menu, select **Keys**, and then select **Connection string**. Select the copy icon to copy the connection string.
36+
37+
:::image type="content" source="../media/logic-app/azure-portal-connection-string.png" alt-text="Screenshot that shows the Keys pane for an Azure Communication Services resource." lightbox="../media/logic-app/azure-portal-connection-string.png":::
38+
39+
1. Enter a name for the connection.
40+
41+
1. Select **Show advanced options**, and then select the token scope. The action generates an access token and its expiration time with the specified scope. This action also generates a user ID that's a Communication Services user identity.
42+
43+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-create-user-action.png" alt-text="Screenshot that shows the Azure Communication Services Identity connector Create user action options.":::
44+
45+
1. In **Token Scopes Item**, select **chat**.
46+
47+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-create-user-action-advanced.png" alt-text="Screenshot that shows the Azure Communication Services Chat connector advanced options.":::
48+
49+
1. Select **Create**. The user ID and an access token are shown.
50+
51+
## Create a chat thread
52+
53+
1. Add a new action.
54+
55+
1. In the **Choose an operation** search box, enter **Communication Services Chat**. In the list of actions, select **Create chat thread**.
56+
57+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-create-chat-thread.png" alt-text="Screenshot that shows the Azure Communication Services Chat connector Create a chat thread action.":::
58+
59+
1. Enter the Communication Services endpoint URL. To get the endpoint URL in the [Azure portal](https://portal.azure.com/), go to the Azure Communication Services resource. In the resource menu, select **Keys**, and then select **Endpoint**.
60+
61+
1. Enter a name for the connection.
62+
63+
1. Select the access token that was generated in the preceding section, and then add a chat thread topic description. Add the created user and enter a name for the participant.
64+
65+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-create-chat-thread-input.png" alt-text="Screenshot that shows the Azure Communication Services Chat connector Create chat thread action dialog.":::
66+
67+
## Send a message
68+
69+
1. Add a new action.
70+
71+
1. In the **Choose an operation** search box, enter **Communication Services Chat**. In the list of actions, select **Send message to chat thread**.
72+
73+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-send-chat-message.png" alt-text="Screenshot that shows the Azure Communication Services Chat connector Send chat message action.":::
74+
75+
1. Enter the access token, thread ID, content, and name.
76+
77+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-send-chat-message-input.png" alt-text="Screenshot that shows the Azure Communication Services Chat connector Send chat message action dialog.":::
78+
79+
## List chat thread messages
80+
81+
To verify that you sent a message correctly:
82+
83+
1. Add a new action.
84+
85+
1. In the **Choose an operation** search box, enter **Communication Services Chat**. In the list of actions, select **List chat thread messages**.
86+
87+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-list-chat-messages.png" alt-text="Screenshot that shows the Azure Communication Services Chat connector List chat messages action.":::
88+
89+
1. Enter the access token and thread ID.
90+
91+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-list-chat-messages-input.png" alt-text="Screenshot that shows the Azure Communication Services Chat connector List chat messages action dialog.":::
92+
93+
## Test your logic app
94+
95+
To manually start your workflow, on the designer toolbar, select **Run**. The workflow creates a user, issues an access token for that user, and then removes the token and deletes the user. For more information, review [How to run your workflow](../../../../logic-apps/quickstart-create-first-logic-app-workflow.md#run-workflow).
96+
97+
Now, select **List chat thread messages**. In the action outputs, check for the message that was sent.
98+
99+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-list-chat-messages-output.png" alt-text="Screenshot that shows the Azure Communication Services Chat connector Send chat message action results.":::
100+
101+
## Clean up workflow resources
102+
103+
To clean up your logic app workflow and related resources, review [how to clean up Logic Apps resources](../../../../logic-apps/quickstart-create-first-logic-app-workflow.md#clean-up-resources).
104+
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: include file
3+
description: include file
4+
author: sanchezjuan
5+
manager: chpalm
6+
services: azure-communication-services
7+
ms.author: sanchezjuan
8+
ms.date: 03/03/2023
9+
ms.topic: include
10+
ms.service: azure-communication-services
11+
ms.custom: mode-other
12+
---
13+
14+
15+
## Prerequisites
16+
17+
- An Azure account with an active subscription, or [create an Azure account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
18+
19+
- An active Azure Communication Services resource, or [create a Communication Services resource](../../create-communication-resource.md).
20+
21+
- An active Logic Apps resource (logic app), or [create a blank logic app but with the trigger that you want to use](../../../../logic-apps/quickstart-create-first-logic-app-workflow.md). Currently, the Azure Communication Services Email connector provides only actions, so your logic app requires a trigger, at minimum.
22+
23+
- An Azure Communication Services Email resource with a [configured domain](../../email/create-email-communication-resource.md) or [custom domain](../../email/add-custom-verified-domains.md).
24+
25+
- An Azure Communication Services resource [connected with an Azure Email domain](../../email/connect-email-communication-resource.md).
26+
27+
28+
29+
## Send email
30+
31+
Add a new step in your workflow by using the Azure Communication Services Email connector, follow these steps in Power Automate with your Power Automate flow open in edit mode.
32+
33+
1. On the designer, under the step where you want to add the new action, select New step. Alternatively, to add the new action between steps, move your pointer over the arrow between those steps, select the plus sign (+), and select Add an action.
34+
35+
1. In the Choose an operation search box, enter Communication Services Email. From the actions list, select Send email.
36+
37+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-send-email.png" alt-text="Screenshot that shows the Azure Communication Services Email connector Send email action.":::
38+
39+
1. Provide the Connection String. This can be found in the [Microsoft Azure](https://portal.azure.com/), within your Azure Communication Service Resource, on the Keys option from the left menu > Connection String
40+
41+
:::image type="content" source="../media/logic-app/azure-communications-services-connection-string.png" alt-text="Screenshot that shows the Azure Communication Services Connection String." lightbox="../media/logic-app/azure-communications-services-connection-string.png":::
42+
43+
1. Provide a Connection Name
44+
45+
1. Select Send email
46+
47+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-send-email.png" alt-text="Screenshot that shows the Azure Communication Services Email connector Send email action.":::
48+
49+
1. Fill the **From** input field using an email domain configured in the [pre-requisites](#prerequisites). Also fill the To, Subject and Body field as shown below
50+
51+
:::image type="content" source="../media/logic-app/azure-communications-services-connector-send-email-input.png" alt-text="Screenshot that shows the Azure Communication Services Email connector Send email action input.":::
52+
53+
54+
55+
## Test your logic app
56+
57+
To manually start your workflow, on the designer toolbar, select **Run**. The workflow should create a user, issue an access token for that user, then remove it and delete the user. For more information, review [how to run your workflow](../../../../logic-apps/quickstart-create-first-logic-app-workflow.md#run-workflow). You can check the outputs of these actions after the workflow runs successfully.
58+
59+
You should have an email in the address specified. Additionally, you can use the Get email message status action to check the status of emails send through the Send email action. To learn more actions, check the [Azure Communication Services Email connector](/connectors/acsemail/) documentation.
60+
61+
## Clean up workflow resources
62+
63+
To clean up your logic app workflow and related resources, review [how to clean up Logic Apps resources](../../../../logic-apps/quickstart-create-first-logic-app-workflow.md#clean-up-resources).
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: include file
3+
description: include file
4+
services: azure-communication-services
5+
author: chpalm
6+
manager: anvalent
7+
8+
ms.service: azure-communication-services
9+
ms.subservice: azure-communication-services
10+
ms.date: 06/30/2021
11+
ms.topic: include
12+
ms.custom: include file
13+
ms.author: chpalm
14+
---
15+
16+
17+
By using the [Azure Communication Services SMS](../../../overview.md) connector and [Azure Logic Apps](../../../../logic-apps/logic-apps-overview.md), you can create automated workflows that can send SMS messages. This quickstart shows how to automatically send text messages in response to a trigger event, which is the first step in a logic app workflow. A trigger event can be an incoming email message, a recurrence schedule, an [Azure Event Grid](../../../../event-grid/overview.md) resource event, or any other [trigger that's supported by Azure Logic Apps](/connectors/connector-reference/connector-reference-logicapps-connectors).
18+
19+
:::image type="content" source="../media/logic-app/azure-communication-services-connector.png" alt-text="Screenshot that shows the Azure portal, which is open to the Logic App Designer, and shows an example logic app that uses the Send SMS action for the Azure Communication Services connector.":::
20+
21+
Although this quickstart focuses on using the connector to respond to a trigger, you can also use the connector to respond to other actions, which are the steps that follow the trigger in a workflow. If you're new to Logic Apps, review [What is Azure Logic Apps](../../../../logic-apps/logic-apps-overview.md) before you get started.
22+
23+
> [!NOTE]
24+
> Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.
25+
26+
## Prerequisites
27+
28+
- An Azure account with an active subscription, or [create an Azure account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
29+
30+
- An active Azure Communication Services resource, or [create a Communication Services resource](../../create-communication-resource.md).
31+
32+
- An active Logic Apps resource (logic app), or [create a blank logic app but with the trigger that you want to use](../../../../logic-apps/quickstart-create-first-logic-app-workflow.md). Currently, the Azure Communication Services SMS connector provides only actions, so your logic app requires a trigger, at minimum.
33+
34+
This quickstart uses the **When a new email arrives** trigger, which is available with the [Office 365 Outlook connector](/connectors/office365/).
35+
36+
- An SMS enabled phone number, or [get a phone number](./../../telephony/get-phone-number.md).
37+
38+
[!INCLUDE [Regional Availability Notice](../../../includes/regional-availability-include.md)]
39+
40+
## Add an SMS action
41+
42+
To add the **Send SMS** action as a new step in your workflow by using the Azure Communication Services SMS connector, follow these steps in the [Azure portal](https://portal.azure.com) with your logic app workflow open in the Logic App Designer:
43+
44+
1. On the designer, under the step where you want to add the new action, select **New step**. Alternatively, to add the new action between steps, move your pointer over the arrow between those steps, select the plus sign (**+**), and select **Add an action**.
45+
46+
1. In the **Choose an operation** search box, enter `Azure Communication Services`. From the actions list, select **Send SMS**.
47+
48+
:::image type="content" source="../media/logic-app/select-send-sms-action.png" alt-text="Screenshot that shows the Logic App Designer and the Azure Communication Services connector with the Send SMS action selected.":::
49+
50+
1. Now create a connection to your Communication Services resource.
51+
1. Within the same subscription:
52+
53+
1. Provide a name for the connection.
54+
55+
1. Select your Azure Communication Services resource.
56+
57+
1. Select **Create**.
58+
59+
:::image type="content" source="../media/logic-app/send-sms-configuration.png" alt-text="Screenshot that shows the Send SMS action configuration with sample information.":::
60+
61+
1. Using the connection string from your Communication Services resource:
62+
63+
1. Provide a name for the connection.
64+
65+
1. Select ConnectionString Authentication from the drop down options.
66+
67+
1. Enter the connection string of your Communication Services resource.
68+
69+
1. Select **Create**.
70+
71+
:::image type="content" source="../media/logic-app/connection-string-auth.png" alt-text="Screenshot that shows the Connection String Authentication configuration.":::
72+
73+
1. Using Service Principal ([Refer Services Principal Creation](../../identity/service-principal-from-cli.md)):
74+
1. Provide a name for the connection.
75+
76+
1. Select Service principal (Azure AD application) Authentication from the drop down options.
77+
78+
1. Enter the Tenant ID, Client ID & Client Secret of your Service Principal.
79+
80+
1. Enter the Communication Services Endpoint URL value of your Communication Services resource.
81+
82+
1. Select **Create**.
83+
84+
:::image type="content" source="../media/logic-app/service-principal-auth.png" alt-text="Screenshot that shows the Service Principal Authentication configuration.":::
85+
86+
1. In the **Send SMS** action, provide the following information:
87+
88+
* The source and destination phone numbers. For testing purposes, you can use your own phone number as the destination phone number.
89+
90+
* The message content that you want to send, for example, "Hello from Logic Apps!".
91+
92+
Here's a **Send SMS** action with example information:
93+
94+
:::image type="content" source="../media/logic-app/send-sms-action.png" alt-text="Screenshot that shows the Send SMS action with sample information.":::
95+
96+
1. When you're done, on the designer toolbar, select **Save**.
97+
98+
Next, run your logic app workflow for testing.
99+
100+
## Test your logic app
101+
102+
To manually start your workflow, on the designer toolbar, select **Run**. Or, you can wait for the trigger to fire. In both cases, the workflow should send an SMS message to your specified destination phone number. For more information, review [how to run your workflow](../../../../logic-apps/quickstart-create-first-logic-app-workflow.md#run-workflow).
103+
104+
## Clean up workflow resources
105+
106+
To clean up your logic app workflow and related resources, review [how to clean up Logic Apps resources](../../../../logic-apps/quickstart-create-first-logic-app-workflow.md#clean-up-resources).

0 commit comments

Comments
 (0)