Skip to content

07-api-collection.md

Latest commit

 

History

History
1371 lines (1165 loc) · 27.8 KB

07-api-collection.md

File metadata and controls

1371 lines (1165 loc) · 27.8 KB
Raw

07 - API Collection

07.1 Overview

This document provides a complete collection of OpenWA API endpoints with request/response examples for each endpoint. It can be used as a quick reference or imported into tools such as Postman, Insomnia, or Bruno.

Base URL

Development: http://localhost:2785
Production:  https://api.your-domain.com

Authentication

All endpoints (except /health) require an API Key:

X-API-Key: your-api-key-here

Response Format

{
  "success": true,
  "data": { ... },
  "meta": {
    "timestamp": "2026-02-02T10:30:00Z",
    "requestId": "req_abc123"
  }
}

Error Format

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid phone number format",
    "details": {
      "field": "phone",
      "expected": "format: 628xxx@c.us"
    }
  },
  "meta": {
    "timestamp": "2026-02-02T10:30:00Z",
    "requestId": "req_abc123"
  }
}

07.2 Health & System

GET /health

Basic health check.

curl http://localhost:2785/health

Response:

{
  "status": "ok",
  "timestamp": "2026-02-02T10:30:00Z"
}

GET /health/detailed

Detailed health check with system status.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/health/detailed

Response:

{
  "status": "ok",
  "version": "0.1.0",
  "uptime": 86400,
  "timestamp": "2026-02-02T10:30:00Z",
  "checks": {
    "database": "ok",
    "redis": "ok",
    "sessions": {
      "total": 5,
      "connected": 4,
      "disconnected": 1
    }
  }
}

GET /api/metrics

System metrics (Prometheus format).

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/metrics

Response:

# HELP openwa_sessions_total Total number of sessions
# TYPE openwa_sessions_total gauge
openwa_sessions_total{status="connected"} 4
openwa_sessions_total{status="disconnected"} 1

# HELP openwa_messages_total Total messages processed
# TYPE openwa_messages_total counter
openwa_messages_total{direction="incoming"} 15234
openwa_messages_total{direction="outgoing"} 8567

# HELP openwa_api_requests_total Total API requests
# TYPE openwa_api_requests_total counter
openwa_api_requests_total{method="GET",status="200"} 45678
openwa_api_requests_total{method="POST",status="200"} 12345

07.3 Sessions API

GET /api/sessions

List all sessions.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions

Query Parameters:

Parameter Type Description
status string Filter by status: CONNECTED, DISCONNECTED, INITIALIZING
limit number Max results (default: 20)
offset number Pagination offset

Response:

