Incoming Text Message

The Incoming Text Message status allows you to receive and process text messages sent by participants in a WhatsApp group. The callback contains the message content, sender information, group details, message ID, timestamp, and other relevant metadata required to process and track the incoming message.

Prerequisites

An active WhatsApp for Business API plan on Kaleyra platform includes:
1. A WhatsApp business number.
2. An associated profile with the business number.
3. A WhatsApp verified and approved profile.
4. A WABA ID onboarded on Kaleyra WhatsApp API V2.
You must have the callback registered in the WhatsApp channel for the phone numbers. Refer WhatsApp Configuration for Callback.

Sample Webhook

The following is the sample webhook.

{
  "meta_object": {
    "field": "messages",
    "value": {
      "contacts": [
        {
          "profile": {
            "name": "John"
          },
          "wa_id": "91XXXXXXXX91"
        }
      ],
      "messages": [
        {
          "from": "91XXXXXXXXXX",
          "group_id": "Y2FwaV9ncm91cDo5MTc5NjE3MzI4MDY6MTIwMzYzNXXXXDIyMTU5OTMw",
          "id": "wamid.HBgSMTIwMzYzNDIyOXXXXTQ0OTMwFQgAEhgWM0VCMDM0QjlGNEQyNTA1RDBFXXXXRTY5DDkxOTM2MDk0OTA4MRUCAAA=",
          "text": {
            "body": "Testing Group"
          },
          "timestamp": "1771841709",
          "type": "text"
        }
      ],
      "messaging_product": "whatsapp",
      "metadata": {
        "display_phone_number": "91XXXXX256XX",
        "phone_number_id": "28XXXXXXXXXX655"
      }
    }
  },
  "extra_info": {
    "media_url": "https://example.com/media/XXXXXXXX",
    "reply_to": "waXXX.ORIGINAL_MESSAGE_ID",
    "trace_id": "d08dab9a-XXXX-498e-b66f-d37deXXXXX4b",
    "waba_id": "29XXXXXXXX54436"
  }
}