Types of payloads

Suggest Edits

This section explains the inbound event type message you receive on your callback URL. It states that a customer has sent a message to your WhatsApp Business API phone number. Here, we will understand the different types of payloads for inbound messages.

Common payload for all inbound events of type message

{   
  "app": "DemoApp", 
  "timestamp": 1580227766370,   
  "version": 2, 
  "type": "message",    
  "payload": {  
    "id": "ABEGkYaYVSEEAhAL3SLAWwHKeKrt6s3FKB0c",   
    "source": "918x98xx21x4",   
    "type": "text"|"image"|"file"|"audio"|"video"|"contact"|"location"|"button_reply"|"list_reply", 
    "payload": {    
      // Varies according to the type of payload.    
    },  
    "sender": { 
      "phone": "918x98xx21x4",  
      "name": "Drew",   
      "country_code": "91", 
      "dial_code": "8x98xx21x4" 
    },  
    "context": {    
      "id": "gBEGkYaYVSEEAgnPFrOLcjkFjL8",  
      "gsId": "9b71295f-f7af-4c1f-b2b4-31b4a4867bad"    
    }   
  } 
}

Common payload object description

KeyDescriptionSample
appThe name of the Gupshup app to which the customer has sent a message on WhatsAppDemoAPI
timestampThe time in UNIX timestamp when the message sent by the customer was received by Gupshup1584898839530
versionCallback payload version2
typeThe type of inbound eventmessage
payloadThe payload object represents the following:
WhatsApp message ID
 Sender's phone number along with their country code
The type of message
 Content of the message 		See the payload object description for more information.
senderThe sender object represents the following:
Name of the sender
Phone number of the sender		See the sender object description for more information.
contextThe context object is optional, it will only be included when someone replies to one of your messages. It contains information about the content of the original message, such as the Gupshup ID and WhatsApp ID of the message.See the context object description for more information.

The payload object description

KeyDescriptionSample
idThe unique WhatsApp message identifier for the inbound messageABEGkYaYVSEEAhAt2MgAKjL1qGe88OKyMQfM
sourceThe phone number of the customer who has sent the message on WhatsApp, number is in E.164 format918x98xx21x4
typeThe type of message received from the end user. Depending on 'type', the relevant message object will be received as part of the payload.

Must be one of these: text, image, file, audio, video, contact, and location.		text
payloadThe payload object contains the inbound message content sent by the customerSee types of incoming message received documentation below

The sender object description

KeyDescriptionSample
phoneThe phone number of the end user who has sent the message on WhatsApp, number is in E.164 format918x98xx21x4
nameName of the end user who has sent the message on WhatsAppDaniel
country_codeThe sender's country code91
dial_codeThe sender's dial code8x98xx21x4

The context object description

KeyDescriptionSample
idThe unique WhatsApp message identifier for the inbound messagegBEGkYaYVSEEAgnPFrOLcjkFjL8
gsIdThe unique Gupshup message identifier for the inbound message9b71295f-f7af-4c1f-b2b4-31b4a4867bad

Updated almost 2 years ago

What’s Next

In the next chapter of this guide, you'll learn about different types of inbound messages, such as Text, media, interactive and other messages.