メッセージの送信

APIを使って、以下のタイプのメッセージを送信できます。

• テキストメッセージ
• リアクションメッセージ
• メディアメッセージ
• 位置情報メッセージ
• 連絡先メッセージ
• インタラクティブメッセージ
• テンプレートメッセージ

リアクションメッセージを除くすべてのタイプは、replyとして指定することができます。

リクエストの構文

WhatsAppユーザーにメッセージを送信するには、POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID/messagesエンドポイントを使います。

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER>/messages

投稿本文

どのメッセージ送信リクエストでも、以下の汎用親オブジェクト形式を使います。

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<TO>",
  "type": "<TYPE>",
  
  /* TEXT MESSAGES ONLY */
  "text": {<TEXT>}

  /* REACTION MESSAGES ONLY */
  "reaction": {<REACTION>}

  /* MEDIA MESSAGES ONLY. FOR EXAMPLE, FOR IMAGE MEDIA: */
  "image": {<IMAGE>}

  /* LOCATION MESSAGES ONLY */
  "location": {<LOCATION>}

  /* CONTACTS MESSAGES ONLY */
  "contacts": {<CONTACTS>}

  /* INTERACTIVE MESSAGES ONLY */
  "interactive": {<INTERACTIVE>}

  /* TEMPLATE MESSAGES ONLY */
  "template": {<TEMPLATE>}

}

投稿本文のパラメーター

このドキュメント全体で使われている例は、メッセージのそれぞれのタイプについて、投稿本文ペイロード要件について説明するためのものです。

応答の構文

成功すると、APIは以下のように応答します。

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "<WHATSAPP_USER_PHONE_NUMBER>",
      "wa_id": "<WHATSAPP_USER_ID>"
    }
  ],
  "messages": [
    {
      "id": "<WHATSAPP_MESSAGE_ID>"
    }
  ]
}

応答パラメーター

テキストメッセージ

テキストメッセージは、テキスト本文、そして任意でリンクプレビューだけを含むメッセージです。

リアクションメッセージ

リアクションメッセージは、受け取った直前のWhatsAppユーザーメッセージに対して適用できる絵文字リアクションです。

メディアメッセージ

WhatsAppユーザーに対して、音声メッセージ、ドキュメントメッセージ、画像メッセージ、スタンプメッセージ、動画メッセージを送信することができます。

音声メッセージ

音声メッセージは、音声アイコンと音声ファイルへのリンクを表示します。WhatsAppユーザーがアイコンをタップすると、WhatsAppクライアントが音声ファイルを読み込んで再生します。

ドキュメントメッセージ

ドキュメントメッセージは、ドキュメントアイコンを表示します。WhatsAppユーザーがそのアイコンをタップすると、リンクされているドキュメントをダウンロードすることができます。

画像メッセージ

画像メッセージは、単一の画像、そして任意でキャプションを表示します。

スタンプメッセージ

スタンプメッセージは、WhatsAppメッセージの中にアニメーションスタンプ画像または静止スタンプ画像を表示します。

動画メッセージ

動画メッセージは、動画画像のサムネイルプレビューを表示します。任意でキャプションも付けることができます。WhatsAppユーザーがそのプレビューをタップすると、動画が読み込まれてユーザーに対して表示されます。

メディアアセット

メディアアセットは、メッセージ送信元のビジネス電話番号にアップロードする必要があります。または、アセットを公開サーバー上でホスティングし、そのURLをメッセージ送信リクエストに含める必要があります。

エラーの可能性を減らし、パブリックサーバーへの不必要なリクエストを避けるために、メディアアセットをアップロードし、メッセージを送信するときにそのIDを使用することをおすすめします。

メディアHTTPキャッシュ

