WhatsApp Business管理API

QRコードと招待リンク

このガイドでは、WhatsApp Business管理API を使用した、QRコードの作成、管理の方法について説明します。

顧客は携帯電話からQRコードをスキャンすると、ビジネスとの会話をすぐに開始できます。WhatsApp Business管理APIで、このようなQRコードおよび関連付けられた招待リンクを作成してアクセスすることができます。

QRコードの管理にAPIではなくビジネスマネージャを使用する場合は、WhatsApp QRコードを管理するをご覧ください。

開始する前に

以下が必要です。

QRコードを作成

QRコードを作成するには、[WhatsApp Business電話番号] > [メッセージQrdls]エンドポイントに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/..."
}

QRコードのリストを取得

ビジネスの電話番号のすべてのQRコードのリストを取得するには、[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"
    }
  ]
}

QRコードを取得

特定のQRコードに関する情報を取得するには、[WhatsApp Business電話番号] > [メッセージQrdls]エンドポイントにGETリクエストを送信し、QRコードIDをパスパラメーターとして追加します。

リクエストの例

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"
    }
  ]
}

QRコードを更新

QRコードを更新するには、[WhatsApp Business電話番号] > [メッセージQrdls]エンドポイントにPOSTリクエストを送信します。

投稿本文に、更新するQRコードのIDに設定されたcodeプロパティと、新しいQRコードテキストに設定された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"
}

QRコードを削除

QRコードは自動的に期限切れになることはありません。QRコードを削除するには、[WhatsApp Business電話番号] > [メッセージQrdls]エンドポイントにDELETEリクエストを送信し、廃止するQRコードのIDをパスパラメーターとして追加します。

リクエストの例

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

応答の例

{
  "success": true
}

リファレンス

詳しくはこちら