Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.
/ UnifiTeamsBot Public archive

Just a simple Microsoft Teams bot that creates Hotspot Voucher Codes on Unifi Platforms for your Guests

License

Notifications You must be signed in to change notification settings

TobiKr/UnifiTeamsBot

Repository files navigation

UnifiTeamsBot

Teams Bot to manage Unifi hotspot vouchers based on Auth Bot. The following features are offered:

  • Azure AD Authentication
  • Ask user to choose the voucher validity period
  • Aks the user to comment the purpose of the voucher
  • Create the voucher via Unifi REST API

This bot has been created using Bot Framework and the TeamsAuthSample.

IMPORTANT: This is an early stage development

Prerequisites

  • Microsoft Teams is installed and you have an account (not a guest account)

  • .NET Core SDK version 2.1

  • ngrok or equivalent tunnelling solution

  • Forked Version of UniFiSharp: https://github.com/TobiKr/UniFiSharp (hopefully it will be merged :-)

    # determine dotnet version
    dotnet --version

To try this bot

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

  1. Clone the repositories

    git clone https://github.com/TobiKr/UniFiSharp.git
    git clone https://github.com/TobiKr/UnifiTeamsBot.git
  2. If you are using Visual Studio

    • Open the solution
    • Change the appsettings.json to suite your needs
    • The manifest file in this app adds "token.botframework.com" to the list of validDomains
  3. Run ngrok - point to port 3940

    ngrok http -host-header=rewrite 3940
  4. Create Bot Framework registration resource in Azure

  5. Update the appsettings.json configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.)

  6. This step is specific to Teams.

    • Edit the manifest.json contained in the teamsAppManifest folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string <<YOUR-MICROSOFT-APP-ID>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
    • Zip up the contents of the teamsAppManifest folder to create a manifest.zip
    • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")
  7. Run your bot, either from Visual Studio with F5 or using dotnet run in the appropriate folder.

Interacting with the bot in Teams

Note this manifest.json specified that the bot will be installed in a "personal" scope only. Please refer to Teams documentation for more details.

You can interact with this bot by sending it a message. The bot will respond by requesting you to login to AAD, then making a call to the Graph API on your behalf and returning the results.

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions. I will provider a CI/CD setup later.

About

Just a simple Microsoft Teams bot that creates Hotspot Voucher Codes on Unifi Platforms for your Guests

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published