Skip to content

docs(ms-teams): promote "Enable the Teams channel" to its own step (EN+ZH) #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Nanyan merged 1 commit into from
Jun 27, 2026
Merged

docs(ms-teams): promote "Enable the Teams channel" to its own step (EN+ZH) #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/channels/ms-teams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ Teams is deeply integrated with the Microsoft 365 ecosystem — ideal for:
| File downloads failing | Verify `Files.Read.All` permission has admin consent in Azure Portal |
| Smart mode not working | Verify `ChannelMessage.Read.All` has admin consent. Ensure the channel is set to smart mode |
| Credential validation failed | Ensure App Password is the **Value** (not the Secret ID). For single-tenant bots, confirm the Tenant ID is correct |
| No 💬 reaction | Visit `https://<your-agent-domain>/ms-teams/auth/sign-in` to complete the one-time OAuth sign-in. See Step 10 in the deployment guide |
| No 💬 reaction | Visit `https://<your-agent-domain>/ms-teams/auth/sign-in` to complete the one-time OAuth sign-in. See Step 11 in the deployment guide |
| Want to disconnect | Click the **Disconnect** button on the Microsoft Teams card in the employee detail page |
26 changes: 16 additions & 10 deletions docs/getting-started/channel-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -943,11 +943,17 @@ Four credentials are required:
You can find this on the **Microsoft Teams** card in your employee's channel grid on the COCO Dashboard. Copy it and paste it here.
3. Note down the **Microsoft App ID** (this is your **App ID**) and **App Tenant ID** (this is your **Tenant ID**)
4. Click **Apply**
5. Go to **Channels** in the left sidebar, click **Microsoft Teams**, accept the terms, and click **Apply** to enable the Teams channel
### Step 3: Enable the Microsoft Teams Channel

This step is **required and easy to miss** — the bot will not work in Teams without it.

1. In the Azure Bot resource, go to **Channels** in the left sidebar
2. Click **Microsoft Teams**, accept the Terms of Service, and click **Apply**
3. The Microsoft Teams channel should now appear as **Running** in the channel list

> **Important:** The Teams channel must be enabled on the Azure Bot resource. Without it, Teams will show an "Invalid Bot" error when users try to chat with the bot.

### Step 3: Create a Client Secret
### Step 4: Create a Client Secret

1. On the Configuration page, click **Manage Password** — this takes you to the App Registration page
2. Go to **Certificates & secrets**
Expand All @@ -958,7 +964,7 @@ Four credentials are required:

> **Important:** The client secret cannot be viewed again after you leave this page. Save it securely. This is your **App Password**.

### Step 4: Configure Graph API Permissions
### Step 5: Configure Graph API Permissions

Instead of adding permissions one by one through the UI, you can paste them all at once via the manifest editor.

Expand Down Expand Up @@ -1015,7 +1021,7 @@ After saving the manifest, go to **API permissions** and click **Grant admin con

> **Important:** Admin consent is required. Without it, file downloads, chat history, emoji reactions, and smart mode features will not work.

### Step 5: Create App in Teams Developer Portal
### Step 6: Create App in Teams Developer Portal

