WaConnect|API Documentation Dashboard Swagger UI

Inbox API

Query incoming messages stored on the platform. The Inbox API provides endpoints for listing messages, viewing conversations, and managing read status.

List Incoming Messages

GET /api/inbox

Retrieve incoming messages with optional filtering and pagination.

ParameterTypeDefaultDescription
limitnumber50Maximum records to return
offsetnumber0Number of records to skip
fromstringFilter by sender phone number
messageTypestringFilter by type (text, image, etc.)
phoneNumberIdstringFilter by receiving business number
unreadOnlybooleanfalseOnly return unread messages
sincestringISO timestamp to filter messages after

Get Conversations

GET /api/inbox/conversations

Retrieve a list of unique conversations grouped by sender, including the last message preview and unread count.

Get Conversation Messages

GET /api/inbox/conversation/:senderNumber

Retrieve all messages from a specific sender (conversation thread view).

Get Message by ID

GET /api/inbox/message/:messageId

Retrieve a specific incoming message by its WhatsApp message ID.

Mark Message as Read

POST /api/inbox/message/:messageId/read

Mark a specific incoming message as read. This also sends a read receipt to the sender via WhatsApp.

Mark Conversation as Read

POST /api/inbox/conversation/:senderNumber/read

Mark all messages from a specific sender as read.

Get Inbox Statistics

GET /api/inbox/statistics

Retrieve aggregate statistics: total messages, unread count, messages by type, and messages by phone number.

Get Messages by Phone Number

GET /api/inbox/phone-number/:phoneNumberId

Retrieve all messages received by a specific business phone number.

C# Example

// Fetch unread messages
var response = await client.GetAsync(
    "https://app.waconnect.me/api/inbox?unreadOnly=true&limit=20");
var json = await response.Content.ReadAsStringAsync();
Console.WriteLine(json);

// Mark a message as read
var msgId = "wamid.HBgLMTU1NTEyMzQ1NjcVAgASGCA0";
await client.PostAsync(
    $"https://app.waconnect.me/api/inbox/message/{msgId}/read",
    new StringContent(""));C#

The Inbox API is also accessible visually through the Dashboard Inbox tab, where you can browse conversations and read messages in a chat-style interface.