SwiftWA
This API serves as a WhatsApp shared gateway, designed to streamline communication. With each request, you'll send the payload akin to a WhatsApp message. Recipients can include groups managed by you, supporting various payload types such as text, images, audio, vCards, files, and more—essentially anything a WhatsApp official client can handle.
SwiftWA endpoints
| Method | Endpoint | Description |
|---|---|---|
| Public | ||
| GET |
/api/health /api/health |
Check if API is running |
| Sessions | ||
| GET |
/api/whatsapp/sessions/{sessionId}/status /api/whatsapp/sessions/{sessionId}/status |
Get detailed status of your WhatsApp session |
| POST |
/api/whatsapp/sessions/{sessionId}/connect /api/whatsapp/sessions/{sessionId}/connect |
Connect or create a WhatsApp session |
| GET |
/api/whatsapp/sessions/{sessionId}/qr /api/whatsapp/sessions/{sessionId}/qr |
Get QR code for authenticating your WhatsApp session |
| Messaging | ||
| POST |
/api/whatsapp/chats/send-poll /api/whatsapp/chats/send-poll |
Send a poll from your WhatsApp session |
| POST |
/api/whatsapp/chats/send-text /api/whatsapp/chats/send-text |
Send a text message from your WhatsApp session |
| POST |
/api/whatsapp/chats/check-number /api/whatsapp/chats/check-number |
Check if a phone number is registered on WhatsApp |
| POST |
/api/whatsapp/chats/send-contact /api/whatsapp/chats/send-contact |
Send a contact card from your WhatsApp session |
| POST |
/api/whatsapp/chats/presence /api/whatsapp/chats/presence |
Send typing/recording indicator from your WhatsApp session |
| POST |
/api/whatsapp/chats/send-document /api/whatsapp/chats/send-document |
Send a document from your WhatsApp session |
| POST |
/api/whatsapp/chats/send-audio /api/whatsapp/chats/send-audio |
Send an audio file from your WhatsApp session (OGG format only) |
| POST |
/api/whatsapp/chats/send-location /api/whatsapp/chats/send-location |
Send a location from your WhatsApp session |
| POST |
/api/whatsapp/chats/send-image /api/whatsapp/chats/send-image |
Send an image from your WhatsApp session |
| Bulk Messaging | ||
| POST |
/api/whatsapp/chats/send-bulk /api/whatsapp/chats/send-bulk |
Send the same text message to multiple recipients from your session |
| GET |
/api/whatsapp/chats/bulk-status/{jobId} /api/whatsapp/chats/bulk-status/{jobId} |
Check the status of your bulk messaging job |
| Chats | ||
| POST |
/api/whatsapp/chats/messages /api/whatsapp/chats/messages |
Get messages from your specific chat |
| POST |
/api/whatsapp/contacts /api/whatsapp/contacts |
Get all contacts from your WhatsApp |
| POST |
/api/whatsapp/chats/profile-picture /api/whatsapp/chats/profile-picture |
Get profile picture URL of your contact |
| POST |
/api/whatsapp/chats/mark-read /api/whatsapp/chats/mark-read |
Mark all unread messages in your chat as read |
| POST |
/api/whatsapp/chats/overview /api/whatsapp/chats/overview |
Get list of your chats with last message |
| POST |
/api/whatsapp/chats/contact-info /api/whatsapp/chats/contact-info |
Get detailed information about your contact |
| Groups | ||
| POST |
/api/whatsapp/groups/{sessionId}/join /api/whatsapp/groups/{sessionId}/join |
Join a group using invite code |
| POST |
/api/whatsapp/groups/{sessionId}/{groupId}/participants/remove /api/whatsapp/groups/{sessionId}/{groupId}/participants/remove |
Remove participants from your group |
| GET |
/api/whatsapp/groups/{sessionId}/{groupId}/metadata /api/whatsapp/groups/{sessionId}/{groupId}/metadata |
Get detailed information about your group |
| POST |
/api/whatsapp/groups/{sessionId}/list /api/whatsapp/groups/{sessionId}/list |
Get all groups from your WhatsApp session |
| POST |
/api/whatsapp/groups/{sessionId}/{groupId}/participants/add /api/whatsapp/groups/{sessionId}/{groupId}/participants/add |
Add participants to your group |
| POST |
/api/whatsapp/groups/{sessionId}/create /api/whatsapp/groups/{sessionId}/create |
Create a new WhatsApp group from your session |
| POST |
/api/whatsapp/groups/{sessionId}/{groupId}/leave /api/whatsapp/groups/{sessionId}/{groupId}/leave |
Leave a WhatsApp group |
| Webhooks | ||
| POST |
/api/whatsapp/sessions/{sessionId}/webhooks /api/whatsapp/sessions/{sessionId}/webhooks |
Add a new webhook to your session |
| DELETE |
/api/whatsapp/sessions/{sessionId}/webhooks /api/whatsapp/sessions/{sessionId}/webhooks |
Remove a webhook from your session |
SwiftWA pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | 5 / minute |
|
| PRO | $2.99 / month | 60 / minute |
|
| ULTRA | $9.99 / month | 120 / minute |
|
| MEGA | $15.99 / month | 300 / minute |
|