WhatsAppクラウドAPIでは、メディアHTTPキャッシュがサポートされています。(MetaのサーバーにアップロードしたアセットのID(id)ではなく)自分のサーバー上のメディアアセットへのリンク(link)を使う場合、Metaからアセットがリクエストされた時点で、あなたのサーバーからの応答に以下のヘッダーを含めることにより、将来のメッセージで再利用するためにアセットをキャッシュに入れるようMetaに指示することができます。これらのヘッダーが含まれていない場合、アセットはキャッシュに入れられません。

Cache-Control: <CACHE_CONTROL>
Last-Modified: <LAST_MODIFIED>
ETag: <ETAG>

Cache-Control

Cache-Controlヘッダーは、アセットキャッシュの処理方法をMetaに指示します。サポートされている命令は以下のとおりです。

• max-age=n: アセットをキャッシュに入れる秒数(n)を指定します。キャッシュに入れられたアセットは、この時間が経過するまでは、以降のメッセージで再利用されます。指定時間の経過後は、必要に応じて再度アセットがリクエストされます。例: Cache-Control: max-age=604800。
• no-cache: アセットをキャッシュに入れることはできますが、Last-Modifiedヘッダーの値が以前の応答と異なる場合は更新しなければなりません。Last-Modifiedヘッダーが必要です。例: Cache-Control: no-cache.
• no-store: アセットをキャッシュに入れないことを指定します。例: Cache-Control: no-store.
• private: アセットが受信者に合わせてパーソナライズされるため、キャッシュには入れないことを指定します。

Last-Modified

最後にアセットに変更が加えられた時刻を示します。Cache-Control: no-cacheと一緒に使います。Last-Modifiedの値が以前の応答とは違っており、かつ応答にCache-Control: no-cacheが含まれている場合、アセットのキャッシュバージョンが、応答の中のアセットによって更新されます。例: Date: Tue, 22 Feb 2022 22:22:22 GMT。

ETag

ETagヘッダーは、アセットの特定のバージョンを識別する固有文字列です。例: ETag: "33a64df5".このヘッダーは、Cache-ControlヘッダーとLast-Modifiedヘッダーの両方が応答に含まれていない場合を除いて無視されます。これらのヘッダーがどちらも含まれていない場合、アセットはMeta独自の(非公開)内部ロジックに従ってキャッシュに入れられます。

ヘッダー付きの応答の例

HTTP/1.1 200 OK
Content-Type: image/png
Content-Length: 1024
Date: Tue, 22 Feb 2022 22:22:22 GMT
ETag: "33a64df5"
Cache-Control: max-age=604800

<IMAGE_PAYLOAD>

位置情報メッセージ

位置情報メッセージを利用すると、位置情報の緯度座標と経度座標をWhatsAppユーザーに送信することができます。

連絡先メッセージ

連絡先メッセージを送信するには、/PHONE_NUMBER_ID/messagesに対するPOST呼び出しを発行し、type=contactのmessageオブジェクトを指定します。そして、contactsオブジェクトを追加します。

リクエストの例

curl -X  POST \
 'https://graph.facebook.com/v19.0/FROM_PHONE_NUMBER_ID/messages' \
 -H 'Authorization: ACCESS_TOKEN' \
 -H 'Content-Type: application/json' \
 -d '{
  "messaging_product": "whatsapp",
  "to": "PHONE_NUMBER",
  "type": "contacts",
  "contacts": [{
      "addresses": [{
          "street": "STREET",
          "city": "CITY",
          "state": "STATE",
          "zip": "ZIP",
          "country": "COUNTRY",
          "country_code": "COUNTRY_CODE",
          "type": "HOME"
        },
        {
          "street": "STREET",
          "city": "CITY",
          "state": "STATE",
          "zip": "ZIP",
          "country": "COUNTRY",
          "country_code": "COUNTRY_CODE",
          "type": "WORK"
        }],
      "birthday": "YEAR_MONTH_DAY",
      "emails": [{
          "email": "EMAIL",
          "type": "WORK"
        },
        {
          "email": "EMAIL",
          "type": "HOME"
        }],
      "name": {
        "formatted_name": "NAME",
        "first_name": "FIRST_NAME",
        "last_name": "LAST_NAME",
        "middle_name": "MIDDLE_NAME",
        "suffix": "SUFFIX",
        "prefix": "PREFIX"
      },
      "org": {
        "company": "COMPANY",
        "department": "DEPARTMENT",
        "title": "TITLE"
      },
      "phones": [{
          "phone": "PHONE_NUMBER",
          "type": "HOME"
        },
        {
          "phone": "PHONE_NUMBER",
          "type": "WORK",
          "wa_id": "PHONE_OR_WA_ID"
        }],
      "urls": [{
          "url": "URL",
          "type": "WORK"
        },
        {
          "url": "URL",
          "type": "HOME"
        }]
    }]
}'

