Location Request

POST

https://rest.qikberry.ai/v1/whatsapp/messages

Location request messages display 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.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

The request was successfully accepted for processing. The response returns a confirmation message along with the unique message ID and the recipient's WhatsApp number.

Bodyapplication/json

🟠401Unauthorized

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://rest.qikberry.ai/v1/whatsapp/messages' \
--header 'x-phone-number: <WA_ID>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "to": "<USER_PHONE_NUMBER>",
    "type": "interactive",
    "interactive": {
        "type": "location_request_message",
        "body": {
            "text": "Thanks for your order.\nPlease Send your location to proceed."
        },
        "action": {
            "name": "send_location"
        }
    }
}'

Response Example

200 - Success

{
    "message": "1 numbers accepted",
    "data": [
        {
            "messageId": "<MESSAGE_ID>",
            "mobile": "<USER_PHONE_NUMBER>"
        }
    ]
}

Modified at 2026-07-30 11:09:27

Text

Reaction