Note: This feature is only available for businesses based in India and their India customers.
| Field | Description | Limitations |
|---|---|---|
| Name | Recipient's full name | — |
| Phone Number | Recipient's contact number | Valid phone number only |
| PIN Code | Delivery PIN/Postal code | Maximum 6 digits |
| Flat/House Number | House or flat number | — |
| Floor Number | Floor number | — |
| Tower Number | Tower or block number | — |
| Building/Apartment Name | Building or apartment name | — |
| Address | Street address | — |
| Landmark/Area | Nearby landmark or area | — |
| City | City name | — |
| State | State name | — |
| Parameter | Description |
|---|---|
| values | Allows businesses to prefill address fields with existing information. |
| saved_addresses | Allows users to select from previously saved addresses instead of entering details manually. |
| validation_errors | Displays address field errors and prevents submission until the issues are fixed. |
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": "address_message",
"body": {
"text": "<BODY_CONTENT>"
},
"action": {
"name": "address_message",
"parameters": {
"country": "IN"
}
}
}
}'{
"message": "1 numbers accepted",
"data": [
{
"messageId": "<MESSAGE_ID>",
"mobile": "<USER_PHONE_NUMBER>"
}
]
}