WhatsApp Cloud API

Whatsapp

 

发送和接收消息，使用云托管版本的 WhatsApp Business 平台。Cloud API 让您无需自行托管服务器即可实现 WhatsApp Business API，同时更轻松地扩展您的商业消息能力。Cloud API 支持每秒最多 80 条消息的综合收发（包括文本和媒体消息）。

 

WhatsApp Business API 允许中大型企业与其客户进行大规模沟通。通过该 API，企业可以构建将数千名客户与客服代表或机器人相连的系统，支持程序化和手动两种通信方式。此外，您还可以将该 API 与 CRM 和营销平台等众多后端系统集成。

 

功能特性

企业将通过 Cloud API 更快获得所有新功能。目前，WhatsApp Business Cloud API 包含 WhatsApp Business API 所有可用功能。

 

WhatsApp Cloud API 的实用功能：

 

• 集成WhatsApp 消息与 CRM、分析和第三方应用
• 绿色勾选，已验证的 WhatsApp Business 资料
• WhatsApp 广播 & 批量消息
• 无应用程序或界面，通过 BSP 或 CRM 使用
• WhatsApp Chatbot 及使用第三方应用的聊天自动化
• 大规模定时发送 WhatsApp 消息。
• 互动消息功能包括列表消息、回复按钮、CTA 消息

 

最常见的用途

• 配置
  • WhatsApp 创建应用程序
  • WhatsApp 电话号码 ID
  • WhatsApp 令牌
  • WhatsApp Webhook
  • WhatsApp 安全性

 

• 消息
  • WhatsApp 发送消息
  • WhatsApp 发送交互消息
  • WhatsApp 发送模板消息
  • WhatsApp 接收消息和状态通知
  • WhatsApp 发送文件
  • WhatsApp 下载媒体

 

 

开始使用

要使用测试号码发送和接收第一条消息，请完成以下步骤：

 

1. 设置开发者资产和平台访问权限

 

• 注册为 Meta 开发者

• 为您的账户启用双因素身份验证

• 创建 Meta 应用：访问 developers.facebook.com > 我的应用 > 创建应用。选择"Business"类型并按照屏幕上的提示操作。

 

在应用仪表板中，点击您希望连接到 WhatsApp 的应用。向下滚动找到"WhatsApp"产品，然后点击 设置。

 

接下来，您将看到选择现有 Business Manager 的选项（如果您有的话），或者，如果您愿意，入驻流程也可以自动为您创建一个（您可以在之后对业务进行自定义）。做出选择后，点击 继续。

 

当您点击 继续时，引导流程将执行以下操作：

 

• 您的应用已与您选择或自动创建的 Business Manager 关联。
• 您的企业已添加一个 WhatsApp 测试电话号码。您可以使用此测试电话号码探索 WhatsApp Business 平台，无需注册或迁移真实电话号码。测试电话号码最多可向 5 位收件人（可在全球任何地方）发送无限条消息。

 

2. 发送测试消息

 

 

现在，您可以打开 IDE 并创建新项目。放置一个 TsgcWhatsapp_Client 组件并填写以下属性：

 

• WhatsappOptions.PhoneNumberId：是用于发送消息的电话号码 ID。
• WhatsappOptions.Token：有效期 24 小时的临时访问令牌。

 

正确配置这 2 个属性后，调用 SendTest 方法，通过 WhatsApp Business Platform 向电话号码发送您的第一条消息。

 

oClient := TsgcWhatsapp_Client.Create(nil);
oClient.WhatsappOptions.PhoneNumberId := '107809351952205';
oClient.WhatsappOptions.Token := 'EAAO4OpgZAs98BAGj3nCFGr...ZB2t8mmLB2LRXJkte2Y5PMNh2';
oClient.SendTest('34605889421');

 

3. 配置 Webhook

 

要在收到消息或消息状态发生变化时收到提醒，您需要为您的应用程序设置 Webhooks 端点。设置 Webhooks 不会影响您的电话号码状态，也不会干扰您发送或接收消息。

 

若要开始，首先需要创建端点，请先配置 WhatsApp 客户端组件的 ServerOptions 属性，并配置以下属性：

 

• ServerOptions：在此处您可以配置要绑定的 IP 地址、监听端口，以及是否使用 SSL（WebHook 必须在安全服务器上运行，您可以将服务器配置为使用 SSL 或将 WebHook 请求代理到非 HTTPS 服务器）。服务器基于 TsgcWebSocketHTTPServer。
  • WebhookOptions：此属性允许您设置 Webhook 属性，稍后将在您的 Facebook 开发者账户中配置。
    • Endpoint：端点名称，默认为 /webhook。示例：如果您的服务器监听 https://www.esegece.com，则端点为 "https://www.esegece.com/webhook"
    • Token：安全字符串，可包含您定义的任意值。用于验证 Webhook 注册是否正确。

 

配置服务器后，您可以使用方法 StartServer 启动服务器并接受传入请求。

 

oClient := TsgcWhatsapp_Client.Create(nil);
oClient.ServerOptions.WebhookOptions.Endpoint := '/webhook';
oClient.ServerOptions.WebhookOptions.Token := 'MySecretToken';
oClient.StartServer();

端点准备好后，请前往您的应用控制台。

 

在您的应用程序仪表板中，找到 WhatsApp 产品并单击 Configuration。然后，找到 Webhooks 部分并单击 Configure a webhook。单击后，屏幕上将出现一个对话框，要求您提供两项内容：

 

• 回调 URL：这是 Meta 将向其发送事件的 URL。
• 验证令牌：此字符串由您在创建 Webhook 端点时自行设置。

 

添加信息后，点击 验证并保存。

 

回到应用程序仪表板，在左侧面板中点击 WhatsApp > Configuration 在左侧面板中。在 Webhooks 下，点击 Manage。将打开一个对话框，显示您可以收到通知的所有对象。要接收用户的消息，请为 messages 点击 Subscribe。

 

4. 接收测试消息

 

每次收到新消息时，都会调用客户端事件 OnMessageReceived。

 

procedure OnMessageReceived(Sender: TObject; const aMessage: TsgcWhatsapp_Receive_Message; var aMarkAsRead: Boolean);
begin
  DoLog('Received: ' + aMessage.Messages._Message[0].Id);
end;

 

现在您的 Webhook 已设置完毕，向您使用的测试号码发送一条消息。您应该立即收到包含消息内容的 Webhook 通知！

 

 

WhatsApp API 不允许向从未联系过您（最近 24 小时内）的手机发送自由文本消息。向从未向您的开发者账号发送过 WhatsApp 消息的手机发送文本消息的唯一方式，是发送模板消息（须经 Meta 预先批准）。若要在测试中绕过此限制以发送自由文本消息，请先从目标手机向您的开发者账号发送一条 WhatsApp 消息，之后即可在 24 小时内发送自由文本消息。

 

事件

OnBeforeSendMessage

 

此事件在消息发送到 WhatsApp 服务器之前调用。您可以通过 RawMessage 参数访问内部消息。

 

OnBeforeSubscribe

 

此事件在服务器订阅主题之前调用。使用 Accept 参数允许或拒绝订阅。默认情况下，服务器将订阅所有请求的事件。

 

OnRawMessage

 

当服务器收到尚未解析的新消息时调用此事件，因此您可以访问原始消息。

 

OnMessageReceived

 

此事件在服务器接收并解析新消息后调用。如果将 MarkAsRead 参数设置为 True，发送方将收到双勾确认。

 

OnMessageSent

 

每次服务器收到关于之前已发送消息的新状态消息时，都会调用此事件。读取 Status 属性可了解消息是否已发送、已送达或已读。