WhatsApp Tabular Report
The WhatsApp Tabular Report provides detailed information about WhatsApp messages that were submitted and received. It includes details such as message content, message status, failure reason (if any), and many more. The report presents one row for each message submitted or received within the selected time range and matching any filters applied when generating the report.
The Tabular Report contains the following details:
| Column Title | Description | Example |
|---|---|---|
WABA ID | WhatsApp Business Account ID. | 8XXXXXXXXXXXXX1 |
WHATSAPP_ID | Unique ID generated by Kaleyra on the message request. | 7XXXXXX9-9XXX-4XXX-8XXX-4XXXXXXXXXX4:0 |
FROM | Approved WhatsApp Phone Number through which the message is sent. typically indicates the sender of the message. For outgoing messages, it shows the brand or business phone number or ID from which the message was sent. For incoming messages, it shows the phone number or ID of the end user who sent the message to the brand. | United Kingdom of Great Britain and Northern Ireland |
TO | The recipient number to which the message is sent. | 4XXXXXXXXXX1 |
MESSAGE_DIRECTION | Indicates the direction of the messages. True means an incoming message. False means outgoing message. | false |
SOURCE | The source of the WhatsApp messages. It can be API, Campaign, or Webhook. | api |
FORMAT | The format of the WhatsApp messages. It can be one of the following:
| text |
REASON_FOR_FAILURE | The reasons for the failure of the initiated WhatsApp messages. | Template params not matching. |
COUNTRY | End user's country. In the case of outgoing messages, this is the destination country. In the case of incoming messages, this is the country of the end user from where a message is sent to you. | India |
TEMPLATE_NAME | The name of the template used for sending the message. | contact_us |
MESSAGE | The WhatsApp message that end-users receive. Outgoing message: A message sent from the brand to the end-user, which may include rich content such as emojis or templates. Incoming message: A message sent from the end-user back to the brand. | Hi, this is the sample message from Kaleyra. |
CREATED_AT | Date and time when the message was requested in UTC. | 2022-11-25T08:34:10.000Z |
FAILED_AT_TZ | Date and time when the message failed in UTC. | 2022-11-25T08:34:10.000Z |
SENT_AT_TZ | Date and time when the message was sent to the Meta server in UTC. | 2022-11-25T08:34:10.000Z |
DELIVERED_AT_TZ | Date and time when the message reached the end user's mobile device in UTC. | 2022-11-25T08:34:10.000Z |
SEEN_AT_TZ | Date and time when the message was viewed on the mobile device in UTC. | 2022-11-25T08:34:10.000Z |
NOT_SENT_TZ | Message not sent to end user. | 2024-10-15T15:37:43.000Z |
PARENT_SERVICE_TYPE | Indicates whether a WhatsApp message is incoming (users sending a message to you), outgoing (you are sending a message to the end user as a free text), or template (you have sent a message to the recipient using a template). | conversation_outgoing |
CONVERSATION_CATEGORY | Defines the category of that conversation. Supported categories are Marketing, Utility, Authentication, and Service. | marketing |
CONVERSATION_TYPE | The type of conversation to which the message is associated. Supported types are Marketing, Utility, Authentication, and Service. | marketing |
CONVERSATION_ID | Unique conversation ID for WhatsApp conversation. | eXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX4 |
CONVERSATION_MSG_TYPE | Indicates the conversation message type. The type can be one of the following:
| In Conversation |
CAMPAIGN_ID | If the message is sent as part of a campaign launched from the User Interface, this is the Unique ID campaign. | 0xxxx210-3xx2-11xx-9x58-0xx1559xxx49 |
CAMPAIGN_NAME | Name of the WhatsApp campaign. | Nike_Shoe_Discount |
REF | The REF parameter is optional in API requests. You can pass the required information for this parameter that they want to display in the report. | Campaign_SupportTeam |
REF1 | The REF1 is an optional parameter that can be passed in the API requests. You can pass the required information for this parameter that they want to display in the report. | Campaign_SupportTeam1 |
REF2 | The REF2 parameter is optional in API requests. You can pass the required information for this parameter that they want to display in the report. | Campaign_SupportTeam2 |
PRICING_TYPE | Indicates the category or classification of how messages are billed. The pricing type might specify if a message is: regular— Indicates the message is billable. free_customer_service — Indicates the message is free because it is either a utility template or a non-template message sent within the end user service window. free_entry_point — Indicates the message is free because it was sent during an open free entry point window. | regular |
PRICING_MODEL | Indicates the pricing model applied to the message. | per-message pricing (PMP) |
PRICING_CATEGORY | Defines the pricing category of the message. Supported types are Marketing, Utility, Authentication, and Service. | marketing |
Amount | Amount will be calculated based on billable messages. | $1 |