Document Message

The Document messages are messages that display a document icon, linked to a document, that a WhatsApp user can tap to download.

Prerequisites

An active WhatsApp plan on Kaleyra platform.
An active WhatsApp for Business API plan that 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.

Sample Webhook

The following is the sample webhook.

{
    "meta_object": {
        "value": {
            "messaging_product": "whatsapp",
            "metadata": {
                "display_phone_number": "918XXXXXXXXX",
                "phone_number_id": "1046XXXXXXXXXXX"
            },
            "contacts": [
                {
                    "profile": {
                        "name": "Samuel"
                    },
                    "wa_id": "919XXXXXXXXX"
                }
            ],
            "messages": [
                {
                    "from": "919XXXXXXXXX",
                    "id": "wamid.HBgMOTE5NzQwNzc2NTA1FQIAEhgXXXXXXXXgQzM4RUE2RjRBMDcyODcyNEY5RjIwREUwMzcA",
                    "timestamp": "172XXXXXXX",
                    "type": "document",
                    "document": {
                        "filename": "Open smile features for variability.pdf",
                        "mime_type": "application\/pdf",
                        "sha256": "a5auRphs4M7S53IpTQstXXXXXXFrDfh08Aj3tMvur5g=",
                        "id": "1062XXXXXXXXXX98"
                    }
                }
            ]
        },
        "field": "messages"
    },
     "extra_info": {    
      	 		"media_url": "",
      	 		"ref": "Hello This will be my reference id - 123",
      	 		"ref1": "shoes campaign",
      	 		"ref2": "summer sale campaign",
      			"reply_to": "48c38d78-4ec5-XXXX-abee-03XXXXXX6c85",
       	 		"trace_id": "cb94fee2-3e70-XXXX-944a-2a4XXXXdb90a",
      	 		"waba_id": "347XXXXXXXXXX69"    
    }
}

The extra_info object contains additional metadata related to end-user message or reply. These fields help in tracking message context, references, and internal identifiers.

The following describes each field within the extra_info object:

Parameter	Data Type	Description	Example
`media_url`	URL	Contains the URL of the media (image, video, document, and many more) shared by the end user, if applicable.	https://example.com/images/product123.jpg
`ref, ref1, and ref2`	String	A reference parameter provided by the brand during the original message send request. This value appears in `extra_info` only when: i. The end-user replies to a previous message by selecting or highlighting it, or ii. The end-user responds through an interactive element (for example, a button) from an earlier message.	shoes campaign
`reply_to`	String	This field represents the parent message ID (the original message to which the end-user is replying) in the following scenarios: i. The end-user replies to a previous message by selecting or highlighting it, or ii. The end-user responds through an interactive element (for example, a button) from an earlier message. Note: If there is NO parent message ID, the `reply_to` field in the callback will be empty.	48c38d78-4ec5-XXXX-abee-03XXXXXX6c85
`trace_id`	String	An internal Kaleyra-generated identifier used for message tracing and debugging.	cb94fee2-3e70-XXXX-944a-2a4XXXXdb90a
`waba_id`	String	The WhatsApp Business Account (WABA) ID associated with the message.	347XXXXXXXXXX69