Message Type: Inbound

Suggest Edits

If you use WhatsApp for two-way conversation, incoming messages are transmitted to you in real-time.

The following WhatsApp components are available for customers to send you messages:

Text

{
    "type": "txt",
    "text": "Hi",
    "id": "ABEGkZE3N4NjAhAMjZIZWjB1i1-3KLlc4pZ9"
}

Image

{
    "type": "image",
    "text": "https://qa-filemanager.gupshup.io/fm/wamedia/wabot1/748b4597-6fcc-4850-b0b9-5d2ea2bfa462",
    "url": "https://qa-filemanager.gupshup.io/fm/wamedia/wabot1/748b4597-6fcc-4850-b0b9-5d2ea2bfa462",
    "mediaId": "748b4597-6fcc-4850-b0b9-5d2ea2bfa462",
    "id": "ABEGkZE3N4NjAhCHEUpPvNn722Vud3VagFOt"
}

Audio

{
    "type": "audio",
    "text": "https://qa-filemanager.gupshup.io/fm/wamedia/wabot1/59e406a6-d9a8-4686-8ffe-6af25c93eaa1",
    "url": "https://qa-filemanager.gupshup.io/fm/wamedia/wabot1/59e406a6-d9a8-4686-8ffe-6af25c93eaa1",
    "mediaId": "59e406a6-d9a8-4686-8ffe-6af25c93eaa1",
    "id": "ABEGkZE3N4NjAhCgRWUcVsImwcs6dAHX-rx6"
}

Video

{
    "type": "video",
    "text": "https://qa-filemanager.gupshup.io/fm/wamedia/wabot1/247a54a1-a345-4b1f-8309-99a2f1715c9e",
    "url": "https://qa-filemanager.gupshup.io/fm/wamedia/wabot1/247a54a1-a345-4b1f-8309-99a2f1715c9e",
    "mediaId": "247a54a1-a345-4b1f-8309-99a2f1715c9e",
    "id": "ABEGkZE3N4NjAhB3POBK_13mI6Vf8J_AZHCe"
}

File

{
    "type": "file",
    "text": "https://qa-filemanager.gupshup.io/fm/wamedia/wabot1/66f4f495-de40-47f3-9ab2-f83677433fbd?fileName=Adobe Scan Aug 17, 2022.pdf",
    "url": "https://qa-filemanager.gupshup.io/fm/wamedia/wabot1/66f4f495-de40-47f3-9ab2-f83677433fbd?fileName=Adobe Scan Aug 17, 2022.pdf",
    "mediaId": "66f4f495-de40-47f3-9ab2-f83677433fbd",
    "id": "ABEGkZE3N4NjAhBMRnV0v9NW_D4uXKPwHw6Q"
}

Stickers

{
    "type": "video",
    "text": "https://qa-filemanager.gupshup.io/fm/wamedia/wabot1/d7bfdb7f-a585-414d-8464-2f9692a0274a",
    "url": "https://qa-filemanager.gupshup.io/fm/wamedia/wabot1/d7bfdb7f-a585-414d-8464-2f9692a0274a",
    "mediaId": "d7bfdb7f-a585-414d-8464-2f9692a0274a",
    "id": "ABEGkZE3N4NjAhAV6jgNp8OA4RkYyDmblZE_"
}

Contact

{
    "type": "contacts",
    "id": "ABEGkZE3N4NjAhCpdlP1H_FEf3dxILjSbdqy"
}

Location

{
    "type": "location",
    "text": "https://www.google.com/maps/?q=19.2795702,73.0805964",
    "latitude": "19.2795702",
    "longitude": "73.0805964",
    "id": "ABEGkZE3N4NjAhDtnAhgmyJrMK1yAVHCvpQI"
}

Interactive reply

{
    "refmsgid": "9801910a",
    "type": "txt",
    "text": "Apple 1",
    "id": "ABEGkXiUJ0MSAgo-sNZ0wjEO1IS8",
    "postbackText": "DEFAULT_QR"
}

Interactive list reply

{
    "refmsgid": "list1",
    "type": "txt",
    "text": "section 1 row 2 1",
    "id": "ABEGkXiUJ0MSAgo-sKe59W7mE8mK",
    "postbackText": "section 1 row 2 postback payload"
}

Order

{
    "type": "order",
    "from": "918435249197",
    "id": "ABEGkYQ1JJGXAhDeNyXYCLGtpwJk8KLWKRmo",
    "orderDetails": {
        "catalogId": "6373780729363060",
        "productDetails": [
            {
                "productId": "LAPTOP002",
                "price": "290000",
                "currency": "INR",
                "quantity": "1"
            }
        ]
    }
}

Payment details

{
    "type": "paymentDetails",
    "id": "ABEGkXiUJ0MSAhC6MW7OFrUzk0SMhoVr_IHy",
    "paymentReferenceId": "1652072171872"
}

Quoted messages

End users have the option of quoting messages to indicate that they are responding to them. The quote ID can be found in the end user's response.

Referral

When a customer clicks an advertisement on a platform like Facebook or Instagram that has a click-to-WhatsApp button and sends a message to your company, you get the following details about the advertisement along with the message:

  • Whether a user clicked an advertisement or a post
  • The advertisement's URL
  • Facebook ID

Product question

The context of the inbound message contains details about the product if an end user asks you a question in a Product or Multi-product message.

Additional functionality

You can mark inbound messages as read in the WhatsApp API.

Updated 7 months ago