Payload examples for send single message

The following examples demonstrate the supported message payload formats, including text, media, interactive, address, and product messages.

Sending a text message

{
    "contactIdentifier": "+919900990090",
    "medium": "whatsapp",
    "type": "text"
    "payload": {
        "message": "This is a test message."
    }
}

Sending an image message

{
    "contactIdentifier": "+919900990090",
    "medium": "whatsapp",
    "type": "image"
    "payload": {
        "type": "image",
        "media": {
           "mediaLink": "https://testimageurl.com/testimage.png",
           "caption": "Image message"
        }
    }
}

Sending a video message

{
    "contactIdentifier": "+919900990090",
    "medium": "whatsapp",
    "type": "video"
    "payload": {
        "type": "video",
        "media": {
           "mediaLink": "https://testimageurl.com/testimage.mp4",
           "caption": "Video message"
        }
    }
}

Sending a document message

{
    "contactIdentifier": "+919900990090",
    "medium": "whatsapp",
    "type": "document"
    "payload": {
        "type": "document",
        "media": {
           "mediaLink": "https://testimageurl.com/testimage.pdf",
           "caption": "Document message"
        }
    }
}

Sending a message with list/option buttons

{
    "contactIdentifier": "+919900990090",
    "medium": "whatsapp",
    "type": "options"
    "payload": {
        "type": "options",
        "body": "Test options message",
        "headerTitle": "headerTitle",
        "footerTitle": "footerTitle",
        "section": {
            "buttonTitle": "buttonTitle",
            "sectionTitle": "sectionTitle",
            "payload": [
                {
                    "id":"12345",
                    "name":"option 1",
                }
            ]
        }
    }
}

Sending a message with QRB buttons

{
    "contactIdentifier": "+919900990090",
    "medium": "whatsapp",
    "type": "buttons"
    "payload": {
        "type": "buttons",
        "body": "Test button message",
        "headerTitle": "headerTitle",
        "footerTitle": "footerTitle",
        "section": {
            "buttonTitle": "buttonTitle",
            "sectionTitle": "sectionTitle",
            "payload": [
                {
                    "id":"12345",
                    "name":"option 1",
                }
            ]
        },
        "header": {
            "type": "image",
            "image": {
                "mediaLink": "https://testimageurl.com/testimage.png"
            }
        }
    }
}

Sending a message with address

{
    "contactIdentifier": "+919900990090",
    "medium": "whatsapp",
    "type": "address"
    "payload": {
        "message": "Test is a address message",
        "address": {
            "id": "1234";
            "name": "Test";
            "phone_number": "+919909909990";
            "pin_code": "110001";
            "floor_number": "1";
            "building_name": "Apartment";
            "address": "5th cross";
            "landmark_area": "Near temple";
            "city": "Bengaluru";
            "country": "IN";
        }
    }
}

Sending a message with single product

{
    "contactIdentifier": "+919900990090",
    "medium": "whatsapp",
    "type": "single_product"
    "payload": {
        "message": "Test message"
        "footerText":"footerText",
        "catalogId":"1234567890",
        "variantId":"898989"
    }
}

Sending a message with multiple products

{
    "contactIdentifier": "+919900990090",
    "medium": "whatsapp",
    "type": "multiple_product"
    "payload": {
        "message": "Test message"
        "catalogId": "1234567890",
        "sections": [
            {
                "title": "hello",
                "variantIds": [
                    "67676789898",
                    "45454588665"
                ]
            },
            {
                "title": "hii",
                "variantIds": [
                    "1234567890",
                    "2134567890"
                ]
            }
        ],
        "headerText": "header text",
        "footerText": "footer text"
    }
}

BikTextMessagePayload type

Name	Type	Required/Optional	Description
message	string	Required	The text content of the message
hasPreviewUrl	boolean	Optional	Whether the message contains a URL that should render a link preview

BikMediaMessagePayload type

Name	Type	Required/Optional	Description
type	string	Required	The media type: image, video, or document
media	BikMediaMessageObject	Required	The media object containing the file details

BikMediaMessageObject type

Name	Type	Required/Optional	Description
mediaLink	string	Required	URL of the media file
caption	string	Optional	Caption text displayed with the media
fileName	string	Optional	File name for the media attachment

BikInteractiveMessagePayload type

Name	Type	Required/Optional	Description
type	string	Required	The interactive message type: options or buttons
body	string	Required	The body text of the message
headerTitle	string	Required	The header title text
footerTitle	string	Required	The footer title text
section	BikInteractiveAction	Required	The interactive action configuration
header	BikInteractiveHeader	Optional	The header media configuration

BikInteractiveAction type

Name	Type	Required/Optional	Description
buttonTitle	string	Optional	The display title of the button
sectionTitle	string	Optional	The display title of the section
payload	BikInteractiveActionPayload[]	Required	Array of selectable action items

BikInteractiveActionPayload type

Name	Type	Required/Optional	Description
id	string	Required	Unique identifier for the action item
name	string	Required	Display name of the action item

BikInteractiveHeader type

Name	Type	Required/Optional	Description
type	string	Required	The media type: image, video, or document
(image, video, document)	BikMediaMessageObject	Required	The media object for the header

BikAddressMessagePayload type

Name	Type	Required/Optional	Description
message	string	Required	The message text accompanying the address
address	Address	Required	The address object

Address type

Name	Type	Required/Optional	Description
id	string	Required	Unique identifier for the address
name	string	Required	Recipient name
phone_number	string	Required	Contact phone number
pin_code	string	Required	Postal or PIN code
floor_number	string	Required	Floor number
building_name	string	Required	Building or apartment name
address	string	Required	Street address
landmark_area	string	Required	Nearby landmark or area
city	string	Required	City name
country	string	Required	Country code (e.g., IN)

BikProductMessagePayload type

Name	Type	Required/Optional	Description
message	string	Required	The message text accompanying the product
footerText	string	Optional	Footer text displayed below the product
headerText	string	Optional	Header text displayed above the product
catalogId	string	Required	The product catalog identifier
variantId	string	Optional	The specific product variant identifier (for single product messages)
sections	BikProductSection	Optional	Array of product sections (for multiple product messages)

BikProductSection type

Name	Type	Required/Optional	Description
title	string	Required	The section heading
variantIds	string[]	Required	Array of product variant identifiers in this section