{
  "success": true,
  "data": [
    {
      "id": "default",
      "name": "Default Session",
      "status": "CONNECTED",
      "phoneNumber": "628123456789",
      "profileName": "John Doe",
      "profilePicture": "https://...",
      "createdAt": "2026-02-01T00:00:00Z",
      "lastSeen": "2026-02-02T10:30:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}

POST /api/sessions

Create new session.

curl -X POST http://localhost:2785/api/sessions \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "session-1",
    "name": "Customer Support",
    "config": {
      "autoReconnect": true,
      "webhookUrl": "https://your-server.com/webhook"
    }
  }'

Request Body:

Field Type Required Description
id string No Session ID (auto-generated if not provided)
name string No Display name
config.autoReconnect boolean No Auto reconnect on disconnect (default: true)
config.webhookUrl string No Webhook URL for this session
config.proxy string No Proxy URL (http://user:pass@host:port)

Response:

{
  "success": true,
  "data": {
    "id": "session-1",
    "name": "Customer Support",
    "status": "INITIALIZING",
    "qr": null,
    "createdAt": "2026-02-02T10:30:00Z"
  }
}

GET /api/sessions/:id

Get session details.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/session-1

Response:

{
  "success": true,
  "data": {
    "id": "session-1",
    "name": "Customer Support",
    "status": "CONNECTED",
    "phoneNumber": "628123456789",
    "profileName": "John Doe",
    "profilePicture": "https://...",
    "pushName": "John",
    "platform": "android",
    "config": {
      "autoReconnect": true,
      "webhookUrl": "https://your-server.com/webhook"
    },
    "stats": {
      "messagesReceived": 1234,
      "messagesSent": 567,
      "lastMessageAt": "2026-02-02T10:25:00Z"
    },
    "createdAt": "2026-02-01T00:00:00Z",
    "lastSeen": "2026-02-02T10:30:00Z"
  }
}

DELETE /api/sessions/:id

Delete session.

curl -X DELETE \
  -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/session-1

Query Parameters:

Parameter Type Description
keepAuth boolean Keep auth files for quick reconnect (default: false)

Response:

{
  "success": true,
  "data": {
    "message": "Session deleted successfully"
  }
}

GET /api/sessions/:id/qr

Get QR code for authentication.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/session-1/qr

Query Parameters:

Parameter Type Description
format string base64 (default), raw, image

Response (format=base64):

{
  "success": true,
  "data": {
    "qr": "data:image/png;base64,iVBORw0KGgo...",
    "expiresAt": "2026-02-02T10:31:00Z"
  }
}

Response (format=image): Returns PNG image directly with Content-Type: image/png

POST /api/sessions/:id/restart

Restart session.

curl -X POST \
  -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/session-1/restart

Response:

{
  "success": true,
  "data": {
    "message": "Session restarting",
    "status": "INITIALIZING"
  }
}

POST /api/sessions/:id/logout

Logout session (clear auth).

curl -X POST \
  -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/session-1/logout

Response:

{
  "success": true,
  "data": {
    "message": "Session logged out successfully"
  }
}

07.4 Messages API

POST /api/sessions/:id/messages

Send message.

# Text message
curl -X POST http://localhost:2785/api/sessions/default/messages \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "628123456789@c.us",
    "type": "text",
    "body": "Hello, World!"
  }'

Request Body - Text:

{
  "phone": "628123456789@c.us",
  "type": "text",
  "body": "Hello, World!",
  "options": {
    "quotedMessageId": "MSG_ABC123",
    "mentions": ["628111222333@c.us"]
  }
}

Request Body - Image:

{
  "phone": "628123456789@c.us",
  "type": "image",
  "media": {
    "url": "https://example.com/image.jpg"
  },
  "caption": "Check this out!"
}

Request Body - Image (Base64):

{
  "phone": "628123456789@c.us",
  "type": "image",
  "media": {
    "base64": "iVBORw0KGgo...",
    "mimetype": "image/jpeg",
    "filename": "photo.jpg"
  },
  "caption": "Photo from base64"
}

Request Body - Document:

{
  "phone": "628123456789@c.us",
  "type": "document",
  "media": {
    "url": "https://example.com/document.pdf"
  },
  "filename": "report.pdf",
  "caption": "Monthly report"
}

Request Body - Location:

{
  "phone": "628123456789@c.us",
  "type": "location",
  "location": {
    "latitude": -6.2088,
    "longitude": 106.8456,
    "name": "Monas",
    "address": "Jakarta, Indonesia"
  }
}

Request Body - Contact:

{
  "phone": "628123456789@c.us",
  "type": "contact",
  "contact": {
    "name": "John Doe",
    "phone": "+628111222333"
  }
}

Request Body - Buttons (Interactive):

{
  "phone": "628123456789@c.us",
  "type": "buttons",
  "body": "Please choose an option:",
  "buttons": [
    { "id": "btn1", "text": "Option 1" },
    { "id": "btn2", "text": "Option 2" },
    { "id": "btn3", "text": "Option 3" }
  ],
  "footer": "Powered by OpenWA"
}

Request Body - List (Interactive):

{
  "phone": "628123456789@c.us",
  "type": "list",
  "body": "Please select from the menu:",
  "buttonText": "View Menu",
  "sections": [
    {
      "title": "Category 1",
      "rows": [
        { "id": "item1", "title": "Item 1", "description": "Description 1" },
        { "id": "item2", "title": "Item 2", "description": "Description 2" }
      ]
    }
  ],
  "footer": "Powered by OpenWA"
}

Response:

{
  "success": true,
  "data": {
    "id": "MSG_ABC123DEF456",
    "phone": "628123456789@c.us",
    "type": "text",
    "body": "Hello, World!",
    "status": "PENDING",
    "timestamp": "2026-02-02T10:30:00Z"
  }
}

POST /api/sessions/:id/messages (Multipart)

Send message with file upload.

curl -X POST http://localhost:2785/api/sessions/default/messages \
  -H "X-API-Key: $API_KEY" \
  -F "phone=628123456789@c.us" \
  -F "type=image" \
  -F "media=@/path/to/image.jpg" \
  -F "caption=Uploaded via multipart"

GET /api/sessions/:id/messages

Get message history.

curl -H "X-API-Key: $API_KEY" \
  "http://localhost:2785/api/sessions/default/messages?phone=628123456789@c.us&limit=50"

Query Parameters:

Parameter Type Description
phone string Filter by chat (required)
limit number Max results (default: 50, max: 200)
before string Messages before this ID
after string Messages after this ID
type string Filter by type: chat, image, video, etc.

Response:

{
  "success": true,
  "data": [
    {
      "id": "MSG_ABC123",
      "from": "628123456789@c.us",
      "to": "628987654321@c.us",
      "body": "Hello!",
      "type": "chat",
      "timestamp": "2026-02-02T10:25:00Z",
      "status": "READ",
      "isFromMe": false
    }
  ],
  "meta": {
    "hasMore": true,
    "nextCursor": "MSG_DEF456"
  }
}

GET /api/sessions/:id/messages/:messageId

Get specific message.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/messages/MSG_ABC123

DELETE /api/sessions/:id/messages/:messageId

Delete/revoke message.

curl -X DELETE \
  -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/messages/MSG_ABC123

Query Parameters:

Parameter Type Description
forEveryone boolean Delete for everyone (default: true)

POST /api/sessions/:id/messages/:messageId/react

React to message.

curl -X POST http://localhost:2785/api/sessions/default/messages/MSG_ABC123/react \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emoji": "👍"}'

07.5 Contacts API

GET /api/sessions/:id/contacts

Get all contacts.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/contacts

Response:

{
  "success": true,
  "data": [
    {
      "id": "628123456789@c.us",
      "name": "John Doe",
      "pushName": "John",
      "shortName": "John",
      "isMyContact": true,
      "isBlocked": false,
      "profilePicture": "https://..."
    }
  ]
}

GET /api/sessions/:id/contacts/:phone

Get contact info.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/contacts/628123456789

GET /api/sessions/:id/contacts/:phone/exists

Check if number exists on WhatsApp.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/contacts/628123456789/exists

Response:

{
  "success": true,
  "data": {
    "exists": true,
    "jid": "628123456789@c.us"
  }
}

POST /api/sessions/:id/contacts/:phone/block

Block contact.

curl -X POST \
  -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/contacts/628123456789/block

POST /api/sessions/:id/contacts/:phone/unblock

Unblock contact.

curl -X POST \
  -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/contacts/628123456789/unblock

07.6 Groups API

GET /api/sessions/:id/groups

Get all groups.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/groups

Response:

{
  "success": true,
  "data": [
    {
      "id": "120363123456789@g.us",
      "name": "Family Group",
      "description": "Family chat",
      "participantsCount": 15,
      "isAdmin": true,
      "profilePicture": "https://...",
      "createdAt": "2025-01-15T00:00:00Z"
    }
  ]
}

POST /api/sessions/:id/groups

Create new group.

curl -X POST http://localhost:2785/api/sessions/default/groups \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Group",
    "participants": [
      "628123456789@c.us",
      "628987654321@c.us"
    ]
  }'

Response:

{
  "success": true,
  "data": {
    "id": "120363987654321@g.us",
    "name": "New Group",
    "inviteCode": "ABC123XYZ"
  }
}

GET /api/sessions/:id/groups/:groupId

Get group info.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/groups/120363123456789@g.us

Response:

{
  "success": true,
  "data": {
    "id": "120363123456789@g.us",
    "name": "Family Group",
    "description": "Family chat",
    "owner": "628111222333@c.us",
    "participants": [
      {
        "id": "628123456789@c.us",
        "isAdmin": true,
        "isSuperAdmin": false
      },
      {
        "id": "628987654321@c.us",
        "isAdmin": false,
        "isSuperAdmin": false
      }
    ],
    "settings": {
      "announce": false,
      "restrict": false
    },
    "inviteCode": "ABC123XYZ",
    "createdAt": "2025-01-15T00:00:00Z"
  }
}

PATCH /api/sessions/:id/groups/:groupId

Update group info.

curl -X PATCH http://localhost:2785/api/sessions/default/groups/120363123456789@g.us \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Group Name",
    "description": "New description"
  }'

