Location Request Message
Location request messages are free-form messages displaying only a body text and a send location button. When a WhatsApp user taps the button, a location sharing screen appears which the user can then use to share their location.

Once the user shares their location, a messages webhook is triggered, containing the user's location details to the business.
Sending Location Request Messages
POST
https://waba-v2.360dialog.io/messages
To send a message, use the request URL and the following body parameters.
Request Body
recipient_type
string
individual
to
string
wa_id
of the contact you want to message
type
string
location_request_message
messaging_product
string
Required only for Cloud API.
Messaging service used for the request. Use "whatsapp"
.
interactive
object
Post Body
{
"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"
}
}
}
Body Properties
<BODY_TEXT>
String
Required.
Message body text. Supports URLs.
4096 characters maximum.
Let's start with your pickup. You can either manually *enter an address* or *share your current location*.
Example Request
{
"messaging_product": "whatsapp",
"recipient_type": "individual",
"type": "interactive",
"to": "+15551234567",
"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"
}
}
}'
Webhook
When a WhatsApp user shares their location in response to your message, a messages webhook is triggered containing the user's location details. See Receiving messages via Webhook.
The location
component within the payload contains the user's latitude and longitude. Note that address
and name
are optional for the user and may not be included.
{
"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>", #Optional
"latitude": <LOCATION_LATITUDE>,
"longitude": <LOCATION_LONGITUDE>,
"name": "<LOCATION_NAME>" #Optional
},
"type": "location"
}
]
},
"field": "messages"
}
]
}
]
}
Webhook Contents
<LOCATION_ADDRESS>
String
Location address.
This parameter will only appear if the WhatsApp user chooses to share it.
1071 5th Ave, New York, NY 10128
<LOCATION_LATITUDE>
Number
Location latitude in decimal degrees.
40.782910059774
<LOCATION_LONGITUDE>
Number
Location longitude in decimal degrees.
-73.959075808525
<LOCATION_NAME>
String
Location name.
This parameter will only appear if the WhatsApp user chooses to share it.
Solomon R. Guggenheim Museum
<TIMESTAMP>
String
UNIX timestamp indicating when our servers processed the WhatsApp user's message.
1702920965
<WHATSAPP_BUSINESS_ACCOUNT_ID>
String
WhatsApp Business Account ID.
102290129340398
<WHATSAPP_BUSINESS_DISPLAY_PHONE_NUMBER>
String
WhatsApp business phone number's display number.
15550783881
<WHATSAPP_BUSINESS_PHONE_NUMBER>
String
WhatsApp business phone number.
15550783881
<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>
String
WhatsApp business phone number ID.
106540352242922
<WHATSAPP_CONTEXT_MESSAGE_ID>
String
WhatsApp message ID of message that the user is responding to.
wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1QjJGRjI1RDY0RkE4Nzg4QzcA
<WHATSAPP_MESSAGE_ID>
String
WhatsApp message ID of the user's message.
wamid.HBgLMTY0NjcwNDM1OTUVAgASGBQzQTRCRDcwNzgzMTRDNTAwRTgwRQA=
<WHATSAPP_USER_ID>
String
WhatsApp user's WhatsApp ID.
16467043595
<WHATSAPP_USER_NAME>
String
WhatsApp user's name.
Pablo Morales
Example 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": "John Doe"
},
"wa_id": "15551234567"
}
],
"messages": [
{
"context": {
"from": "15550783881",
"id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1QjJGRjI1RDY0RkE4Nzg4QzcA"
},
"from": "15551234567",
"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"
}
]
}
]
}
Last updated
Was this helpful?