Qikberry API Docs
SMSWhatsapp Cloud API
RCS for BusinessVMNVerifyIntegrations
SMSWhatsapp Cloud API
RCS for BusinessVMNVerifyIntegrations
Qikberry.AI
App
  1. Non-templates messages
  • Introduction
  • Catalog Messages
  • Payment Messages
  • Non-templates messages
    • Interactive
      • URL button
      • List buttons
      • Media carousel
      • Reply buttons
    • Address
      POST
    • Audio
      POST
    • Document
      POST
    • Contacts
      POST
    • Image
      POST
    • Location
      POST
    • Video
      POST
    • Text
      POST
  1. Non-templates messages

Address

POST
https://rest.qikberry.ai/v1/whatsapp/messages
Note: This feature is only available for businesses based in India and their India customers.
Address Messages allow users to easily share their shipping address with businesses through an interactive WhatsApp message. It includes header, body, footer, and action components.
FieldDescriptionLimitations
NameRecipient's full name—
Phone NumberRecipient's contact numberValid phone number only
PIN CodeDelivery PIN/Postal codeMaximum 6 digits
Flat/House NumberHouse or flat number—
Floor NumberFloor number—
Tower NumberTower or block number—
Building/Apartment NameBuilding or apartment name—
AddressStreet address—
Landmark/AreaNearby landmark or area—
CityCity name—
StateState name—

Address message steps#

The steps involved in an Address Message are the following:
1.
Business sends an Address Message to the user with an address collection option.
2.
User clicks the CTA, enters their address details, and submits the form.
3.
Business receives the submitted address details through a webhook notification.
address_message_.png

Additional action parameters#

You can include additional parameters like values, validation errors, and saved addresses to customize the address collection experience.
ParameterDescription
valuesAllows businesses to prefill address fields with existing information.
saved_addressesAllows users to select from previously saved addresses instead of entering details manually.
validation_errorsDisplays address field errors and prevents submission until the issues are fixed.

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 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": "address_message",
        "body": {
            "text": "<BODY_CONTENT>"
        },
        "action": {
            "name": "address_message",
            "parameters": {
                "country": "IN"
            }
        }
    }
}'
Response Response Example
200 - SUCCESS
{
    "message": "1 numbers accepted",
    "data": [
        {
            "messageId": "<MESSAGE_ID>",
            "mobile": "<USER_PHONE_NUMBER>"
        }
    ]
}
Modified at 2026-07-29 11:01:51
Previous
Reply buttons
Next
Audio
Built with