DELETE /api/sessions/:id/groups/:groupId

Leave group.

curl -X DELETE \
  -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/groups/120363123456789@g.us

POST /api/sessions/:id/groups/:groupId/participants

Add participants to group.

curl -X POST http://localhost:2785/api/sessions/default/groups/120363123456789@g.us/participants \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": ["628111222333@c.us", "628444555666@c.us"]
  }'

DELETE /api/sessions/:id/groups/:groupId/participants

Remove participants from group.

curl -X DELETE http://localhost:2785/api/sessions/default/groups/120363123456789@g.us/participants \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": ["628111222333@c.us"]
  }'

POST /api/sessions/:id/groups/:groupId/admins

Promote to admin.

curl -X POST http://localhost:2785/api/sessions/default/groups/120363123456789@g.us/admins \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": ["628123456789@c.us"]
  }'

DELETE /api/sessions/:id/groups/:groupId/admins

Demote from admin.

curl -X DELETE http://localhost:2785/api/sessions/default/groups/120363123456789@g.us/admins \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "participants": ["628123456789@c.us"]
  }'

GET /api/sessions/:id/groups/:groupId/invite-code

Get group invite code.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/groups/120363123456789@g.us/invite-code

Response:

{
  "success": true,
  "data": {
    "inviteCode": "ABC123XYZ",
    "inviteUrl": "https://chat.whatsapp.com/ABC123XYZ"
  }
}

