page_type | description | products | languages | extensions | contentType | createdDate | ||||
---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample illustrates how you can use Teams App Chat Life Cycle by calling Microsoft Graph APIs. . |
|
|
samples |
07-07-2021 13:38:26 |
This sample illustrates Lifecycle of chat in Teams (Creating chat, adding members with all scenarios, deleting member).
-
Node.js version 10.14 or higher
# determine node version node --version
-
Ngrok (Only for devbox testing) Latest (any other tunneling software can also be used)
# run ngrok locally ngrok http -host-header=localhost 3978
-
Teams Microsoft Teams is installed and you have an account
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
In a terminal, navigate to
samples/graph-chat-lifecycle/nodejs
cd samples/graph-chat-lifecycle/nodejs
-
Install modules
npm install
-
Start the bot
npm start
If you are using Visual Studio code
- Launch Visual Studio code
- Folder -> Open -> Project/Solution
- Navigate to
samples\graph-chat-lifecycle\nodejs
folder - Select
graph-chat-lifecycle\nodejs
Folder
- Run ngrok - point to port 3978
ngrok http -host-header=rewrite 3978
- Register a new application in the Azure Active Directory – App Registrations portal.
- Select New Registration and on the register an application page, set following values:
- Set name to your app name.
- Choose the supported account types (any account type will work)
- Leave Redirect URI empty.
- Choose Register.
- On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You’ll need those later when updating your Teams application manifest and in the appsettings.json.
- Under Manage, select Expose an API.
- Select the Set link to generate the Application ID URI in the form of
api://{AppID}
. Insert your fully qualified domain name (with a forward slash "/" appended to the end) between the double forward slashes and the GUID. The entire ID should have the form of:api://fully-qualified-domain-name/{AppID}
- ex:
api://%ngrokDomain%.ngrok.io/00000000-0000-0000-0000-000000000000
.
- ex:
- Select the Add a scope button. In the panel that opens, enter
access_as_user
as the Scope name. - Set Who can consent? to
Admins and users
- Fill in the fields for configuring the admin and user consent prompts with values that are appropriate for the
access_as_user
scope:- Admin consent title: Teams can access the user’s profile.
- Admin consent description: Allows Teams to call the app’s web APIs as the current user.
- User consent title: Teams can access the user profile and make requests on the user's behalf.
- User consent description: Enable Teams to call this app’s APIs with the same rights as the user.
- Ensure that State is set to Enabled
- Select Add scope
- The domain part of the Scope name displayed just below the text field should automatically match the Application ID URI set in the previous step, with
/access_as_user
appended to the end:- `api://[ngrokDomain].ngrok.io/00000000-0000-0000-0000-000000000000/access_as_user.
- The domain part of the Scope name displayed just below the text field should automatically match the Application ID URI set in the previous step, with
- In the Authorized client applications section, identify the applications that you want to authorize for your app’s web application. Each of the following IDs needs to be entered:
1fec8e78-bce4-4aaf-ab1b-5451cc387264
(Teams mobile/desktop application)5e3ce6c0-2b1f-4285-8d4b-75ee78787346
(Teams web application)
- Navigate to API Permissions, and make sure to add the follow permissions:
- Select Add a permission
- Select Microsoft Graph -> Delegated permissions.
- User.Read (enabled by default)
- offline_access
- OpenId
- profile
- Chat.Create
- Chat.ReadWrite
- ChatMember.ReadWrite
- TeamsAppInstallation.ReadWriteForChat
- TeamsAppInstallation.ReadWriteSelfForChat
- TeamsTab.Create
- TeamsTab.ReadWriteForChat
- TeamsTab.ReadWrite.All
- User.Read.All
- Click on Add permissions.
-
Navigate to Authentication If an app hasn't been granted IT admin consent, users will have to provide consent the first time they use an app. Set a redirect URI:
- Select Add a platform.
- Select web.
- Enter the redirect URI for the app in the following format: https://%ngrokDomain%.ngrok.io/auth/auth-end. This will be the page where a successful implicit grant flow will redirect the user.
Enable implicit grant by checking the following boxes:
✔ ID Token
✔ Access Token -
Navigate to the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description (Name of the secret) for the secret and select “Never” for Expires. Click "Add". Once the client secret is created, copy its value, it need to be placed in the appsettings.json.
-
This step is specific to Teams.
- Edit the
manifest.json
contained in theManifest
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 themanifest.json
). Also, replace your Base url wherever you see the place holder string<<YOUR-BASE-URL>>
. - Zip up the contents of the
teamsAppManifest
folder to create amanifest.zip
- Upload the
manifest.zip
to Teams (in the Apps view click "Upload a custom app")
- Edit the
-
Update your
config/default.json
file- Replace the
tab.id
property with you Azure AD application ID. - Replace the
tab.password
property with the "client secret" you were assigned. - If you want to use a port other than 3978, fill that in here (and in your ngrok command)
- Replace the
- In Teams, Once the app is successfully installed, it can be opened in the tab and has option to create group chat if user is authenticated.
- Once create group chat is clicked, user will be able to add Title of the groupchat and select users from drop down to create a group chat and add members (using different scenarios) and delete member accordingly to depict the lifecycle of chat.
- Also, Polly app will be installed to the created group chat and will be pinned to the chat.