API Reference

Integrate Maveraa seamlessly into your own applications. Our RESTful API allows you to programmatically manage your WhatsApp contacts, view conversations, and send messages in real-time.

Authentication

The Maveraa API uses API keys to authenticate requests. You can view and manage your API keys in the Settings page of your Dashboard.
Authentication to the API is performed via the X-API-Key HTTP header.

Example Request

curl -X GET "https://api.maveraa.tech/api/public/contacts" \
  -H "X-API-Key: mvr_live_a1b2c3d4e5..."

Keep your keys safe

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Contacts

GET /api/public/contacts

Retrieve a list of all contacts stored in your workspace.

Response Fields

  • contacts Array of Objects
  • total Integer

Response Example

{
  "total": 1,
  "contacts": [
    {
      "_id": "60d5ec...",
      "name": "John Doe",
      "phone": "6281234567890",
      "labels": ["VIP", "Customer"],
      "createdAt": "2023-10-01T12:00:00Z"
    }
  ]
}
POST /api/public/contacts

Create a new contact in your workspace.

Request Body

  • name * String
    Full name of the contact.
  • phone * String
    Phone number with country code (e.g. 628...).

Request Example

{
  "name": "Jane Smith",
  "phone": "6289876543210",
  "labels": "Lead, Website"
}

Inbox & Messages

GET /api/public/inbox/conversations

Retrieve the latest conversations/chats from your active WhatsApp sessions.

Query Parameters

  • sessionId String
    Optional. Filter by specific WhatsApp session.

Response Example

{
  "conversations": [
    {
      "remoteJid": "6281234567890@s.whatsapp.net",
      "pushName": "John Doe",
      "lastMessage": "Hello there!",
      "unreadCount": 2,
      "timestamp": "2023-10-01T12:05:00Z"
    }
  ]
}
POST /api/public/inbox/send

Send a text message or media via WhatsApp.

Request Body

  • sessionId * String
  • targetNumber * String
  • message * String
    The text message to send.

Request Example

{
  "sessionId": "session-123",
  "targetNumber": "6289876543210",
  "message": "Your OTP code is 4567"
}