Skip to content

docs(channel-deployment): add missing EN table anchors + Smart Agent extra permissions step #175

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
tyler-0xffff merged 1 commit into from
Jul 8, 2026
Merged

docs(channel-deployment): add missing EN table anchors + Smart Agent extra permissions step #175

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
58 changes: 48 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 @@ -10,10 +10,10 @@ Detailed guide for connecting your AI employee to Telegram or Lark.

| Channel | Status | Best For |
|---------|--------|----------|
| Telegram | Available | International users, personal use |
| Lark (Feishu) | Available | Domestic teams, enterprise use |
| WeCom (企业微信) | Available | Domestic enterprise users |
| DingTalk (钉钉) | Available | Domestic teams, no public callback needed |
| [Telegram](#telegram) | Available | International users, personal use |
| [Lark (Feishu)](#lark-feishu) | Available | Domestic teams, enterprise use |
| [WeCom (企业微信)](#wecom) | Available | Domestic enterprise users |
| [DingTalk (钉钉)](#dingtalk) | Available | Domestic teams, no public callback needed |
| [WhatsApp](#whatsapp) | Available | International business users |
| [WhatsApp Business (Official API)](#whatsapp-business) | Available | International business, official Cloud API |
| [Discord](#discord) | Available | Developer/community scenarios |
Expand Down Expand Up @@ -41,7 +41,7 @@ Detailed guide for connecting your AI employee to Telegram or Lark.

---

## Option A: Telegram Deployment (Recommended for international users)
## Option A: Telegram Deployment (Recommended for international users) {#telegram}

**Estimated time: 5-8 minutes**

Expand Down Expand Up @@ -85,7 +85,7 @@ Detailed guide for connecting your AI employee to Telegram or Lark.

---

## Option B: Lark / Feishu Deployment
## Option B: Lark / Feishu Deployment {#lark-feishu}

**Estimated time: 8-15 minutes**

Expand Down Expand Up @@ -148,7 +148,26 @@ In the Developer Backend, find the **Create Lark Smart Agent App** banner at the

<br>

##### Step 5: Search for Bot and Start Chatting
##### Step 5: Add Required Permissions for Group Chats

The permissions granted automatically at creation only cover basic messaging. For your AI employee to work properly in group chats and display real user names, manually enable the following 4 scopes:

1. Back in the [Lark Developer Backend](https://open.larksuite.com), open your app and go to **Permissions & Scopes**
2. Search for each scope ID below and click **Enable**:

| Scope | Purpose | If missing |
|-------|---------|------------|
| `im:message.group_msg` | Receive group messages and respond to @mentions | Bot cannot see group messages |
| `im:chat:readonly` | Read group info and member lists | Names show as ID fragments (e.g. `c08f09`) |
| `contact:user.base:readonly` | Resolve user IDs to real names | User names are unreadable |
| `contact:user.employee_id:readonly` | Match users by employee ID | Users cannot be identified by employee ID |

3. For each scope, set the **data permission scope** to **All** — if it is limited to specific groups, the bot will not work in groups outside that list
4. If your organization requires approval for permission changes, publish a new app version for them to take effect (if the bot still reports 403 errors, check **Version Management & Release**)

<br>

##### Step 6: Search for Bot and Start Chatting

Once connected, search for the bot name you just set up in the **Lark client**, confirm the bot has been created, and click to start chatting.

Expand Down Expand Up @@ -369,7 +388,26 @@ In the Developer Backend, find the **Create Feishu Smart Agent App** banner at t

<br>

##### Step 5: Search for Bot and Start Chatting
##### Step 5: Add Required Permissions for Group Chats

The permissions granted automatically at creation only cover basic messaging. For your AI employee to work properly in group chats and display real user names, manually enable the following 4 scopes:

1. Back in the [Feishu Developer Backend](https://open.feishu.cn), open your app and go to **Permissions & Scopes**
2. Search for each scope ID below and click **Enable**:

| Scope | Purpose | If missing |
|-------|---------|------------|
| `im:message.group_msg` | Receive group messages and respond to @mentions | Bot cannot see group messages |
| `im:chat:readonly` | Read group info and member lists | Names show as ID fragments (e.g. `c08f09`) |
| `contact:user.base:readonly` | Resolve user IDs to real names | User names are unreadable |
| `contact:user.employee_id:readonly` | Match users by employee ID | Users cannot be identified by employee ID |

3. For each scope, set the **data permission scope** to **All** — if it is limited to specific groups, the bot will not work in groups outside that list
4. If your organization requires approval for permission changes, publish a new app version for them to take effect (if the bot still reports 403 errors, check **Version Management & Release**)

<br>

##### Step 6: Search for Bot and Start Chatting

After connection is complete, search for your bot name in the **Feishu client**, confirm the bot has been created correctly, and click to start chatting.

Expand Down Expand Up @@ -540,7 +578,7 @@ In the Permission Management page, copy the following JSON and import all permis

---

## Option C: WeCom (企业微信) Deployment
## Option C: WeCom (企业微信) Deployment {#wecom}

**Estimated time: ~5 minutes**

Expand Down Expand Up @@ -587,7 +625,7 @@ In the COCO Dashboard, go to the employee instance detail page → **Conversatio

---

## Option D: DingTalk (钉钉) Deployment
## Option D: DingTalk (钉钉) Deployment {#dingtalk}

**Estimated time: 8-12 minutes**

Expand Down
42 changes: 40 additions & 2 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 @@ -155,7 +155,26 @@ Lark（海外版）和飞书（国内版）的操作流程略有不同，请根

<br>

##### 第5步：搜索机器人并开始聊天
##### 第5步：为群聊补充必要权限

创建时自动开通的权限仅覆盖基础的消息收发。要让 AI 员工在群聊中正常工作、正确显示成员姓名，需手动开通以下 4 个权限：

1. 回到[飞书开发者后台](https://open.feishu.cn)，打开你的应用，进入 **权限管理**
2. 逐个搜索下方权限标识并点击 **开通**：

| 权限 | 用途 | 缺少时的表现 |
|------|------|------------|
| `im:message.group_msg` | 接收群消息、响应 @ 提及 | 机器人收不到群消息 |
| `im:chat:readonly` | 读取群信息和成员列表 | 姓名显示为 ID 片段（如 `c08f09`）|
| `contact:user.base:readonly` | 将用户 ID 解析为真实姓名 | 无法显示可读的用户姓名 |
| `contact:user.employee_id:readonly` | 通过工号匹配用户身份 | 无法按工号识别用户 |

3. 每个权限开通后，将 **数据权限范围** 设置为 **全部**——如果只授权部分群组，机器人在未覆盖的群里将无法工作
4. 如企业对权限变更有审核要求，需发布新版本后才能生效（若机器人仍报 403 错误，请检查 **版本管理与发布**）

<br>

##### 第6步：搜索机器人并开始聊天

连接完成后，在 **飞书客户端** 搜索您刚设置的机器人名字，确认机器人已正确创建，点击进去和机器人聊天即可。

Expand Down Expand Up @@ -438,7 +457,26 @@ Lark 提供两种部署方式，请根据你的需求选择：

<br>

##### 第5步：搜索机器人并开始聊天
##### 第5步：为群聊补充必要权限

创建时自动开通的权限仅覆盖基础的消息收发。要让 AI 员工在群聊中正常工作、正确显示成员姓名，需手动开通以下 4 个权限：

1. 回到[Lark 开发者后台](https://open.larksuite.com)，打开你的应用，进入 **权限管理**
2. 逐个搜索下方权限标识并点击 **开通**：

| 权限 | 用途 | 缺少时的表现 |
|------|------|------------|
| `im:message.group_msg` | 接收群消息、响应 @ 提及 | 机器人收不到群消息 |
| `im:chat:readonly` | 读取群信息和成员列表 | 姓名显示为 ID 片段（如 `c08f09`）|
| `contact:user.base:readonly` | 将用户 ID 解析为真实姓名 | 无法显示可读的用户姓名 |
| `contact:user.employee_id:readonly` | 通过工号匹配用户身份 | 无法按工号识别用户 |

3. 每个权限开通后，将 **数据权限范围** 设置为 **全部**——如果只授权部分群组，机器人在未覆盖的群里将无法工作
4. 如企业对权限变更有审核要求，需发布新版本后才能生效（若机器人仍报 403 错误，请检查 **版本管理与发布**）

<br>

##### 第6步：搜索机器人并开始聊天

连接完成后，在 **Lark 客户端** 搜索您刚设置的机器人名字，确认机器人已正确创建，点击进去和机器人聊天即可。

Expand Down
Loading