Important! ACS is in preview, and creation of phone numbers is restricted depending on subscriptions and consumption plans. The phone number creation of this readme is first so that you can confirm whether you are able to create phone numbers in order to proceed with the usage of this adapter. If that feature is not available to your subscription and you don’t already have a Communication Services resource with a phone number, you won’t be able to test this path until the Azure Communication Services team enables it.
This is part of the Bot Builder Community project which contains Bot Framework Components and other projects / packages for use with Bot Framework Composer and the Bot Builder .NET SDK v4.
The Azure Communication Services SMS Adapter allows you to add an additional endpoint to your bot for SMS via Azure Communication Services. The adapter can be used in conjunction with other channels meaning, for example, you can have a bot exposed on out of the box channels such as Facebook and Teams, but also via Azure Communication Services SMS.
Incoming Azure Communication Services SMS events are transformed, by the adapter, into Bot Framework Activties and then when your bot sends outgoing activities, the adapter creates an Azure Communication Services SMS send request to send a reply.
The adapter currently supports the following scenarios;
- SMS received
- SMS send
- SMS delivery reports
This readme focuses on consuming the Azure Communication Services SMS adapter component in Bot Framework Composer. For more information about the supported scenarios and how to consume the adapter in code-first scenarios, visit the Azure Communication Services adapter readme.
- Prerequisites
- Component Installation
- Configure the ACS SMS adapter in Composer
- Configure Azure Communication Services resource
-
Go to Package Manager (in the left hand navigation within Composer) and select 'Community Packages' from the dropdown filter.
-
Install the component in Package Manager by selecting install on the latest version of Bot.Builder.Community.Components.Adapters.ACS.SMS.
Before you can complete the configuration of your ACS SMS skill, you need to wire up the ACS SMS adapter into your bot in Bot Framework Composer.
- In Composer, go to your bot settings. Under the
adapterssection, there should be a new entry calledAzure Communication Services connection. SelectConfigure.
-
A modal will pop up. Fill the Connection string and Phone number with the values obtained in the Azure portal.
-
Once you close the modal, your adapter should appear as configured in the bot settings.
Now that you have created an Azure Communication Services resource and configured the connection in your Composer bot, the final steps are to configure the endpoint to which requests from will be posted to when an SMS is sent to your number, pointing it to the correct endpoint on your bot.
- Deploy your bot to Azure and make a note of the URL to your deployed bot.
NOTE If you are not ready to deploy your bot to Azure, or wish to test / debug your bot locally, you can use a tool such as ngrok (which you will likely already have installed if you have used the Bot Framework emulator previously) to tunnel through to your bot running locally and provide you with a publicly accessible URL for this.
If you wish create an ngrok tunnel and obtain a URL to your bot, use the following command in a terminal window (this assumes your local bot is running on port 3980, alter the port numbers in the command if your bot is not).
ngrok.exe http 3980 -host-header="localhost:3980"
- Configure your ACS resource to handle SMS events. When configuring your ACS event endpoint, specify 'Webhook' as the type and the URL for your endpoint is the URL for your bot, which will be the URL of your deployed application (or ngrok endpoint), plus '/api/acssms' (for example,
https://yourbotapp.azurewebsites.net/api/acssms). Your bot must be running when you configure your endpoint so that the endpoint can be verified by Azure Communication Services.