{
  "messaging_product": "whatsapp",
  "contacts": [{
      "input": "PHONE_NUMBER",
      "wa_id": "WHATSAPP_ID",
    }]
  "messages": [{
      "id": "wamid.ID",
    }]
}

インタラクティブメッセージ

インタラクティブメッセージには、WhatsAppユーザーがWhatsAppクライアント内で行うメッセージとのインタラクションのためのボタンやその他のUIコンポーネントが含まれます。

インタラクティブコマースメッセージ

商品をカスタマーとシェアするをご覧ください。

インタラクティブリストメッセージ

インタラクティブリストメッセージを利用すると、WhatsAppユーザーに対して、選択可能なオプションのリストを提示することができます。

インタラクティブ位置情報リクエストメッセージ

位置情報リクエストメッセージは、本文テキストと、位置情報送信ボタンを表示します。WhatsAppユーザーがボタンをタップすると、ユーザーが位置情報を共有するために使うことのできる位置情報の共有画面が表示されます。

インタラクティブ返信ボタンメッセージ

インタラクティブ返信ボタンメッセージを利用すると、ユーザーが選択できる事前定義済みの返信を3つまで送信することができます。

インタラクティブCTA URLボタン

テキストメッセージに冗長で意味が不明瞭な文字列のURLをそのまま載せると、顧客はタップするのをためらうかもしれません。このような場合は、本文とCTA URLボタンを含むインタラクティブメッセージを送ると良いかもしれません。

CTA URLボタンを使って任意のURLをボタンにマッピングすれば、インタラクティブメッセージ本文にURLをそのまま載せる必要がなくなります。

リクエストの構文

POST /<BUSINESS_PHONE_NUMBER_ID>/messages

投稿本文

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<CUSTOMER_PHONE_NUMBER>",
  "type": "interactive",
  "interactive": {
    "type": "cta_url",

    /* Header optional */
    "header": {
      "type": "text",
      "text": "<HEADER_TEXT>"
    },

    /* Body optional */
    "body": {
      "text": "<BODY_TEXT>"
    },

    /* Footer optional */
    "footer": {
      "text": "<FOOTER_TEXT>"
    },
    "action": {
      "name": "cta_url",
      "parameters": {
        "display_text": "<BUTTON_TEXT>",
        "url": "<BUTTON_URL>"
      }
    }
  }
}

本体のプロパティ

リクエストの例

curl 'https://graph.facebook.com/v19.0/106540352242922/messages' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "+16505555555",
    "type": "interactive",
    "interactive": {
        "type": "cta_url",
        "header": {
            "text": "Available Dates"
        },
        "body": {
            "text": "Tap the button below to see available dates."
        },
        "footer": {
            "text": "Dates subject to change."
        },
        "action": {
            "name": "cta_url",
            "parameters": {
                "display_text": "See Dates",
                "url": "https://www.luckyshrub.com?clickID=kqDGWd24Q5TRwoEQTICY7W1JKoXvaZOXWAS7h1P76s0R7Paec4"
            }
        }
    }
}'

応答の例

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "+16505555555",
      "wa_id": "+16505555555"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgLMTY1MDUwNzY1MjAVAgARGBI5QTNDQTVCM0Q0Q0Q2RTY3RTcA"
    }
  ]
}

