Send Document Messages

POST Method

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

📘

Note:

Only one media document can be sent per message.

This document explains how to send a document message.

Supported Document Types

The following table contains details about the document types that can be sent as a document message:

Document Type ExtensionMIME TypeMax Size
Text.txttext/plain100 MB
Microsoft Excel.xlsapplication/vnd.ms-excel100 MB
Microsoft Excel.xlsxapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet100 MB
Microsoft Word.docapplication/msword100 MB
Microsoft Word.docxapplication/nd.openxmlformats-officedocument.wordprocessingml.document100 MB
Microsoft PowerPoint.pptapplication/vnd.ms-powerpoint100 MB
Microsoft PowerPoint.pptxapplication/vnd.openxmlformats-officedocument.presentationml.presentation100 MB
PDF.pdfapplication/pdf100 MB

Prerequisites

  1. Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
    A prerequisite for using Kaleyra WhatsApp APIs is to have an active WhatsApp plan on kaleyra platform.
  2. To set up a WhatsApp account on kaleyra.io, see Manual Signup
    and Embedded Signup.
  3. An active WhatsApp for Business API plan that includes:
    • A WhatsApp business number.
    • An associated profile with the business number.
    • A WhatsApp verified and approved profile.

Base URL

https://<api_domain>/v2/<SID>

API Domain and Value

api_domainValue
IN podapi.in.kaleyra.io
SG Podapi.ap.kaleyra.io
EU Podapi.eu.kaleyra.io

API Request to Send Document Messages

To send document messages use the https://<api_domain>/v2/<sid>/whatsapp/<phone_number>/messages endpoint with the following request method:

Request Format

The following is the request format to send document messages:

curl -X POST \
  https://api.in.kaleyra.io/v2/HXAP16XXXXXX97IN/whatsapp/+91XXXXXXXXXX/messages \
  -H 'Content-Type: <content_type>' \
  -H 'api-key: <api-key>' \
  -d  '{
       "messaging_object": {
         "messaging_product": "<messaging_product>",  
         "recipient_type": "<recipient_type>",  
         "to": "<whatsapp_user_phone_number>",  
         "type": "<type>",  
         "document": {  
            "id": "<media_id>",	 
            "link": "<media_url>",	 
            "caption": "<document_caption>",  
            "filename": "<document_filename>"}
   },
    "extra_info": {
        "ref": "<ref>",
        "ref1": "<ref1>",
        "ref2": "<ref2>",
        "wa_source": "<wa_source>"
    }
}'

Sample Request Format

The following is the sample request format to send document messages:

curl -X POST \
  https://api.in.kaleyra.io/v2/HXAP16XXXXXX97IN/whatsapp/+91XXXXXXXXXX/messages \
  -H 'Content-Type: application/json' \
  -H 'api-key: Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3' \
  -d  '{
    "messaging_object": { 
      "messaging_product":"whatsapp",  
      "recipient_type":"individual",  
      "to":"+16XXXXXXXXX",  
      "type":"document",  
      "document":{  
         "id":"43XXXXXXXXXXXXX ",  
         "link":"https://www.luckyshrub.com/invoices/FmOzfD9cKf/lucky-shrub-invoice.pdf.png",  
         "caption":"Lucky Shrub Invoice",  
         "filename":"lucky-shrub-invoice.pdf"  
      } 
    },
    "extra_info": {
        "ref": "customer1",
        "ref1": "marketing",
        "ref2": "dictionary",
        "wa_source": "api"
    }
}'

URL Parameters and Headers

Following is the list of parameters and headers to send the outgoing message request:

Parameter / HeadersData TypeDescriptionExampleMandatory?
sidStringAccount SID (Security Identifier).HXAP16XXXXXX97INYes
phone_numberStringPhone number of the end customer you want to send a message to.+91XXXXXXXXXXYes
(valid phone numbers only)
Content-TypeStringIndicates the format of the content the API will be processing.The only allowed value is application/json.Yes
api-keyStringAPI key generated from kaleyra platform account.Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx3Yes

Following is the list of attributes to be used in the payload to send the outgoing message:

ParameterData TypeDescriptionExampleMandatory?
messaging_objectJSON objectPayload is supported only in JSON format. The messaging_object is the payload which contains the message object as defined by Meta which is used to send the WhatsApp message.See the specific table for details.Yes
extra_infoJSON objectThis object will contain additional details that a user can send for certain functionalities.See the specific table for details.No

The following table describes the different attributes used for the messaging_object JSON object:

ParameterData TypeDescriptionExampleMandatory?
messaging_productStringMessaging service used for the request.Only allowed value is whatsappYes
recipient_type StringCurrently, you can only send messages to individuals. Default is individual.Only allowed value is individualNo
toStringWhatsApp end-user phone number. It should include country code prefix following E.164 format.+16XXXXXX234Yes
typeStringThe type of message you want to send. If omitted, defaults to text.Only allowed value for sending this message is document.No
documentArray of objectsContains the information of the document to be sent.See the specific table for details.Yes

The following table describes the different attributes used for the document_object JSON object:

ParameterData TypeDescriptionExampleMandatory?
idStringUploaded media asset ID.43XXXXXXXXXXXXXRequired if using an uploaded media asset (recommended).
linkStringURL of the image asset on your public server. For better performance, we recommend that you upload your media  asset instead.https://www.luckyshrub.com/invoices/FmOzfD9cKf/lucky-shrub-invoice.pdf.pngRequired if using an uploaded media asset (recommended).
captionStringDocument caption text.Lucky Shrub InvoiceNo
filenameStringDocument filename, with extension. The WhatsApp client will use an appropriate file type icon based on the extension.lucky-shrub-invoice.pdfNo

The following table describes the different attributes used for the extra_info JSON object:

ParameterData TypeDescriptionExampleMandatory?
ref StringInclude any contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more.
Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.
customer1No
ref1 StringInclude the contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more.
Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.
marketingNo
ref2 StringInclude the contextual information in this parameter you want to associate with the request. For Example, Name, Customer ID, and many more.
Limit: The variable can be 255 characters long only. This parameter will be available in report and callback.
dictionaryNo
wa_sourceStringIndicates the source from where the API has been triggered. Supported values for wa_source are "api", "clevertap", "zoho", "webengage", "shopify", "leadsquared", "responsys", "braze", "hubspot", "salesforce", "zapier", "eloqua", and "moengage".
Note: If the customer passes any other value other than above-specified values, then the system will override that as the "API".
apiNo

📘

Note:

In the case of ref, ref1, and ref2, if the length of the string exceeds 255 characters, it will be truncated.


Sample Success Response

The following success message appears with the status 202 Accepted:

202 Accepted 
{
"code":"WA202"
"message":"Request Accepted",
"data":{
  "message_id":"AXXXXXXXXXXXXXXXXXXX"
}
"error":{}
}

Sample Failure Response

The following are the failure responses:

401 Unauthorized
{
    "code": "RBC001",
    "message": "Incorrect SID or API key.",
    "data": [],
    "error": {
        "error": "Incorrect SID or API key."
    }
}
401 Unauthorized phone number
{
    "code": "WA401",
    "message": "Phone number is not present or does not belong to the account.",
    "data": {},
    "error": {
        "phone_number": "Phone number is not present or does not belong to the account."
    }
}
400 Incorrect payload
{
    "code": "WA400",
    "message": "Refer to correct payload format",
    "data": {},
    "error": {
        "payload": "Incorrect payload format"
    }
}
500 Internal Server Error
{
    "code": "WA500",
    "message": "Please try again later",
    "data": {},
    "error": {
        "error": "Internal server error"
    }
}
400 Low balance
{
    "code": "E110",
    "message": "Please check your balance, You have a low balance!",
    "data": {},
    "error": {
        "balance": "Please check your balance, You have a low balance!"
    }
}
401 Unauthorised Account type
{
    "code": "WA-401",
    "message": "API is not available for given customer.Please contact support for more info",
    "data": {},
    "error": {
        "account": "API is not available for given customer.Please contact support for more info"
    }
}
401 Unauthorized phone number version
{
    "code": "WA-401",
    "message": "The phone number you're using is associated with different Version of our WA API. Please use the appropriate endpoint.",
    "data": {},
    "error": {
        "phone_number": "The phone number you're using is associated with different Version of our WA API. Please use the appropriate endpoint."
    }
}