API Cloud

Messages de demande de localisation

Les messages de demande de localisation affichent le corps du texte et un bouton pour envoyer une localisation. Le fait d’appuyer sur ce bouton affiche un écran de partage qui permet à la personne utilisant WhatsApp de partager sa localisation.


Cela déclenche un webhook messages contenant les détails de cette localisation.

Envoyer des messages de demande de localisation

Utilisez le point de terminaison POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages pour envoyer une demande de localisation à une personne utilisant WhatsApp.

Syntaxe de la requête

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages

Corps de la requête

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "type": "interactive",
  "to": "<WHATSAPP_USER_PHONE_NUMBER>",
  "interactive": {
    "type": "location_request_message",
    "body": {
      "text": "<BODY_TEXT>"
    },
    "action": {
      "name": "send_location"
    }
  }
}

Paramètres du corps de la publication

Espace réservéDescriptionExemple de valeur

<BODY_TEXT>

Chaîne

Obligatoire.

Texte du corps du message. URL prises en charge.

1 024 caractères maximum.

Let's start with your pickup. You can either manually *enter an address* or *share your current location*.

<WHATSAPP_USER_PHONE_NUMBER>

String

Required.

WhatsApp user phone number.

+16505551234

Réponse

En cas de réussite :

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

Contenu de la réponse

PlaceholderDescriptionSample Value

<WHATSAPP_USER_PHONE_NUMBER>

String

WhatsApp user's WhatsApp phone number. May not match wa_id value.

+16505551234

<WHATSAPP_USER_ID>

String

WhatsApp user's WhatsApp ID. May not match input value.

16505551234

<WHATSAPP_MESSAGE_ID>

String

WhatsApp Message ID. This ID appears in associated messages webhooks, such as sent, read, and delivered webhooks.

wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI4MjZGRDA0OUE2OTQ3RkEyMzcA

<PACING_STATUS>

String

Indicates template pacing status. The message_status property is only included in responses when sending a template message that uses a template that is being paced.

wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI4MjZGRDA0OUE2OTQ3RkEyMzcA

Webhook

Lorsqu’une personne utilisant WhatsApp partage sa localisation en réponse à votre message, cela déclenche un webhook messages contenant les détails de sa localisation.

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "<WHATSAPP_BUSINESS_DISPLAY_PHONE_NUMBER>",
              "phone_number_id": "<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>"
            },
            "contacts": [
              {
                "profile": {
                  "name": "<WHATSAPP_USER_NAME>"
                },
                "wa_id": "<WHATSAPP_USER_ID>"
              }
            ],
            "messages": [
              {
                "context": {
                  "from": "<WHATSAPP_BUSINESS_PHONE_NUMBER>",
                  "id": "<WHATSAPP_CONTEXT_MESSAGE_ID>"
                },
                "from": "<WHATSAPP_USER_ID>",
                "id": "<WHATSAPP_MESSAGE_ID>",
                "timestamp": "<TIMESTAMP>",
                "location": {
                  "address": "<LOCATION_ADDRESS>",
                  "latitude": <LOCATION_LATITUDE>,
                  "longitude": <LOCATION_LONGITUDE>,
                  "name": "<LOCATION_NAME>"
                },
                "type": "location"
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Contenu du Webhook

Espace réservéDescriptionExemple de valeur

<LOCATION_ADDRESS>

Chaîne

Adresse du lieu.

Ce paramètre ne s’affiche que si la personne utilisant WhatsApp choisit de la partager.

1071 5th Ave, New York, NY 10128

<LOCATION_LATITUDE>

Nombre

Latitude du lieu en degrés décimaux.

40.782910059774

<LOCATION_LONGITUDE>

Nombre

Longitude du lieu en degrés décimaux.

-73.959075808525

<LOCATION_NAME>

Chaîne

Nom du lieu.

Ce paramètre ne s’affiche que si la personne utilisant WhatsApp choisit de le partager.

Solomon R. Guggenheim Museum

<TIMESTAMP>

Chaîne

Horodatage Unix indiquant le moment où nos serveurs ont traité le message de la personne utilisant WhatsApp.

1702920965

<WHATSAPP_BUSINESS_ACCOUNT_ID>

Chaîne

ID de compte WhatsApp Business.

102290129340398

<WHATSAPP_BUSINESS_DISPLAY_PHONE_NUMBER>

Chaîne

Nombre correspondant au numéro de téléphone WhatsApp Business.

15550783881

<WHATSAPP_BUSINESS_PHONE_NUMBER>

Chaîne

Numéro de téléphone WhatsApp Business.

15550783881

<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>

Chaîne

ID du numéro de téléphone WhatsApp Business.

106540352242922

<WHATSAPP_CONTEXT_MESSAGE_ID>

Chaîne

ID du message WhatsApp auquel l’utilisateur·ice répond.

wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1QjJGRjI1RDY0RkE4Nzg4QzcA

<WHATSAPP_MESSAGE_ID>

Chaîne

ID du message WhatsApp de l’utilisateur·ice.

wamid.HBgLMTY0NjcwNDM1OTUVAgASGBQzQTRCRDcwNzgzMTRDNTAwRTgwRQA=

<WHATSAPP_USER_ID>

Chaîne

ID de la personne utilisant WhatsApp.

16505551234

<WHATSAPP_USER_NAME>

Chaîne

Nom de la personne utilisant WhatsApp.

Pablo Morales

Exemple de requête

curl 'https://graph.facebook.com/v21.0/106540352242922/messages' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "type": "interactive",
  "to": "+16505551234",
  "interactive": {
    "type": "location_request_message",
    "body": {
      "text": "Let us start with your pickup. You can either manually *enter an address* or *share your current location*."
    },
    "action": {
      "name": "send_location"
    }
  }
}'

Exemple de réponse

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

Exemple de Webhook

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "102290129340398",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "15550783881",
              "phone_number_id": "106540352242922"
            },
            "contacts": [
              {
                "profile": {
                  "name": "Pablo Morales"
                },
                "wa_id": "16505551234"
              }
            ],
            "messages": [
              {
                "context": {
                  "from": "15550783881",
                  "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1QjJGRjI1RDY0RkE4Nzg4QzcA"
                },
                "from": "16505551234",
                "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgASGBQzQTRCRDcwNzgzMTRDNTAwRTgwRQA=",
                "timestamp": "1702920965",
                "location": {
                  "address": "1071 5th Ave, New York, NY 10128",
                  "latitude": 40.782910059774,
                  "longitude": -73.959075808525,
                  "name": "Solomon R. Guggenheim Museum"
                },
                "type": "location"
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}