1. Go to [Teams Developer Portal](https://dev.teams.microsoft.com) and sign in
2. Click **Apps** in the left sidebar, then **+ New app**
Expand All @@ -1030,7 +1036,7 @@ After saving the manifest, go to **API permissions** and click **Grant admin con
- **Terms of use**: `https://docs.icoco.ai/user-agreement`
6. Click **Save**

### Step 6: Configure the App Manifest
### Step 7: Configure the App Manifest

1. In the Teams Developer Portal, go to your app's **App package** → **App package editor**
2. Paste the following manifest JSON, replacing the two placeholders with your actual values:
Expand Down Expand Up @@ -1086,7 +1092,7 @@ After saving the manifest, go to **API permissions** and click **Grant admin con

> **Note on placeholders:** The manifest has two different IDs. `<TEAMS_APP_ID>` is the App ID from the Teams Developer Portal (Step 5) — it appears once in the `id` field. `<AZURE_APP_ID>` is the App ID from Azure (Step 2) — it appears in `botId` and `webApplicationInfo.id`.

### Step 7: Upload App Icons (Optional)
### Step 8: Upload App Icons (Optional)

1. In the Teams Developer Portal, go to your app's **Branding** section
2. Upload the app icons:
Expand All @@ -1096,7 +1102,7 @@ After saving the manifest, go to **API permissions** and click **Grant admin con

> **Tip:** If you skip this step, Teams will use default placeholder icons.

### Step 8: Publish the App
### Step 9: Publish the App

You have two options to distribute the app:

Expand All @@ -1111,7 +1117,7 @@ You have two options to distribute the app:
2. In Microsoft Teams, go to **Apps** → **Manage your apps** → **Upload a custom app**
3. Select the downloaded `.zip` file

### Step 9: Connect in COCO Dashboard
### Step 10: Connect in COCO Dashboard

> **Important:** This step must be done **last** — all 4 credentials are required.

Expand All @@ -1129,7 +1135,7 @@ You have two options to distribute the app:

5. Click **Connect** — the system will validate your credentials and deploy the channel

### Step 10: Enable Reactions (One-Time Setup)
### Step 11: Enable Reactions (One-Time Setup)

To activate the 💬 thinking indicator and emoji reactions:

Expand All @@ -1140,7 +1146,7 @@ To activate the 💬 thinking indicator and emoji reactions:

> **Note:** This only needs to be done once. The bot stores the delegated token and uses it automatically for all reactions going forward.

### Step 11: Start Chatting
### Step 12: Start Chatting

1. In Teams, search for your app name (e.g., `COCO AI Employee`)
2. Click to start a DM conversation
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/channels/ms-teams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ Teams 与 Microsoft 365 生态深度整合，适合：
| 文件下载失败 | 确认 Azure Portal 中 `Files.Read.All` 权限已获得管理员同意 |
| 智能模式不生效 | 确认 `ChannelMessage.Read.All` 已获得管理员同意，确保频道已设置为智能模式 |
| 凭据验证失败 | 确认 App Password 使用的是 **Value**（非 Secret ID）。单租户机器人请确认 Tenant ID 正确 |
| DM 中没有 💬 反应 | 未配置 App Catalog ID。请参阅部署指南第8步 |
| DM 中没有 💬 反应 | 未配置 App Catalog ID。请参阅部署指南第9步 |
| 想要断开连接 | 在员工详情页的 Microsoft Teams 卡片上点击 **断开连接** 按钮 |
24 changes: 15 additions & 9 deletions docs/zh/getting-started/channel-deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1064,11 +1064,17 @@ Bot 需要独立身份。只有使用专属号码，其他人才能把它当作
你可以在 COCO Dashboard 员工详情页的渠道列表中，**Microsoft Teams** 卡片上找到该 URL。复制并粘贴到此处。
3. 记下 **Microsoft App ID**（即你的 **App ID**）和 **App Tenant ID**（即你的 **Tenant ID**）
4. 点击 **Apply**
5. 进入左侧 **Channels**，点击 **Microsoft Teams**，接受条款后点击 **Apply** 以启用 Teams 渠道
### 第3步：启用 Microsoft Teams 渠道

这一步**必需且最容易遗漏**——不启用，Bot 在 Teams 中将无法工作。

1. 在 Azure Bot 资源中，进入左侧 **Channels**
2. 点击 **Microsoft Teams**，接受服务条款后点击 **Apply**
3. 此时 Microsoft Teams 渠道应在列表中显示为 **Running**（运行中）

> **重要：** 必须在 Azure Bot 资源上启用 Teams 渠道。否则用户尝试与 Bot 聊天时，Teams 会显示"Invalid Bot"错误。

### 第3步：创建 Client Secret（客户端密钥）
### 第4步：创建 Client Secret（客户端密钥）

1. 在 Configuration 页面，点击 **Manage Password** — 会跳转到 App Registration 页面
2. 进入 **Certificates & secrets**
Expand All @@ -1079,7 +1085,7 @@ Bot 需要独立身份。只有使用专属号码，其他人才能把它当作

> **注意：** 客户端密钥仅在创建时显示一次，请立即安全保存。这就是你的 **App Password**。

### 第4步：配置 Graph API 权限
### 第5步：配置 Graph API 权限

无需逐个搜索添加权限，可以通过 Manifest 编辑器一次性粘贴全部权限。

Expand Down Expand Up @@ -1130,7 +1136,7 @@ Bot 需要独立身份。只有使用专属号码，其他人才能把它当作

> **注意：** 必须获得管理员同意。否则文件下载、聊天历史、表情回应和智能模式功能将无法使用。

### 第5步：在 Teams Developer Portal 中创建应用
### 第6步：在 Teams Developer Portal 中创建应用

1. 打开 [Teams Developer Portal](https://dev.teams.microsoft.com) 并登录
2. 点击左侧 **Apps**，然后点击 **+ New app**
Expand All @@ -1145,7 +1151,7 @@ Bot 需要独立身份。只有使用专属号码，其他人才能把它当作
- **Terms of use**：`https://docs.icoco.ai/user-agreement`
6. 点击 **Save**

### 第6步：配置应用 Manifest
### 第7步：配置应用 Manifest

1. 在 Teams Developer Portal 中，进入你的应用的 **App package** → **App package editor**
2. 粘贴以下 manifest JSON，将两个占位符替换为你的实际值：
Expand Down Expand Up @@ -1201,7 +1207,7 @@ Bot 需要独立身份。只有使用专属号码，其他人才能把它当作

> **关于占位符：** Manifest 中有两个不同的 ID。`<TEAMS_APP_ID>` 是 Teams Developer Portal 的 App ID（第5步）——在 `id` 字段中出现1次。`<AZURE_APP_ID>` 是 Azure 的 App ID（第2步）——出现在 `botId` 和 `webApplicationInfo.id` 中。

### 第7步：上传应用图标（可选）
### 第8步：上传应用图标（可选）

1. 在 Teams Developer Portal 中，进入你的应用的 **Branding** 部分
2. 上传应用图标：
Expand All @@ -1211,7 +1217,7 @@ Bot 需要独立身份。只有使用专属号码，其他人才能把它当作

> **提示：** 如果跳过此步骤，Teams 将使用默认占位图标。

### 第8步：发布应用
### 第9步：发布应用

有两种方式分发应用：

Expand All @@ -1226,7 +1232,7 @@ Bot 需要独立身份。只有使用专属号码，其他人才能把它当作
2. 在 Microsoft Teams 中，进入 **Apps** → **Manage your apps** → **Upload a custom app**
3. 选择下载的 `.zip` 文件

### 第9步：在 COCO Dashboard 中连接
### 第10步：在 COCO Dashboard 中连接

> **重要：** 此步骤必须**最后**完成——需要全部 4 个配置项。

Expand All @@ -1244,7 +1250,7 @@ Bot 需要独立身份。只有使用专属号码，其他人才能把它当作

5. 点击 **连接** — 系统将验证凭据并部署渠道

### 第10步：开始聊天
### 第11步：开始聊天

1. 在 Teams 中搜索你的应用名称（如 `COCO AI Employee`）
2. 点击即可开始私聊对话
Expand Down
Loading