Flowsメッセージ

WhatsApp Flowを作成したら、それを送信できます。フローを使用してメッセージを送信するために、flowと呼ばれる新しいタイプのインタラクティブオブジェクトを導入しました。フロー特有のインタラクティブオブジェクトのプロパティは以下のとおりです。

リクエストの例

curl -X  POST \
 'https://graph.facebook.com/v19.0/FROM_PHONE_NUMBER_ID/messages' \
 -H 'Authorization: Bearer ACCESS_TOKEN' \
 -H 'Content-Type: application/json' \
 -d '{
  "recipient_type": "individual",
  "messaging_product": "whatsapp",
  "to": "PHONE_NUMBER",
  "type": "interactive",
  "interactive": {
    "type": "flow",
    "header": {
      "type": "text",
      "text": "Flow message header"
    },
    "body": {
      "text": "Flow message body"
    },
    "footer": {
      "text": "Flow message footer"
    },
    "action": {
      "name": "flow",
      "parameters": {
        "flow_message_version": "3",
        "flow_token": "AQAAAAACS5FpgQ_cAAAAAD0QI3s.",
        "flow_id": "1",
        "flow_cta": "Book!",
        "flow_action": "navigate",
        "flow_action_payload": {
          "screen": "<SCREEN_NAME>",
          "data": { 
            "product_name": "name",
            "product_description": "description",
            "product_price": 100
          }
        }
      }
    }
  }
}'

応答の例

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "Input": "PHONE_NUMBER",
      "wa_id": "WHATSAPP_ID"
    }
  ],
  "messages": [
    {
      "id": "wamid.ID"
    }
  ]
}

返信

直前のメッセージへの返信として、どんなタイプのメッセージでも送ることができます。新しいメッセージの先頭に、直前のメッセージがコンテキストバブルの中で引用されて表示されます。

制限

次の場合には、返信として送信される配信メッセージの先頭にコンテキストバブルは表示されません。

• 直前のメッセージが削除されているか、または長期ストレージに移動されている場合(ローカルストレージを有効にしてあるのでない限り、通常、メッセージは30日後に長期ストレージに移動されます)。
• 音声メッセージ、画像メッセージ、動画メッセージで応答し、WhatsAppユーザーがKaiOSを実行している場合。
• WhatsAppクライアントを使ってプッシュツートークメッセージで応答し、WhatsAppユーザーがKaiOSを実行している場合。
• テンプレートメッセージで応答する場合。

リクエストの構文

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages

投稿本文

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<WHATSAPP_USER_PHONE_NUMBER>",
  "context": {
    "message_id": "WAMID_TO_REPLY_TO"
  },

  /* Message type and type contents goes here */

}

投稿本文のパラメーター

リクエストの例

curl 'https://graph.facebook.com/v19.0/106540352242922/messages' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "+16505551234",
  "context": {
    "message_id": "wamid.HBgLMTY0NjcwNDM1OTUVAgASGBQzQTdCNTg5RjY1MEMyRjlGMjRGNgA="
  },
  "type": "text",
  "text": {
    "body": "You'\''re welcome, Pablo!"
  }
}'

住所メッセージ

住所メッセージにより、ユーザーはWhatsApp上で配送先住所をビジネスと簡単に共有できます。

住所メッセージはインタラクティブなメッセージであり、主に次の4つのパートが含まれます。header、body、footer、action。ビジネスは、このactionコンポーネントの中で、名前“address_message”を指定し関連するパラメーターも指定します。

現在、住所メッセージは、インドとシンガポールの2か国でサポートされています。以下の表は、どのフィールドがどの国でサポートされているかを具体的に示しています。

API呼び出しの例

これは住所メッセージのAPI呼び出しの例です。country属性はactionパラメーターの必須フィールドです。含まれていない場合、検証エラーが発生します。

