Send message

You can use the create or update customer API to create/update customer inside your system.

Sending a text message

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

Sending a image message

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

Sending a video message

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

Sending a document message

{
    "appId": "APP_ID",
    "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

{
    "appId": "APP_ID",
    "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

{
    "appId": "APP_ID",
    "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

{
    "appId": "APP_ID",
    "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

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

Sending a message with multiple product

{
    "appId": "APP_ID",
    "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"
    }
}

API Details

curl --location 'https://bikapi.bikayi.app/integrations/bikPlatformFunctions-sendMessage' \
--header 'Authorization: Basic AUTH_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "APP_ID",
    "contactIdentifier": "+919900990090",
    "medium": "whatsapp",
    "type": "text"
    "payload": {
        "message": "This is a test message."
    }
}'

JSON response example:

{
    "status": 200
}

Request Information

Category	Value
Http request	POST
URL	https://bikapi.bikayi.app/integrations/bikPlatformFunctions-sendMessage

Input Schema for request

Field	Type	Meaning
medium	string*	Messages will be send through this medium
appId	string*	Application id of the store
contactIdentifier	string*	Phone number of user
businessPhoneNumber	string	Business phone number from which you want to send the message
payload	Message object*	Message Object

Output Schema for request

Field	Type	Meaning
status	number	Message status
id	string	Message id used for tracking