Authentication & Headers

UMVA Messaging API Authentication

The UMVA Messaging API uses API Keys for authentication. To make an authenticated request to the Messaging API, you must include your messaging api_key in the JSON body of each request as described below.

Obtain the Keys:

Messaging API Users: Messaging-specific API keys can be generated from your UMVA dashboard under your messaging settings (e.g. "API Keys"). Please ensure that your keys are stored safely and not shared publicly. If your keys are compromised, regenerate them from the dashboard and rotate them in your applications.

Request Headers: For all Messaging API calls you must send JSON bodies and standard JSON headers. Authentication for messaging endpoints is done via the api_key field in the JSON body (not via X-API-Key headers).

Header Name Value Required
Content-Type application/json YES
Accept application/json YES

MESSAGING API (WHATSAPP & EMAIL)

Base URL (Messaging API): https://umva.net/api/messaging

Products: The Messaging API lets you send and read messages across two main channels:

  • WhatsApp: Device-based WhatsApp messaging (send texts, media, and fetch chats).
  • Email: Send emails via configured SMTP servers and read logs/live emails via IMAP.

Standard Request Rules (Messaging)

  • All messaging endpoints are POST requests, unless otherwise specified.
  • Requests must have a JSON body and must include a valid api_key for the messaging product (WhatsApp or Email).
  • Headers must include Content-Type: application/json and Accept: application/json.
  • Use the base URL https://umva.net/api/messaging with the paths listed below.

Standard Response Formats

All Messaging API responses follow a consistent JSON schema using the success field:

{
  "success": true,
  "message": "Action successful description.",
  "data": { ... } // Optional extra data
}

Error responses typically use HTTP status codes 400, 401, 404, 429 or 500 and follow this structure:

{
  "success": false,
  "message": "Error description"
}