Skip to content

Commit 42ca0d6

Browse files
authored
Merge pull request #2370 from OfficeDev/v-hrajandira/UpdatingTeamsSDKReadme
docs: Add Teams SDK troubleshooting guide with language-specific issu…
2 parents 0355bf2 + 3e91967 commit 42ca0d6

8 files changed

Lines changed: 85 additions & 13 deletions

File tree

samples/TeamsSDK/bot-ai-messages/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,16 @@ Once provisioning completes, start your bot - the sample will pick up the creden
8585

8686
> **Tip**: Using an AI coding assistant (GitHub Copilot CLI, Claude Code, Cursor, VS Code)? Install the [`teams-dev` agent skill](https://microsoft.github.io/teams-sdk/developer-tools/agent-skills) to drive these CLI steps from natural language - your assistant runs the right commands, manages credentials, and guides you through bot registration end-to-end.
8787
88-
## Troubleshooting
88+
# Teams SDK Troubleshooting
89+
90+
If you encounter errors you believe exists in Teams SDK, you can file an issue in GitHub for the langauge in which you encountered the issue
91+
- [C#](https://github.com/microsoft/teams.net/issues/new/choose)
92+
- [TypeScript](https://github.com/microsoft/teams.ts/issues/new/choose)
93+
- [Python](https://github.com/microsoft/teams.py/issues/new/choose)
94+
95+
You can file general issues that exists across all SDK langauges [here](https://github.com/microsoft/teams-sdk/issues/new/choose)
96+
97+
## General Troubleshooting
8998

9099
- If Teams cannot communicate with your bot, verify your DevTunnels URL is reachable.
91100
- Ensure your `.env` or `appsettings.json` file is set up correctly.

samples/TeamsSDK/bot-attachments/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,16 @@ Once provisioning completes, start your bot - the sample will pick up the creden
8585

8686
> **Tip**: Using an AI coding assistant (GitHub Copilot CLI, Claude Code, Cursor, VS Code)? Install the [`teams-dev` agent skill](https://microsoft.github.io/teams-sdk/developer-tools/agent-skills) to drive these CLI steps from natural language - your assistant runs the right commands, manages credentials, and guides you through bot registration end-to-end.
8787
88-
## Troubleshooting
88+
# Teams SDK Troubleshooting
89+
90+
If you encounter errors you believe exists in Teams SDK, you can file an issue in GitHub for the langauge in which you encountered the issue
91+
- [C#](https://github.com/microsoft/teams.net/issues/new/choose)
92+
- [TypeScript](https://github.com/microsoft/teams.ts/issues/new/choose)
93+
- [Python](https://github.com/microsoft/teams.py/issues/new/choose)
94+
95+
You can file general issues that exists across all SDK langauges [here](https://github.com/microsoft/teams-sdk/issues/new/choose)
96+
97+
## General Troubleshooting
8998

9099
- If Teams cannot communicate with your bot, verify your DevTunnels URL is reachable.
91100
- Ensure your `.env` or `appsettings.json` file is set up correctly.

samples/TeamsSDK/bot-auth-quickstart/README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -396,15 +396,23 @@ For Python:
396396
```bash
397397
python main.py
398398
```
399+
# Teams SDK Troubleshooting
399400

400-
## Troubleshooting
401+
If you encounter errors you believe exists in Teams SDK, you can file an issue in GitHub for the langauge in which you encountered the issue
402+
- [C#](https://github.com/microsoft/teams.net/issues/new/choose)
403+
- [TypeScript](https://github.com/microsoft/teams.ts/issues/new/choose)
404+
- [Python](https://github.com/microsoft/teams.py/issues/new/choose)
401405

402-
- If Teams cannot communicate with your bot, verify your DevTunnels URL is reachable
403-
- Ensure your configuration file (`.env`, `appsettings.json`) is set up correctly
406+
You can file general issues that exists across all SDK langauges [here](https://github.com/microsoft/teams-sdk/issues/new/choose)
407+
408+
## General Troubleshooting
409+
410+
- If Teams cannot communicate with your bot, verify your DevTunnels URL is reachable.
411+
- Ensure your `.env` or `appsettings.json` file is set up correctly.
412+
- Use the Channels UI in Azure Bot Service in the Azure Portal to see detailed endpoint errors.
404413
- Verify that `"token.botframework.com"` is included in `validDomains` in your manifest.json
405414
- For OAuth issues, confirm your Azure AD app registration has the correct redirect URIs
406415
- Check that admin consent has been granted for the required Graph API permissions
407-
- Use the Channels UI in Azure Bot Service in the Azure Portal to see detailed endpoint errors
408416

409417
### Enabling Verbose Logs
410418

samples/TeamsSDK/bot-cards/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,16 @@ Once provisioning completes, start your bot - the sample will pick up the creden
8484

8585
> **Tip**: Using an AI coding assistant (GitHub Copilot CLI, Claude Code, Cursor, VS Code)? Install the [`teams-dev` agent skill](https://microsoft.github.io/teams-sdk/developer-tools/agent-skills) to drive these CLI steps from natural language - your assistant runs the right commands, manages credentials, and guides you through bot registration end-to-end.
8686
87-
## Troubleshooting
87+
# Teams SDK Troubleshooting
88+
89+
If you encounter errors you believe exists in Teams SDK, you can file an issue in GitHub for the langauge in which you encountered the issue
90+
- [C#](https://github.com/microsoft/teams.net/issues/new/choose)
91+
- [TypeScript](https://github.com/microsoft/teams.ts/issues/new/choose)
92+
- [Python](https://github.com/microsoft/teams.py/issues/new/choose)
93+
94+
You can file general issues that exists across all SDK langauges [here](https://github.com/microsoft/teams-sdk/issues/new/choose)
95+
96+
## General Troubleshooting
8897

8998
- If Teams cannot communicate with your bot, verify your DevTunnels URL is reachable.
9099
- Ensure your `.env` or `appsettings.json` file is set up correctly.

samples/TeamsSDK/bot-meetings/README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,10 +226,20 @@ Once the bot is running and added to Teams, you can interact with it in meetings
226226
- Request and view meeting transcripts
227227
- Use adaptive cards to interact with meeting data
228228

229-
## Troubleshooting
229+
# Teams SDK Troubleshooting
230230

231-
- If Teams cannot communicate with your bot, verify your tunnel URL is reachable
232-
- Ensure your `.env` or `appsettings.json` file is set up correctly
231+
If you encounter errors you believe exists in Teams SDK, you can file an issue in GitHub for the langauge in which you encountered the issue
232+
- [C#](https://github.com/microsoft/teams.net/issues/new/choose)
233+
- [TypeScript](https://github.com/microsoft/teams.ts/issues/new/choose)
234+
- [Python](https://github.com/microsoft/teams.py/issues/new/choose)
235+
236+
You can file general issues that exists across all SDK langauges [here](https://github.com/microsoft/teams-sdk/issues/new/choose)
237+
238+
## General Troubleshooting
239+
240+
- If Teams cannot communicate with your bot, verify your DevTunnels URL is reachable.
241+
- Ensure your `.env` or `appsettings.json` file is set up correctly.
242+
- Use the Channels UI in Azure Bot Service in the Azure Portal to see detailed endpoint errors.
233243
- Verify that admin consent has been granted for the required Graph API permissions
234244
- Check that the application access policy has been configured correctly for your user
235245
- Confirm that Meeting event subscriptions are enabled in the bot registration (in the [Teams Developer Portal](https://dev.teams.microsoft.com), under **Tools** -> **Bot management** -> your bot)

samples/TeamsSDK/bot-message-extensions/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,16 @@ Once provisioning and manifest configuration are complete, start your bot and si
123123

124124
> **Tip**: Using an AI coding assistant (GitHub Copilot CLI, Claude Code, Cursor, VS Code)? Install the [`teams-dev` agent skill](https://microsoft.github.io/teams-sdk/developer-tools/agent-skills) to drive the CLI provisioning and manifest steps from natural language - your assistant runs the right commands, manages credentials, and guides you through bot registration end-to-end.
125125
126-
## Troubleshooting
126+
# Teams SDK Troubleshooting
127+
128+
If you encounter errors you believe exists in Teams SDK, you can file an issue in GitHub for the langauge in which you encountered the issue
129+
- [C#](https://github.com/microsoft/teams.net/issues/new/choose)
130+
- [TypeScript](https://github.com/microsoft/teams.ts/issues/new/choose)
131+
- [Python](https://github.com/microsoft/teams.py/issues/new/choose)
132+
133+
You can file general issues that exists across all SDK langauges [here](https://github.com/microsoft/teams-sdk/issues/new/choose)
134+
135+
## General Troubleshooting
127136

128137
- If Teams cannot communicate with your bot, verify your DevTunnels URL is reachable.
129138
- Ensure your `.env` or `appsettings.json` file is set up correctly.

samples/TeamsSDK/bot-quickstart/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,16 @@ Once provisioning completes, start your bot - the sample will pick up the creden
8585

8686
> **Tip**: Using an AI coding assistant (GitHub Copilot CLI, Claude Code, Cursor, VS Code)? Install the [`teams-dev` agent skill](https://microsoft.github.io/teams-sdk/developer-tools/agent-skills) to drive these CLI steps from natural language - your assistant runs the right commands, manages credentials, and guides you through bot registration end-to-end.
8787
88-
## Troubleshooting
88+
# Teams SDK Troubleshooting
89+
90+
If you encounter errors you believe exists in Teams SDK, you can file an issue in GitHub for the langauge in which you encountered the issue
91+
- [C#](https://github.com/microsoft/teams.net/issues/new/choose)
92+
- [TypeScript](https://github.com/microsoft/teams.ts/issues/new/choose)
93+
- [Python](https://github.com/microsoft/teams.py/issues/new/choose)
94+
95+
You can file general issues that exists across all SDK langauges [here](https://github.com/microsoft/teams-sdk/issues/new/choose)
96+
97+
## General Troubleshooting
8998

9099
- If Teams cannot communicate with your bot, verify your DevTunnels URL is reachable.
91100
- Ensure your `.env` or `appsettings.json` file is set up correctly.

samples/TeamsSDK/bot-task-modules/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,16 @@ Once provisioning completes, start your bot - the sample will pick up the creden
108108

109109
> **Tip**: Using an AI coding assistant (GitHub Copilot CLI, Claude Code, Cursor, VS Code)? Install the [`teams-dev` agent skill](https://microsoft.github.io/teams-sdk/developer-tools/agent-skills) to drive these CLI steps from natural language - your assistant runs the right commands, manages credentials, and guides you through bot registration end-to-end.
110110
111-
## Troubleshooting
111+
# Teams SDK Troubleshooting
112+
113+
If you encounter errors you believe exists in Teams SDK, you can file an issue in GitHub for the langauge in which you encountered the issue
114+
- [C#](https://github.com/microsoft/teams.net/issues/new/choose)
115+
- [TypeScript](https://github.com/microsoft/teams.ts/issues/new/choose)
116+
- [Python](https://github.com/microsoft/teams.py/issues/new/choose)
117+
118+
You can file general issues that exists across all SDK langauges [here](https://github.com/microsoft/teams-sdk/issues/new/choose)
119+
120+
## General Troubleshooting
112121

113122
- If Teams cannot communicate with your bot, verify your DevTunnels URL is reachable.
114123
- Ensure your `.env` or `appsettings.json` file is set up correctly.

0 commit comments

Comments
 (0)