入门指南
本教程将介绍如何设置本地 API 客户端、注册公司电话号码、更新设置以及发送测试消息。
此 API 的入门流程可以分为 3 个部分：
- 准备所需资产：开始之前，您必须准备完成 API 集成所需的资产，包括 WhatsApp Business 商业帐号。
- 安装本地 API 客户端：安装 API 客户端。客户端能正常运行后，您可以更新应用程序设置。
- 开始使用客户端：向
/account发出 API 调用以注册电话号码，并对/messages发出调用以发送测试消息。
准备工作
您需要：
- 为 WhatsApp Business 商业帐号设置的额度：您还可参阅本地 API 账单简介，了解有关账单流程的详情。
- 命令行工具（如 Terminal）或可以执行 cURL 请求的应用（如 Postman）。
在您完成公司验证后，系统将审查您的公司是否符合 WhatsApp 服务条款和 WhatsApp 商业政策。系统将自动开始此步骤。您可以在商务管理平台 WhatsApp Business 商业帐号的设置选项卡中检查公司验证状态以及公司审查状态。经批准后，公司验证和帐号状态将分别显示为已认证和已批准。
创建 WhatsApp 帐户
向您的 WhatsApp Business 商业帐号添加手机号及其显示名。此操作将提交显示名以供审核。
如要更改显示名，您可以在完成注册前多次随意更改，注册完成后，如提交显示名更改请求，您必须等待 30 日。
完成所有审核后，您可以查看和访问以 Base64 方式编码的证书，此证书是您注册本地 API 客户端的必要条件。在您进一步更改显示名之前，我们鼓励您使用已批准的显示名进行注册，以便开始集成。集成后，您可以随时更改显示名。
查看账单和定价信息
在您的公司开始通过本地 API 发送消息后，请务必了解账单流程，如收费方式和时间以及月度结算单的查看和支付方式。如需更多信息，请参阅 WhatsApp Business 商业帐号的账单简介。如要进一步了解定价规则和每则消息的成本，请参阅我们的定价页面。
软件的推荐版本
| 软件 | 版本 | 详情 |
|---|---|---|
本地 API | ||
AWS 版本地 API | 模板版本： | |
MySQL |
| 请注意，已迁移到 MySQL 8 的数据库不能降级到 MySQL 5。因此，迁移前请备份好数据库。 |
PostgreSQL |
| 支持 |
Docker |
| 自 确保 statx 系统调用位于 docker 的系统调用许可清单中。 |
Postman | 任何最新版本 | |
libseccomp |
| 只支持 |
glibc |
| 只支持 |
操作系统 (OS) | 最新版本 | 所用内核版本不低于 |
第 1 步：安装本地 API 客户端
环境
本地 API 客户端本质上以 Docker 为基础。请参阅客户端架构，查看每个组件的信息。
本地 API 客户端目前不支持 Windows 版 Docker 和 Linux 版 Windows 子系统。如果有开发需要，我们建议您使用 Linux 虚拟机，并在该虚拟机中运行 Docker。如要应对生产工作负载，我们建议您使用 Linux 服务器，以避免兼容和性能问题。
设备
本地 API 客户端可在任何通过虚拟机或 Linux 服务器运行 Linux 版 Docker 的联网机器上运行。详情请参阅常见问题。例如，您可以在笔记本电脑上进行简单测试。如要在生产环境服务器中使用此客户端，我们建议至少配备 250 GB SSD、16 GB RAM 和 4 核 CPU。不建议使用 HDD，因为负载承受能力会受到 I/O 速度的制约。
大多数情况下，您应该在与核心应用和网页应用容器分离的物理服务器上运行数据库。数据库服务器与计算机之间应该只有几毫秒的延迟。
安装
您可以通过以下 2 种方法开始使用本地 API：
- Amazon Web Services (AWS)：如果您使用 AWS 或希望使用更为独立的解决方案，请参阅 AWS 指南。AWS 解决方案在您管理和拥有的 AWS 云中建立了具有备份、恢复等功能的完整本地 API 解决方案。
本地 API 客户端开始运行后，您必须以 admin 身份登录，以便执行其余设置步骤。
更新设置
本地 API 客户端正常运行后，您可以更改应用程序设置。但在完成注册之前，您无法访问本地 API 客户端的不同个人信息设置。
- 应用程序设置与客户端的运作方式相关，包括回调设置、Webhooks、当值寻呼机、已发送状态、媒体下载行为等。注意：强烈建议您设置 Webhooks 网址，以便接收传入消息或错误的相关通知。
第 2 步：开始使用客户端
注册
启动并运行本地 API 客户端后，您可以向 account 端点发送 API 调用，以注册电话号码。
发送测试消息
您可以使用 messages 端点发送测试消息。首先，检查您在测试时所用电话号码的状态。您需使用测试电话号码向您的 WhatsApp 帐号发送消息，以启用客户服务窗口期，这样您就可以在 24 小时窗口期内发送任何类型的消息（详情请参阅截断控制）。然后，向您的测试电话号码发送文字消息。如果收到消息，则表示安装成功。如果未收到消息，请检查 Webhooks 是否有可能指示出现任何问题的通知。
安全性
请参阅我们的安全性指南，了解与本地 API 客户端相关的密码、身份验证、SSL 配置、网络隔离、加密通讯、HTTP 标头和网络服务器 TLS 协议的信息。
启动流程
与服务器建立连接后，WhatsApp 本地 API 将立即进入启动流程。这一流程对于确保无缝可靠地收发消息至关重要。在启动阶段，核心应用程序会等待几个前提条件得到满足，这些条件包括：
加载模板消息：作为启动流程的一部分，此 API 会从服务器加载模板消息。
接收和处理离线消息：此 API 还会处理离线消息的接收和处理。
如果在未满足这些前提条件的情况下尝试发送消息，核心应用程序的响应中将包含“核心应用未准备就绪”错误消息，日志会显示“服务未就绪”错误。务必注意，每次与 WhatsApp 服务器建立新连接时，此启动流程都会执行。因此，如果核心应用程序重新启动或连接中断，启动流程将再次启动，以将核心应用的状态设置为“已就绪”，从而确保 WhatsApp 本地 API 已准备就绪并能够可靠地进行消息通信。
离线消息处理
找不到离线消息时，离线消息处理步骤可省略。换句话说，如果没有处于离线状态的等待消息，可避开这一特定的消息处理阶段。
在通常条件下，WhatsApp 本地 API 按照一个标准协议来处理离线消息。该 API 会等待系统接收和处理所有离线消息，预定义超时时间最多为 6 分钟。6 分钟时限一过，离线消息处理阶段将立即视为成功完成。
其他建议
建议事项刚开始时先与内部员工互发/互相接收消息，以便检查系统是否正常运作。 在 24 小时内回复所有客户。 遵守我们在 WhatsApp Business 政策和 WhatsApp 商业政策中所列的政策。 使用多个电话号码进行开发、测试和生产。 先查看常见问题，再决定是否需要开立站内支持工单。 提供产品反馈。站内支持是提供产品反馈的最佳渠道。 | 禁止事项向多个渠道重复发送通知。 发送垃圾消息。 使用以 1-800 开头的号码进行测试。 创建仅适用于 WhatsApp 集成的商务管理平台。如果现有平台可用，则使用现有平台。 |
如果发现您违反我们的任何守则或政策，我们将保留限制或禁止您使用 WhatsApp 的权利。