curl -X  POST \
'https://graph.facebook.com/v15.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
          "messaging_product": "whatsapp",
          "recipient_type": "individual",
          "to": "PHONE_NUMBER",
          "type": "interactive",
          "interactive": {
              "type": "address_message",
              "body": {
                   "text": "Thanks for your order! Tell us what address you’d like this order delivered to."
              },
              "action": {
                   "name": "address_message",
                   "parameters": {
                      "country" :"COUNTRY_ISO_CODE"
                   }
              }
          }
    }' 

エラーの処理

その国の電話番号の市外局番が正しくない場合、ビジネスは受信者に住所メッセージをリクエストできなくなります。例えば、国を「シンガポール」としているのに、市外局番が「91」の電話番号になっている受信者には、ビジネスは住所メッセージをリクエストできません。

住所メッセージでは、矛盾しているフィールドを同時に渡すことはできません。例えば、countryが「IN」(インド)に設定されている場合、sg_post_codeを渡すことはできません。

住所メッセージを送信したら、ビジネスはユーザーが住所を入力して返信してくれるのを待ちます。ユーザーが入力した住所は、Webhooksを通して共有されます。このWebhooksは設定プロセスで登録したものです。

住所メッセージのステップ

住所メッセージに関係する手順は以下のとおりです。

1. ビジネスがユーザーに住所メッセージを送信します。このとき、アクション名をaddress_messageにします。
2. ユーザーはCTAをクリックしてメッセージをやり取りします。クリックすると、住所メッセージの画面が表示されます。ユーザーは住所を入力して、フォームを送信します。
3. ユーザーが住所メッセージフォームを送信した後、パートナーはWebhooks通知を受け取ります。この通知に、ユーザーが送信した住所の詳細が含まれています。

次のシーケンス図は、住所メッセージの典型的な統合フローを示しています。

その他のactionパラメーター

ビジネスはさらにほかの属性(values、validation_errors、saved_addresses)を、インタラクティブなactionパラメーターとして使用することができます。それぞれの使用方法については、下記をご覧ください。

ユーザーに住所メッセージを送る

WhatsApp APIを使用してPOST呼び出しを/PHONE_NUMBER_ID/messagesに対して行い、エンドツーエンド暗号化された住所メッセージをユーザーに送信します。

curl -X  POST \
'https://graph.facebook.com/v15.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d ' {
            "messaging_product": "whatsapp",
            "recipient_type": "individual",
            "to": "PHONE_NUMBER",
            "type": "interactive",
            "interactive": {
                 "type": "address_message",
                 "body": {
                       "text": "Thanks for your order! Tell us what address you’d like this order delivered 
                        to."
                 },
                "action": {
                      "name": "address_message",
                      "parameters": "JSON Payload"
                 }
            }
     }'

保存済み住所なしで住所メッセージを送る場合、WhatsAppは、新しい住所を入力するための住所フォームのプロンプトをユーザーまたはビジネスに表示します。

インド

curl -X  POST \
'https://graph.facebook.com/v15.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
      "messaging_product": "whatsapp",
      "recipient_type": "individual",
      "to": "+91xxxxxxxxxx",
      "type": "interactive",
      "interactive": {
        "type": "address_message",
        "body": {
          "text": "Thanks for your order! Tell us what address you’d like this order delivered to."
        },
        "action": {
          "name": "address_message",
          "parameters": {
              "country": "IN",
              "values": {
                 "name": "CUSTOMER_NAME",
                 "phone_number": "+91xxxxxxxxxx"
              }
           }
        }
      }
   }'

シンガポール

curl -X  POST \
'https://graph.facebook.com/v15.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
      "messaging_product": "whatsapp",
      "recipient_type": "individual",
      "to": "+65xxxxxxxxxx",
      "type": "interactive",
      "interactive": {
        "type": "address_message",
        "body": {
          "text": "Thanks for your order! Tell us what address you’d like this order delivered to."
        },
        "action": {
          "name": "address_message",
          "parameters": {
              "country": "SG",
              "values": {
                  "name": "CUSTOMER_NAME",
                  "phone_number": "+65xxxxxxxxxx"
              }
           }
        }
      }
   }'

