Data Dictionary
This guide contains the data dictionary for the main tables used in the uContact databases. It will help you understand the structure, data types, and purpose of each column, making it easier to integrate custom developments or query relevant system information.
ccrepo.whatsapp_messages
This table stores all WhatsApp messages managed through uContact, whether incoming or outgoing, manually sent or delivered via Outbound Hubs.
| Field Name | Data Type | Description |
|---|---|---|
| id | bigint | Unique and auto-incremental identifier for each record in the table. It is the primary key. |
| id_whatsapp | varchar(200) | Unique ID of the message provided by the WhatsApp provider (e.g., Gupshup, Meta). This ID is essential for tracking. It may be empty for some initial outbound records. |
| time | datetime | Date and time when the message was processed by uContact. Always stored in UTC-0 timezone. Example: 2025-05-28 15:25:59 |
| direction | varchar(8) | Indicates the direction of the message. Possible Values: - outbound: Message sent from uContact to the client. - inbound: Message received from the client. |
| callerid | varchar(100) | WhatsApp contact's phone number in international format, without the "+" character. |
| message | text | The content of the message. For template messages (HSM), it may contain a special format: the unique HSM ID followed by the parameters, separated by “:”. Examples: Hi! How are you?, hsm:1234:param1:param2 |
| campaign | varchar(200) | Name of the uContact campaign from which the message was received or sent. |
| agent | varchar(45) | Username of the agent who sent the message in case of outbound messages; for inbound messages, it is the agent assigned to the interaction at the time of receipt. For messages sent from Outbound Hubs, this field is empty. |
| result | varchar(900) | Delivery status or message processing result. Possible Values: - sent: Sent. - delivered: Delivered to recipient. - error: Failed to deliver. - read: Message read by the client. |
| guid | varchar(64) | GUID of the uContact interaction associated with the message. |
| attachments | json | Contains information about attachments (images, documents, etc.) in JSON format. Each file represents the storage path in the instance. Example: ["20250606/image.jpg"] |
| quotedid | varchar(200) | If the message is a reply, this field contains the id_whatsapp of the original quoted message. It is empty if the message is not a reply. |