POST /api/sessions/:id/groups/:groupId/invite-code/revoke

Revoke and generate new invite code.

curl -X POST \
  -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/default/groups/120363123456789@g.us/invite-code/revoke

07.7 Webhooks API

GET /api/sessions/:sessionId/webhooks

List all webhooks.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/sess_abc123/webhooks

Response:

{
  "success": true,
  "data": [
    {
      "id": "wh_123",
      "url": "https://your-server.com/webhook",
      "events": ["message.received", "message.ack"],
      "sessionId": "sess_abc123",
      "enabled": true,
      "secret": "whsec_***",
      "createdAt": "2026-02-01T00:00:00Z"
    }
  ]
}

POST /api/sessions/:sessionId/webhooks

Create webhook.

curl -X POST http://localhost:2785/api/sessions/sess_abc123/webhooks \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhook",
    "events": ["message.received", "message.ack", "session.status"],
    "headers": {
      "Authorization": "Bearer your-token"
    }
  }'

Request Body:

Field Type Required Description
url string Yes Webhook endpoint URL
events string[] Yes Events to subscribe
headers object No Custom headers to send
secret string No Secret for signature verification

Available Events:

message.received       - New incoming message
message.sent           - Message sent
message.ack            - Message status (sent, delivered, read)
message.revoked        - Message deleted
session.status         - Session status change
session.qr             - QR code generated
session.authenticated  - Session authenticated
session.disconnected   - Session disconnected
group.join             - Someone joined group
group.leave            - Someone left group
group.update           - Group settings changed

Response:

{
  "success": true,
  "data": {
    "id": "wh_456",
    "url": "https://your-server.com/webhook",
    "events": ["message.received", "message.ack", "session.status"],
    "sessionId": "sess_abc123",
    "enabled": true,
    "secret": "whsec_abc123xyz",
    "createdAt": "2026-02-02T10:30:00Z"
  }
}

GET /api/sessions/:sessionId/webhooks/:id

