WhatsApp Gateway

Authentication

Pass your master X-API-Key or account-specific authkey (UUID) in headers (x-api-key), Bearer token, or request body (authkey).

x-api-key: <API_KEY or AUTH_KEY_UUID>

Note: sessionId, company_id, and appkey are fully interchangeable throughout all APIs.

v3 Create Session

Initialize a new WhatsApp session for a company. Returns QR code base64 and authkey UUID.

POST /create-session
Content-Type: application/json

{
  "sessionId": "SHOP-1001"
}

Response:
{
  "success": true,
  "message": "Verify on your phone and scan the QR code.",
  "data": {
    "sessionId": "SHOP-1001",
    "authkey": "4a4620bc-5c92-4cfb-b2e2-31f3d16fb4c6",
    "qrcode": "data:image/png;base64,..."
  }
}

v3 List Sessions & Status

List all active sessions or query the status of a specific sessionId (company_id).

GET /sessions
x-api-key: <API_KEY>

GET /session-status/SHOP-1001
x-api-key: <API_KEY or AUTH_KEY_UUID>

v3 Send Text Message

Send text message via POST /send-message using sessionId.

POST /send-message
x-api-key: <API_KEY or AUTH_KEY_UUID>
Content-Type: application/json

{
  "sessionId": "SHOP-1001",
  "to": "919876543210",
  "message": "Hello from v3 API!"
}

v3 Send Media / Document

Send media, image or PDF via file upload or remote URL.

POST /send-media
x-api-key: <API_KEY or AUTH_KEY_UUID>
Content-Type: multipart/form-data

sessionId="SHOP-1001"
to="919876543210"
message="Invoice Attached"
file="https://example.com/sample.pdf"

v3 Logout & Delete Session

POST /logout-session
{"sessionId": "SHOP-1001"}

DELETE /delete-session/SHOP-1001

Create Account / Get AuthKey

Register a company (appkey / company_id) to generate its unique authkey UUID for API calls.

POST /api/v1/accounts
Content-Type: application/json

{
  "appkey": "SHOP-1001",
  "display_name": "Demo Shop"
}

Response:
{
  "ok": true,
  "appkey": "SHOP-1001",
  "authkey": "4a4620bc-5c92-4cfb-b2e2-31f3d16fb4c6"
}

OpenMarketing / v2 API (Create Message)

Send text message via POST /api/create-message using appkey and authkey.

POST /api/create-message
Content-Type: multipart/form-data

appkey="66930454-8966-496d-9e8e-8d73b9edbbfa"
authkey="<AUTH_KEY_UUID>"
to="919876543210"
message="Example message"

v2 API (Text Message with File)

Pass a remote PDF/Image URL or upload a binary file.

POST /api/create-message
Content-Type: multipart/form-data

appkey="66930454-8966-496d-9e8e-8d73b9edbbfa"
authkey="<AUTH_KEY_UUID>"
to="919876543210"
message="Example message"
file="https://example.com/sample.pdf"

v2 API (Template with Variables)

Send template messages with dynamic variable replacements.

POST /api/create-message
Content-Type: multipart/form-data

appkey="66930454-8966-496d-9e8e-8d73b9edbbfa"
authkey="<AUTH_KEY_UUID>"
to="919876543210"
template_id="TEMPLATE_ID"
variables[{variableKey1}]="john"
variables[{variableKey2}]="value"

Send invoice PDF (v1)

POST /api/v1/messages/document
Content-Type: multipart/form-data

company_id=SHOP-1001
to=919876543210
caption=Thank you. Your invoice is attached.
file=@Invoice-1024.pdf