WhatsApp Business 管理 API

二维码和短链接

本指南介绍如何使用 WhatsApp Business 管理 API 创建和管理二维码。

客户可以通过手机扫描二维码，快速与您的商家开始对话。通过 WhatsApp Business 管理 API，您可以创建和访问这些二维码及关联的短链接。

如果您可以使用商务管理平台（而不是 WhatsApp Business 管理 API）来管理自己的二维码，请参阅管理您的 WhatsApp 二维码。

准备工作

您将需要：

创建二维码

如要创建二维码，请向 WhatsApp Business 电话号码 > 消息 Qrdls 端点发送 POST 请求。

在 POST 请求正文中加入一个对象，其中 prefilled_message 属性设为您的消息文本，generate_qr_image 属性设为您的首选图片格式：SVG 或 PNG。

请求示例

curl 'https://graph.facebook.com/v19.0/106540352242922/message_qrdls' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "prefilled_message": "Cyber Monday",
  "generate_qr_image": "SVG"
}'

响应示例

{
  "code": "4O4YGZEG3RIVE1",
  "prefilled_message": "Cyber Monday 1",
  "deep_link_url": "https://wa.me/message/4O4YGZEG3RIVE1",
  "qr_image_url": "https://scontent-iad3-2.xx.fbcdn.net/..."
}

获取二维码清单

如要获取公司电话号码的二维码完整清单，请向 WhatsApp Business 电话号码 > 消息 Qrdls 端点发送 GET 请求。

请求示例

curl 'https://graph.facebook.com/v19.0/106540352242922/message_qrdls' \
-H 'Authorization: Bearer EAAJB...'

响应示例

{
  "data": [
    {
      "code": "4O4YGZEG3RIVE1",
      "prefilled_message": "Cyber Monday",
      "deep_link_url": "https://wa.me/message/4O4YGZEG3RIVE1"
    },
    {
      "code": "WOMVT6TJ2BP7A1",
      "prefilled_message": "Tell me more about your production workshop",
      "deep_link_url": "https://wa.me/message/WOMVT6TJ2BP7A1"
    }
  ]
}

获取二维码

如要获取有关特定二维码的信息，请向 WhatsApp Business 电话号码 > 消息 Qrdls 端点发送 GET 请求，并将二维码编号以路径参数形式附加到请求中。

请求示例

curl 'https://graph.facebook.com/v19.0/106540352242922/message_qrdls/4O4YGZEG3RIVE1' \
-H 'Authorization: Bearer EAAJB...'

响应示例

{
  "data": [
    {
      "code": "4O4YGZEG3RIVE1",
      "prefilled_message": "Cyber Monday",
      "deep_link_url": "https://wa.me/message/4O4YGZEG3RIVE1"
    }
  ]
}

更新二维码

如要更新二维码，请向 WhatsApp Business 电话号码 > 消息 Qrdls 端点发送 POST 请求。

在 POST 请求正文中，加入 code 属性（设为您要更新的二维码的编号）和 prefilled_message 属性（设为新二维码文本）。

请求示例

curl 'https://graph.facebook.com/v19.0/106540352242922/message_qrdls' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
    "code": "4O4YGZEG3RIVE1",
    "prefilled_message": "Cyber Tuesday"
}'

响应示例

{
  "code": "4O4YGZEG3RIVE1",
  "prefilled_message": "Cyber Tuesday",
  "deep_link_url": "https://wa.me/message/4O4YGZEG3RIVE1"
}

删除二维码

二维码不会自动过期。如要删除二维码，请向 WhatsApp Business 电话号码 > 消息 Qrdls 端点发送 DELETE 请求，并将要停用的二维码编号以路径参数形式附加到请求中。

请求示例

curl -X DELETE 'https://graph.facebook.com/v19.0/106540352242922/message_qrdls/4O4YGZEG3RIVE1' \
-H 'Authorization: Bearer EAAJB...'

响应示例

{
  "success": true
}

参考文档

详细了解