保存済み住所ありで住所メッセージを送る場合、WhatsAppは、保存済みの住所から選ぶ選択肢と住所を追加する選択肢のプロンプトをユーザーまたはビジネスに表示します。ユーザーは保存済み住所を無視して、新しい住所を入力できます。

インド

curl -X  POST \
'https://graph.facebook.com/v15.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d 
'{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "91xxxxxxxxxx",
  "type": "interactive",
  "interactive": {
    "type": "address_message",
    "body": {
      "text": "Thanks for your order! Tell us what address you’d like this order delivered to."
    },
    "action": {
      "name": "address_message",
      "parameters": {
          "country": "IN",
          "saved_addresses": [
             {
                 "id": "address1",
                 "value": {
                    "name": "CUSTOMER_NAME",
                    "phone_number": "+91xxxxxxxxxx",
                    "in_pin_code": "400063",
                    "floor_number": "8",
                    "building_name": "",
                    "address": "Wing A, Cello Triumph,IB Patel Rd",
                    "landmark_area": "Goregaon",
                    "city": "Mumbai"
                 }
             }
          ]
       }
    }
  }
}'

シンガポール

curl -X  POST \
'https://graph.facebook.com/v15.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d 
'{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "+65xxxxxxxxxx",
  "type": "interactive",
  "interactive": {
    "type": "address_message",
    "body": {
      "text": "Thanks for your order! Tell us what address you’d like this order delivered to."
    },
    "action": {
      "name": "address_message",
      "parameters": {
         "country": "SG",
         "values": {
             "name": "CUSTOMER_NAME",
             "phone_number": "+65xxxxxxxxxx"
         },
         "saved_addresses": [
            {
                "id": "address1",
                "value": {
                   "name": "CUSTOMER_NAME",
                   "phone_number": "+65xxxxxxxxxx",
                   "sg_post_code": "018937",
                   "address": "9 Straits View, Marina One West Tower",
                   "unit_number": "Suite 29-00",
                   "city": "Singapore"
                }
            }
         ]
      }
    }
  }
}'

応答を確認する

成功した場合の応答には、新しく作成されたメッセージのIDが指定されたmessagesオブジェクトが含まれています。

{
  "messaging_product": "whatsapp",
  "contacts": [{
      "input": "PHONE_NUMBER",
      "wa_id": "WHATSAPP_ID",
    }]
  "messages": [{
      "id": "wamid.ID",
    }]
}

失敗した場合の応答には、エラーメッセージが含まれています。詳しくは、エラーコードとステータスコードをご覧ください。

検証エラーを付けて住所メッセージを送信する

ビジネスサーバーで検証エラーが発生した場合、住所メッセージをユーザーに再送信する必要があります。ビジネスは、ユーザーが前に入力した値のセットを送り返し、その際、無効な各フィールドの検証エラーも送ります。以下にペイロードのサンプルを示します。

インド

curl -X  POST \
'https://graph.facebook.com/v15.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d 
'{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "91xxxxxxxxxx",
  "type": "interactive",
  "interactive": {
    "type": "address_message",
    "body": {
      "text": "Thanks for your order! Tell us what address you’d like this order delivered to."
    },
    "action": {
      "name": "address_message",
      "parameters": {
          "country": "IN",
          "values": {
             "name": "CUSTOMER_NAME",
             "phone_number": "+91xxxxxxxxxx",
             "in_pin_code": "666666",
             "address": "Some other location",
             "city": "Delhi"
          },
          "validation_errors": {
             "in_pin_code": "We could not locate this pin code."
          }
       }
    }
  }
}'

シンガポール