Get webhook details.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/sess_abc123/webhooks/wh_456

PATCH /api/sessions/:sessionId/webhooks/:webhookId

Update webhook.

curl -X PATCH http://localhost:2785/api/sessions/sess_abc123/webhooks/wh_456 \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "events": ["message.received"],
    "enabled": false
  }'

DELETE /api/sessions/:sessionId/webhooks/:webhookId

Delete webhook.

curl -X DELETE \
  -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/sess_abc123/webhooks/wh_456

GET /api/sessions/:sessionId/webhooks/:id/logs

Get webhook delivery logs.

curl -H "X-API-Key: $API_KEY" \
  "http://localhost:2785/api/sessions/sess_abc123/webhooks/wh_456/logs?limit=20"

Response:

{
  "success": true,
  "data": [
    {
      "id": "log_789",
      "webhookId": "wh_456",
      "event": "message.received",
      "status": "success",
      "statusCode": 200,
      "duration": 150,
      "attempt": 1,
      "payload": { ... },
      "response": { ... },
      "createdAt": "2026-02-02T10:30:00Z"
    }
  ]
}

POST /api/sessions/:sessionId/webhooks/:id/test

Test webhook.

curl -X POST \
  -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/sessions/sess_abc123/webhooks/wh_456/test

Response:

{
  "success": true,
  "data": {
    "status": "success",
    "statusCode": 200,
    "duration": 125,
    "response": {
      "received": true
    }
  }
}

07.8 API Keys API

GET /api/api-keys

List API keys.

curl -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/api-keys

Response:

{
  "success": true,
  "data": [
    {
      "id": "key_123",
      "name": "Production Key",
      "prefix": "owa_prod_***",
      "permissions": ["*"],
      "sessionAccess": ["*"],
      "rateLimit": 1000,
      "lastUsed": "2026-02-02T10:30:00Z",
      "expiresAt": null,
      "createdAt": "2026-01-01T00:00:00Z"
    }
  ]
}

POST /api/api-keys

Create API key.

curl -X POST http://localhost:2785/api/api-keys \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Integration Key",
    "permissions": ["sessions:read", "messages:write"],
    "sessionAccess": ["default"],
    "rateLimit": 100,
    "expiresAt": "2027-01-01T00:00:00Z"
  }'

Permissions:

*                    - All permissions
sessions:read        - Read session info
sessions:write       - Create/delete sessions
messages:read        - Read messages
messages:write       - Send messages
contacts:read        - Read contacts
contacts:write       - Block/unblock contacts
groups:read          - Read group info
groups:write         - Manage groups
webhooks:read        - Read webhooks
webhooks:write       - Manage webhooks
api-keys:read        - Read API keys
api-keys:write       - Manage API keys

Response:

{
  "success": true,
  "data": {
    "id": "key_456",
    "name": "Integration Key",
    "key": "owa_abc123xyz789...",
    "permissions": ["sessions:read", "messages:write"],
    "sessionAccess": ["default"],
    "rateLimit": 100,
    "expiresAt": "2027-01-01T00:00:00Z",
    "createdAt": "2026-02-02T10:30:00Z"
  }
}

Note: The full key is only shown once at creation.

DELETE /api/api-keys/:id

Revoke API key.

curl -X DELETE \
  -H "X-API-Key: $API_KEY" \
  http://localhost:2785/api/api-keys/key_456

07.9 Postman Collection

