Skip to content

Commit 58ded3a

Browse files
FelixLin6claude
andauthored
docs: add WhatsApp Business (Official API) channel — usage pages + deployment guide (EN/ZH) (#173)
Adds the WhatsApp Business Cloud API channel to the docs site, mirroring the element set of existing channels (LINE/Zalo precedent): - docs/channels/whatsapp-business.md + zh counterpart (usage tips page) - Row in channels index table (EN/ZH) - Option L / 选项M deployment section + supported-channels table row (EN/ZH) - VitePress sidebar entries (EN/ZH) - Cross-link notes between WhatsApp (QR) and WhatsApp Business (official API) Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent 63eab45 commit 58ded3a

7 files changed

Lines changed: 222 additions & 0 deletions

File tree

‎docs/.vitepress/config.mjs‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,7 @@ export default defineConfig({
258258
{ text: 'Telegram', link: '/channels/telegram' },
259259
{ text: 'Lark / Feishu', link: '/channels/lark' },
260260
{ text: 'WhatsApp', link: '/channels/whatsapp' },
261+
{ text: 'WhatsApp Business', link: '/channels/whatsapp-business' },
261262
{ text: 'WeCom', link: '/getting-started/channel-deployment#option-c-wecom-企业微信-deployment' },
262263
{ text: 'DingTalk', link: '/getting-started/channel-deployment#option-d-dingtalk-钉钉-deployment' },
263264
{ text: 'Slack', link: '/getting-started/channel-deployment#slack' },
@@ -442,6 +443,7 @@ export default defineConfig({
442443
{ text: 'Telegram', link: '/zh/channels/telegram' },
443444
{ text: 'Lark / 飞书', link: '/zh/channels/lark' },
444445
{ text: 'WhatsApp', link: '/zh/channels/whatsapp' },
446+
{ text: 'WhatsApp Business', link: '/zh/channels/whatsapp-business' },
445447
{ text: '企业微信', link: '/zh/getting-started/channel-deployment#option-c-wecom-企业微信-deployment' },
446448
{ text: '钉钉', link: '/zh/getting-started/channel-deployment#option-d-dingtalk-钉钉-deployment' },
447449
{ text: 'Slack', link: '/zh/getting-started/channel-deployment#slack' },

‎docs/channels/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Learn how to get the most out of each communication channel with your COCO AI em
99
| [Telegram](./telegram) | International users, personal & team use | ✅ Available |
1010
| [Lark / Feishu](./lark) | Enterprise teams, document collaboration | ✅ Available |
1111
| [WhatsApp](./whatsapp) | International business, customer-facing | ✅ Available |
12+
| [WhatsApp Business (Official API)](./whatsapp-business) | International business, official API, customer-facing at scale | ✅ Available |
1213
| [WeCom](../getting-started/channel-deployment#option-c-wecom-企业微信-deployment) | China enterprise teams | ✅ Available |
1314
| [DingTalk](../getting-started/channel-deployment#option-d-dingtalk-钉钉-deployment) | China enterprise teams | ✅ Available |
1415
| [Slack](../getting-started/channel-deployment#slack) | International teams, developer workflows | ✅ Available |

‎docs/channels/whatsapp-business.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# WhatsApp Business (Official API) — Usage Tips
2+
3+
Use your COCO AI employee on the official WhatsApp Business Platform (Cloud API) — a verified business number your customers can message from their everyday WhatsApp app. Built for customer-facing business messaging at scale.
4+
5+
> New here? See the [WhatsApp Business Deployment guide](../getting-started/channel-deployment#whatsapp-business) to connect your business number first.
6+
7+
> **WhatsApp Business vs. WhatsApp:** This channel uses Meta's **official Cloud API** — you verify a business phone number by OTP, with no phone or QR linking. The [WhatsApp](./whatsapp) channel links a regular WhatsApp account via QR code instead. Choose this one for official, customer-facing business use.
8+
9+
## Basic Usage
10+
11+
### Direct Messages
12+
Customers send a message to your business number from their normal WhatsApp app — no special command needed. The first person to DM the number becomes the **Owner** with full access.
13+
14+
### Group Chats
15+
Not supported — the official WhatsApp Business Cloud API is **1:1 (DM) only**. If you need group chat support, use the [WhatsApp](./whatsapp) channel instead.
16+
17+
## Best Use Cases
18+
19+
### Customer-Facing Support
20+
The official API is built for business-to-customer messaging:
21+
- Answer FAQs and product questions instantly, around the clock
22+
- Triage and route incoming requests
23+
- Serve customers on the app they already use — no install needed
24+
25+
### Official Business Presence
26+
- Your business display name is shown to customers, backed by Meta's official platform
27+
- No linked phone to keep online — the connection is server-to-server and stays up on its own
28+
- Delivery and read status is tracked for outbound messages
29+
30+
## Pro Tips
31+
32+
**24-hour window**: WhatsApp allows freeform replies within 24 hours of the customer's last message. Outside that window, only pre-approved **template messages** can be sent — the AI employee handles this automatically.
33+
34+
**Media in, media out**: Customers can send images, documents, audio, and video — the AI employee receives them and can reply with text, images, and documents.
35+
36+
**Owner**: The first person to DM the business number becomes the Owner, who always has full access regardless of access settings.
37+
38+
**Access control**: By default only the Owner can DM the number. Adjust the DM policy (owner / allowlist / open) to open it up to customers or a team.
39+
40+
## Troubleshooting
41+
42+
| Issue | Solution |
43+
|-------|----------|
44+
| Bot not responding | Confirm the WhatsApp Business card shows **Connected** in the employee detail page, then send another message |
45+
| Replies not arriving after a long pause | The 24-hour customer-service window has likely closed — send a new message from the customer side to reopen it |
46+
| Can't add the bot to a group | Group chats are not supported by the official Cloud API — this channel is 1:1 only |
47+
| Others can't message the bot | By default only the Owner can chat. Enable Allowlist or Open mode to grant access |
48+
| Want to disconnect | Click the **Disconnect** button on the WhatsApp Business card in the employee detail page |

‎docs/getting-started/channel-deployment.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Detailed guide for connecting your AI employee to Telegram or Lark.
1515
| WeCom (企业微信) | Available | Domestic enterprise users |
1616
| DingTalk (钉钉) | Available | Domestic teams, no public callback needed |
1717
| [WhatsApp](#whatsapp) | Available | International business users |
18+
| [WhatsApp Business (Official API)](#whatsapp-business) | Available | International business, official Cloud API |
1819
| [Discord](#discord) | Available | Developer/community scenarios |
1920
| [Slack](#slack) | Available | European/US enterprise users |
2021
| [Microsoft Teams](#ms-teams) | Available | Enterprise teams, Microsoft 365 organizations |
@@ -815,6 +816,8 @@ Your AI employee will automatically configure the Slack channel connection.
815816

816817
> **Note:** WhatsApp connects via **QR code scanning** (linked device), similar to using WhatsApp Web. No API keys, developer accounts, or app configuration are needed — just a phone with WhatsApp installed.
817818
819+
> **Looking for the official WhatsApp Business API?** This option links a regular WhatsApp account by QR code. For a verified business number on Meta's official Cloud API (no QR or phone linking), see [WhatsApp Business (Official API)](#whatsapp-business).
820+
818821
::: warning Use a Dedicated WhatsApp Account
819822
Please use a **newly registered, dedicated WhatsApp account** for the bot — do **not** use your personal WhatsApp account. The connected account will serve exclusively as the bot's number.
820823
:::
@@ -1457,3 +1460,61 @@ No credentials are required. Authentication is done entirely via QR code:
14571460
| Want to disconnect | Click the **Disconnect** button on the Zalo Personal (Unofficial) card in the employee detail page |
14581461
14591462
-->
1463+
1464+
## Option L: WhatsApp Business (Official API) Deployment {#whatsapp-business}
1465+
1466+
**Estimated time: ~5 minutes**
1467+
1468+
> **Note:** This channel uses Meta's **official WhatsApp Business Platform (Cloud API)**. You bring a phone number, verify it with a one-time code right in the Dashboard, and COCO handles everything on the Meta side — no Meta developer account, API keys, or QR/phone linking needed. Prefer linking a regular WhatsApp account by QR code instead? See [WhatsApp](#whatsapp).
1469+
1470+
No credentials are required. You only need:
1471+
1472+
| Item | Description |
1473+
|------|-------------|
1474+
| COCO AI Employee | An existing instance in COCO Dashboard |
1475+
| Phone Number | A number that can receive an SMS or voice call, and is **not** currently registered on WhatsApp or another WhatsApp Business account |
1476+
| ~5 minutes | Time to complete deployment |
1477+
1478+
### Step 1: Click Connect on the WhatsApp Business Card
1479+
1480+
1. Log into [COCO Dashboard](https://icoco.ai/dashboard) and open the employee instance detail page
1481+
2. Find the **WhatsApp Business** card and click **Connect**
1482+
1483+
### Step 2: Enter Your Phone Number and Display Name
1484+
1485+
1. Enter the phone number you want to use, in international format (e.g. `+1 555 123 4567`)
1486+
2. Enter a **display name** — this is the business name your customers will see in WhatsApp
1487+
3. Check the preview carefully before continuing
1488+
1489+
> **Important:** The display name is reviewed against Meta's display name policy and is **hard to change later** — choose it carefully.
1490+
1491+
### Step 3: Verify with the One-Time Code
1492+
1493+
1. Meta sends a **6-digit verification code** to your number via SMS (a voice call option is available if SMS doesn't arrive)
1494+
2. Enter the code in the wizard
1495+
1496+
> **Mainland China numbers:** SMS delivery to +86 numbers can be unreliable — if the code doesn't arrive, use the **voice call** option.
1497+
1498+
### Step 4: Deploy
1499+
1500+
1. After the code is verified, the system registers your number and deploys the channel automatically — a progress indicator shows each step
1501+
2. When finished, the WhatsApp Business card shows **Connected**
1502+
1503+
### Step 5: Start Chatting
1504+
1505+
1. From any phone with WhatsApp, send a message to your business number
1506+
2. Your AI employee responds immediately — deployment complete!
1507+
1508+
> **First message:** The first user to DM the business number becomes the **Owner** (administrator), who always has full access regardless of policy settings.
1509+
1510+
### WhatsApp Business FAQ
1511+
1512+
| Issue | Solution |
1513+
|-------|----------|
1514+
| Verification code never arrives | Wait a moment and retry, or choose the **voice call** option. SMS to mainland China (+86) numbers is often unreliable |
1515+
| "Number already in use" or verification fails | The number must not be registered on the WhatsApp consumer app or another WhatsApp Business account — remove it there first (WhatsApp → Settings → Account → Delete account), then retry |
1516+
| Closed the wizard before finishing | Your progress is saved — click **Connect** on the WhatsApp Business card again to resume where you left off |
1517+
| Can't use the bot in group chats | The official Cloud API is **1:1 (DM) only**. If you need group chats, use the [WhatsApp](#whatsapp) channel |
1518+
| No reply after a long silence | WhatsApp's **24-hour customer-service window** has closed — send a new message from the customer side to reopen it; outside the window only pre-approved template messages can be sent |
1519+
| Others can't message the bot | By default only the Owner can chat. Enable Allowlist or Open mode to grant access |
1520+
| Want to disconnect | Click the **Disconnect** button on the WhatsApp Business card in the employee detail page |

‎docs/zh/channels/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
| [Telegram](./telegram) | 国际用户、个人及团队使用 | ✅ 可用 |
1010
| [Lark / 飞书](./lark) | 企业团队、文档协作 | ✅ 可用 |
1111
| [WhatsApp](./whatsapp) | 国际业务、面向客户的场景 | ✅ 可用 |
12+
| [WhatsApp Business(官方 API)](./whatsapp-business) | 国际业务、官方 API、规模化客户服务 | ✅ 可用 |
1213
| [企业微信](../getting-started/channel-deployment#option-c-wecom-企业微信-deployment) | 国内企业团队 | ✅ 可用 |
1314
| [钉钉](../getting-started/channel-deployment#option-d-dingtalk-钉钉-deployment) | 国内企业团队 | ✅ 可用 |
1415
| [Slack](../getting-started/channel-deployment#slack) | 国际团队、开发者工作流 | ✅ 可用 |
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# WhatsApp Business(官方 API)— 使用技巧
2+
3+
在官方 WhatsApp Business Platform(Cloud API)上使用 COCO AI 员工——一个经过验证的企业号码,客户直接用日常使用的 WhatsApp 应用就能联系你。专为规模化的企业客户消息场景打造。
4+
5+
> 第一次使用?请先查看 [WhatsApp Business 部署指南](../getting-started/channel-deployment#whatsapp-business) 连接你的企业号码。
6+
7+
> **WhatsApp Business 与 WhatsApp 的区别:** 本渠道使用 Meta 的**官方 Cloud API**——通过 OTP 验证码验证一个企业电话号码,无需手机扫码或设备关联。而 [WhatsApp](./whatsapp) 渠道是通过二维码关联一个普通 WhatsApp 账号。面向客户的正式商务场景请选择本渠道。
8+
9+
## 基本使用
10+
11+
### 私信
12+
客户用普通 WhatsApp 应用给你的企业号码发送消息即可——无需特殊命令。第一个给该号码发私信的用户会成为 **Owner(管理员)**,拥有完整访问权限。
13+
14+
### 群聊
15+
不支持——官方 WhatsApp Business Cloud API 仅支持 **1:1 私信**。如需群聊支持,请改用 [WhatsApp](./whatsapp) 渠道。
16+
17+
## 适用场景
18+
19+
### 面向客户的支持
20+
官方 API 专为企业对客户(B2C)消息场景设计:
21+
- 全天候即时回答常见问题和产品咨询
22+
- 对收到的请求进行分流和路由
23+
- 在客户已经在用的应用上提供服务——无需安装任何东西
24+
25+
### 官方商务形象
26+
- 客户会看到你的企业显示名称,背靠 Meta 官方平台
27+
- 无需保持任何手机在线——连接是服务器对服务器的,自行保持稳定
28+
- 出站消息的送达和已读状态会被跟踪
29+
30+
## 进阶技巧
31+
32+
**24 小时窗口**:WhatsApp 允许在客户最后一条消息后的 24 小时内自由回复。超出该窗口后,只能发送预先审核通过的**模板消息**——AI 员工会自动处理这一逻辑。
33+
34+
**媒体收发**:客户可以发送图片、文档、音频和视频——AI 员工能接收它们,并可回复文字、图片和文档。
35+
36+
**Owner(管理员)**:第一个给企业号码发私信的用户将成为 Owner,始终拥有完整访问权限,不受访问设置限制。
37+
38+
**访问控制**:默认只有 Owner 能私信该号码。可调整私信策略(owner / allowlist / open),向客户或团队开放。
39+
40+
## 故障排除
41+
42+
| 问题 | 解决方案 |
43+
|------|---------|
44+
| 机器人无响应 | 确认员工详情页的 WhatsApp Business 卡片显示为**已连接**,然后再发送一条消息 |
45+
| 长时间未联系后收不到回复 | 24 小时客服窗口可能已关闭——由客户一侧发送一条新消息即可重新打开窗口 |
46+
| 无法把机器人拉进群 | 官方 Cloud API 不支持群聊——本渠道仅支持 1:1 私信 |
47+
| 其他人无法和机器人聊天 | 默认只有 Owner 可以聊天。启用 Allowlist 或 Open 模式以开放访问权限 |
48+
| 想要断开连接 | 在员工详情页的 WhatsApp Business 卡片上点击**断开连接**按钮 |

‎docs/zh/getting-started/channel-deployment.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import { withBase } from 'vitepress'
1717
| [企业微信](#wecom) | 已支持 | 国内企业用户首选 |
1818
| [钉钉](#dingtalk) | 已支持 | 国内团队协作,无需公网回调 |
1919
| [WhatsApp](#whatsapp) | 已支持 | 海外商务用户 |
20+
| [WhatsApp Business(官方 API)](#whatsapp-business) | 已支持 | 国际业务、官方 Cloud API |
2021
| [Discord](#discord) | 已支持 | 开发者/社区场景 |
2122
| [Slack](#slack) | 已支持 | 欧美企业用户 |
2223
| [Microsoft Teams](#ms-teams) | 已支持 | 企业团队、Microsoft 365 组织 |
@@ -947,6 +948,8 @@ AI 员工会自动完成 Slack 渠道的连接配置。
947948

948949
> **说明:** WhatsApp 通过**扫码关联设备**方式接入,无需 API 密钥、开发者账号或应用配置。
949950
951+
> **在找官方 WhatsApp Business API?** 本选项通过二维码关联一个普通 WhatsApp 账号。如需在 Meta 官方 Cloud API 上使用经过验证的企业号码(无需扫码或关联手机),请查看 [WhatsApp Business(官方 API)](#whatsapp-business)。
952+
950953
::: danger 重要提醒:必须使用新的专属号码
951954
为了让这个 AI 员工像独立 Bot 一样正常使用,请务必绑定一个**新的、专属的 WhatsApp 号码**。
952955

@@ -1561,3 +1564,61 @@ LINE 通过两个凭证连接——**Channel Access Token**(通道访问令牌
15611564
| 想要断开连接 | 在员工详情页的 Zalo 个人版(非官方) 卡片上点击 **断开连接** 按钮 |
15621565
15631566
-->
1567+
1568+
## 选项M:WhatsApp Business(官方 API)部署 {#whatsapp-business}
1569+
1570+
**预计用时:约5分钟**
1571+
1572+
> **说明:** 本渠道使用 Meta **官方 WhatsApp Business Platform(Cloud API)**。你只需提供一个电话号码,在 Dashboard 中用一次性验证码完成验证,Meta 侧的所有配置由 COCO 代为处理——无需 Meta 开发者账号、API 密钥,也无需扫码或关联手机。想通过二维码关联普通 WhatsApp 账号?请查看 [WhatsApp](#whatsapp)。
1573+
1574+
无需填写凭证,只需准备:
1575+
1576+
| 所需项目 | 说明 |
1577+
|----------|------|
1578+
| COCO AI 员工 | COCO Dashboard 中已创建的实例 |
1579+
| 电话号码 | 一个能接收短信或语音电话的号码,且**未**注册过 WhatsApp 或其他 WhatsApp Business 账号 |
1580+
| 约5分钟 | 完成部署所需时间 |
1581+
1582+
### 第1步:点击 WhatsApp Business 卡片的「连接」
1583+
1584+
1. 登录 [COCO Dashboard](https://icoco.ai/dashboard),进入员工实例详情页
1585+
2. 找到 **WhatsApp Business** 卡片,点击 **连接**
1586+
1587+
### 第2步:输入电话号码和显示名称
1588+
1589+
1. 按国际格式输入你要使用的电话号码(例如 `+86 130 xxxx xxxx`)
1590+
2. 输入**显示名称**——这是客户在 WhatsApp 中看到的企业名称
1591+
3. 继续之前请仔细核对预览效果
1592+
1593+
> **重要:** 显示名称需符合 Meta 的显示名称政策,且**之后很难更改**——请谨慎选择。
1594+
1595+
### 第3步:输入一次性验证码
1596+
1597+
1. Meta 会通过短信向你的号码发送一个 **6 位验证码**(如果短信收不到,可选择语音电话方式)
1598+
2. 在向导中输入验证码
1599+
1600+
> **中国大陆号码:** 发往 +86 号码的短信可能不稳定——如果收不到验证码,请使用**语音电话**方式。
1601+
1602+
### 第4步:部署
1603+
1604+
1. 验证码通过后,系统会自动注册你的号码并部署渠道——进度指示器会展示每一步
1605+
2. 完成后,WhatsApp Business 卡片显示为**已连接**
1606+
1607+
### 第5步:开始聊天
1608+
1609+
1. 用任意一台装有 WhatsApp 的手机,给你的企业号码发送一条消息
1610+
2. AI 员工会立即响应——部署完成!
1611+
1612+
> **首条消息:** 第一个给企业号码发私信的用户将成为 **Owner(管理员)**,无论权限设置如何始终拥有完整访问权限。
1613+
1614+
### WhatsApp Business 常见问题
1615+
1616+
| 问题 | 解决方案 |
1617+
|------|---------|
1618+
| 收不到验证码 | 稍等后重试,或选择**语音电话**方式。发往中国大陆(+86)号码的短信经常不稳定 |
1619+
| 提示「号码已被使用」或验证失败 | 该号码不能已注册在 WhatsApp 消费者应用或其他 WhatsApp Business 账号上——请先在原处注销(WhatsApp → 设置 → 账号 → 删除账号),然后重试 |
1620+
| 向导中途关闭了 | 进度已保存——再次点击 WhatsApp Business 卡片上的**连接**即可从中断处继续 |
1621+
| 无法在群聊中使用 | 官方 Cloud API 仅支持 **1:1 私信**。如需群聊,请使用 [WhatsApp](#whatsapp) 渠道 |
1622+
| 长时间未联系后收不到回复 | WhatsApp 的 **24 小时客服窗口**已关闭——由客户一侧发送一条新消息即可重新打开;窗口外只能发送预先审核通过的模板消息 |
1623+
| 其他人无法和机器人聊天 | 默认只有 Owner 可以聊天。启用 Allowlist 或 Open 模式以开放访问权限 |
1624+
| 想要断开连接 | 在员工详情页的 WhatsApp Business 卡片上点击**断开连接**按钮 |

0 commit comments

Comments
 (0)