curl -X  POST \
'https://graph.facebook.com/v15.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d 
'{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "12065550107",
  "type": "interactive",
  "interactive": {
    "type": "address_message",
    "body": {
      "text": "Thanks for your order! Tell us what address you’d like this order delivered to."
    },
    "action": {
      "name": "address_message",
      "parameters": {
           "country": "SG",
           "values": {
              "name": "CUSTOMER_NAME",
              "phone_number": "+65xxxxxxxxxx",
              "sg_post_code": "666666",
              "address": "Some other location",
              "city": "Singapore"
           },
           "validation_errors": {
              "sg_post_code": "We could not locate this pin code."
           }
        }
     }
  }
}'

住所送信の通知を受け取る

ビジネスはWebhooksを通して住所送信の通知を受け取ります。以下に例を示します。

{
    "messages": [
        {
           "id": "gBGGFlAwCWFvAgmrzrKijase8yA",
           "from": "PHONE_NUMBER",
           "Interactive": {
               "type":  "nfm_reply",
               "action":  "address_message",
               "nfm_reply": {
                   "name": "address_message",
                    "response_json": “<response_json from client>”,
                    "body": “<body text from client>”,
            }
           "timestamp": "1670394125",
           "type": "interactive"  
        }
    ]
}

Webhooks通知には以下の値があります。

インドの住所メッセージリクエストのNFM応答タイプの場合、住所メッセージ返信は以下のようになります。

{
   "messages": [
      {
          "context": {
	  "from": "FROM_PHONE_NUMBER_ID",
	  "id": "wamid.HBgLMTIwNjU1NTAxMDcVAgARGBI3NjNFN0U5QzMzNDlCQjY0M0QA"
           },
          "from": "PHONE_NUMBER",
         "id": "wamid.HBgLMTIwNjU1NTAxMDcVAgASGCA5RDhBNENEMEQ3RENEOEEzMEI0RUExRDczN0I1NThFQwA=",
         "timestamp": "1671498855",
         "type": "interactive",
         "interactive": {
	 "type": "nfm_reply",
	"nfm_reply": {
	      "response_json": "{\"saved_address_id\":\"address1\",\"values\":{\"in_pin_code\":\"400063\",\"building_name\":\"\",\"landmark_area\":\"Goregaon\",\"address\":\"Wing A, Cello Triumph, IB Patel Rd\",\"city\":\"Mumbai\",\"name\":\"CUSTOMER_NAME\",\"phone_number\":\"+91xxxxxxxxxx\",\"floor_number\":\"8\"}}",
                    "body": "CUSTOMER_NAME\n +91xxxxxxxxxx\n 400063, Goregaon, Wing A, Cello Triumph,IB Patel Rd, Mumbai, 8",
                    "name": "address_message"
                }
            }
        }
    ]
}

サポートされていない機能

クライアントがaddress_messageをサポートしていない場合、メッセージは静かにドロップされ、エラーメッセージがWebhooksでビジネスに返されます。送り返されるWebhooks通知は、以下のようになります。

{
  "statuses": [
    {
      "errors": [
        {
          "code": 1026,
          "href": "https://developers.facebook.com/docs/whatsapp/api/errors/",
          "title": "Receiver Incapable"
        }
      ],
      "id": "gBGGFlAwCWFvAgkyHMGKnRu4JeA",
      "message": {
        "recipient_id": "+91xxxxxxxxxx"
      },
      "recipient_id": "91xxxxxxxxxx",
      "status": "failed",
      "timestamp": "1670394125",
      "type": "message"
    }
  ]
}

テンプレートメッセージ

テンプレートメッセージをご覧ください。

複数メッセージの配信順序

一連のメッセージを送信する際、メッセージが配信される順番が、APIリクエスト発行の順番と一致するという保証はありません。メッセージ配信の順序が問題になる場合は、メッセージWebhookの中でdeliveredステータスを受け取ったことを確認してから、メッセージシーケンス中の次のメッセージを送信するようにしてください。

トラブルシューティング

メッセージの配信に問題が発生した場合は、メッセージが配信されないをご覧ください。

参考情報

• アプリからWhatsAppメディアメッセージを送信する