{
  "info": {
    "name": "OpenWA API",
    "description": "OpenWA WhatsApp API Gateway",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "http://localhost:2785",
      "type": "string"
    },
    {
      "key": "apiKey",
      "value": "your-api-key",
      "type": "string"
    },
    {
      "key": "sessionId",
      "value": "default",
      "type": "string"
    }
  ],
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "X-API-Key",
        "type": "string"
      },
      {
        "key": "value",
        "value": "{{apiKey}}",
        "type": "string"
      },
      {
        "key": "in",
        "value": "header",
        "type": "string"
      }
    ]
  },
  "item": [
    {
      "name": "Health",
      "item": [
        {
          "name": "Health Check",
          "request": {
            "method": "GET",
            "url": "{{baseUrl}}/health"
          }
        },
        {
          "name": "Detailed Health",
          "request": {
            "method": "GET",
            "url": "{{baseUrl}}/health/detailed"
          }
        }
      ]
    },
    {
      "name": "Sessions",
      "item": [
        {
          "name": "List Sessions",
          "request": {
            "method": "GET",
            "url": "{{baseUrl}}/api/sessions"
          }
        },
        {
          "name": "Create Session",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}/api/sessions",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"id\": \"{{sessionId}}\",\n  \"name\": \"My Session\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Get Session",
          "request": {
            "method": "GET",
            "url": "{{baseUrl}}/api/sessions/{{sessionId}}"
          }
        },
        {
          "name": "Get QR Code",
          "request": {
            "method": "GET",
            "url": "{{baseUrl}}/api/sessions/{{sessionId}}/qr"
          }
        },
        {
          "name": "Delete Session",
          "request": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/sessions/{{sessionId}}"
          }
        }
      ]
    },
    {
      "name": "Messages",
      "item": [
        {
          "name": "Send Text Message",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}/api/sessions/{{sessionId}}/messages",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"phone\": \"628123456789@c.us\",\n  \"type\": \"text\",\n  \"body\": \"Hello from OpenWA!\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Send Image (URL)",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}/api/sessions/{{sessionId}}/messages",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"phone\": \"628123456789@c.us\",\n  \"type\": \"image\",\n  \"media\": {\n    \"url\": \"https://example.com/image.jpg\"\n  },\n  \"caption\": \"Check this out!\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Get Message History",
          "request": {
            "method": "GET",
            "url": {
              "raw": "{{baseUrl}}/api/sessions/{{sessionId}}/messages?phone=628123456789@c.us&limit=50",
              "host": ["{{baseUrl}}"],
              "path": ["api", "sessions", "{{sessionId}}", "messages"],
              "query": [
                {"key": "phone", "value": "628123456789@c.us"},
                {"key": "limit", "value": "50"}
              ]
            }
          }
        }
      ]
    }
  ]
}

Download: openwa-postman-collection.json

07.10 cURL Examples Collection

#!/bin/bash
# openwa-curl-examples.sh

BASE_URL="http://localhost:2785"
API_KEY="your-api-key"
SESSION_ID="default"

# Health Check
echo "=== Health Check ==="
curl -s "$BASE_URL/health" | jq

# Create Session
echo "=== Create Session ==="
curl -s -X POST "$BASE_URL/api/sessions" \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"id\": \"$SESSION_ID\", \"name\": \"Test Session\"}" | jq

# Get QR Code
echo "=== Get QR Code ==="
curl -s "$BASE_URL/api/sessions/$SESSION_ID/qr" \
  -H "X-API-Key: $API_KEY" | jq -r '.data.qr'

# Send Text Message
echo "=== Send Text Message ==="
curl -s -X POST "$BASE_URL/api/sessions/$SESSION_ID/messages" \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "628123456789@c.us",
    "type": "text",
    "body": "Hello from cURL!"
  }' | jq

# Send Image
echo "=== Send Image ==="
curl -s -X POST "$BASE_URL/api/sessions/$SESSION_ID/messages" \
  -H "X-API-Key: $API_KEY" \
  -F "phone=628123456789@c.us" \
  -F "type=image" \
  -F "media=@./test-image.jpg" \
  -F "caption=Uploaded via cURL" | jq

# Get Contacts
echo "=== Get Contacts ==="
curl -s "$BASE_URL/api/sessions/$SESSION_ID/contacts" \
  -H "X-API-Key: $API_KEY" | jq

# Get Groups
echo "=== Get Groups ==="
curl -s "$BASE_URL/api/sessions/$SESSION_ID/groups" \
  -H "X-API-Key: $API_KEY" | jq

# Create Webhook
echo "=== Create Webhook ==="
curl -s -X POST "$BASE_URL/api/sessions/$SESSION_ID/webhooks" \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhook",
    "events": ["message.received", "message.ack"]
  }' | jq