WhatsApp Business 开放平台本地 API

发送文本消息

您可以使用 messages 节点向您的客户发送文本消息。

准备工作

您需要满足“消息”文档的“准备工作”部分中列出的所有前提条件。

限制：

  • 文本消息的最大长度为 4,096 个字符。

第 1 步：向 /messages 发出 POST 请求

获得您想向其发送消息的用户的 WhatsApp 编号后，使用此编号发送文本消息。在 type 字段中指定 text。

POST /v1/messages
{
    "preview_url": false | true,
    "recipient_type": "individual",
    "to": "whatsapp-id",
    "type": "text",
    "text": {
        "body": "your-text-message-content"
    }
}

如需了解有关参数的更多信息，请参阅以下文档：

如果您希望设置消息的格式，请参阅在文本消息中设置格式。

在文本消息中发送网址

默认情况下，移动 WhatsApp 应用程序会识别网址，并将其处理为可点击形式。如要添加网址预览，请在消息正文中添加 "preview_url": true，并确保网址以 http:// 或 https:// 开头。如果 IP 地址不匹配，则必须提供主机名。

请注意，此处 preview_url 的使用方法不同于云端 API。请参阅“云端 API”下的消息文档。

示例

{
    "preview_url": true,
    "to": "whatsapp-id",
    "text": {
        "body": "You have to check out this amazing messaging service https://www.whatsapp.com/"
     }

大多数情况下，当您发送网址时，无论是否包含预览，消息收件人都会看到可以点击的网址。

仅在发生下列任一事项后，系统才会显示网址预览：

  1. 商家向用户发送了一个消息模板。
  2. 用户通过“点击聊天”链接发起对话。
  3. 用户将商家电话号码添加至通讯录并发起对话。

第 2 步：检查响应

若请求成功，响应包含 messages 对象，其中带有新建消息的编号。

{
  "messages": [{
    "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
  }]
}

若请求失败，响应会包含错误消息。如需更多信息，请参阅错误和状态代码。