WasenderApi API

API Documentation

WasenderApi WhatsApp API

API Documentation

Getting Started

Kick off your integration with WasenderAPI in minutes. This section guides you through the essentials — from generating your API token to establishing your first WhatsApp session and sending your first message.

Getting Started with WasenderAPI

Learn how to quickly set up your WasenderAPI account and start sending WhatsApp messages in minutes. This guide covers account creation, token generation, sending your first message, and tracking delivery using our developer-friendly REST API.

How To Receive Messages and Media From Wasenderapi

A developer's guide to receiving and processing real-time message events from the WASenderAPI. This documentation details the JSON payload for the messages.upsert event, covering text messages, media handling, and the required media decryption process.

Developer SDKs

Platform-specific SDKs to help you seamlessly connect with our API using minimal boilerplate.

Official SDKs – Node.js, Python & Laravel

WasenderAPI provides official SDKs to help developers integrate quickly and efficiently using their preferred programming language or framework.

Authentication

Learn how to authenticate your API requests using the Bearer Token. This token is generated through the session management screen once the session is successfully connected.

How to Authenticate API Requests Using Bearer Tokens

This guide explains how to authenticate API requests using a Bearer Token, generated after connecting your WhatsApp session through the Session Management screen.

How to Authenticate API Requests Using Personal Access Token

This guide explains how to authenticate API requests using a Bearer Token, generated from your settings - personal access token page.

Sessions

Manage WhatsApp device connections through sessions. A session represents a single WhatsApp account linked to the system. Use this section to create, restore, logout, or delete sessions, as well as scan QR codes for authentication.

Get WhatsApp Session Details

GET/api/whatsapp-sessions/{whatsappSession}

Retrieves details for a specific WhatsApp session.

Get All WhatsApp Sessions

GET/api/whatsapp-sessions

Retrieves a list of all WhatsApp sessions available to the authenticated user.

Create WhatsApp Session

POST/api/whatsapp-sessions

Creates a new WhatsApp session with the provided details. Requires an active subscription and is subject to session limits.

Regenerate API Key

POST/api/whatsapp-sessionsv/{whatsappSession}/regenerate-key

Regenerates the API key for a specific WhatsApp session.

Disconnect WhatsApp Session

POST/api/whatsapp-sessions/{whatsappSession}/disconnect

Disconnects an active WhatsApp session.

Get WhatsApp Session QR Code

GET/api/whatsapp-sessions/{whatsappSession}/qrcode

Retrieves the QR code needed to connect a WhatsApp session with the WhatsApp client. Requires an active subscription.

Connect WhatsApp Session

POST/api/whatsapp-sessions/{whatsappSession}/connect

Initiates the connection process for a WhatsApp session. Requires an active subscription.

Delete WhatsApp Session

DELETE/api/whatsapp-sessions/{whatsappSession}

Deletes a specific WhatsApp session. If the session is connected, it will attempt to disconnect from the WhatsApp API server first.

Update WhatsApp Session

PUT/api/whatsapp-sessions/{whatsappSession}

Updates details for a specific WhatsApp session. If the session is connected, webhook settings will be synced with the WhatsApp API server.

Get Session User Info

GET/api/user

Retrieves information about the WhatsApp user associated with the current API key session.

Get WhatsApp Session Status

GET/api/status

Returns the current status of the connected WhatsApp session.

Check if a number is on WhatsApp

GET/api/on-whatsapp/{jid}

Verifies if a given JID (WhatsApp ID) is registered on WhatsApp.

Messages

Send and manage WhatsApp messages using active sessions. This category covers various message types including text, image, video, audio, document, location, contact cards,

Decrypt Media File

POST/api/decrypt-media

This endpoint is used to decrypt media files sent in messages. You need to provide the encrypted media information, including the mediaKey and the url where the encrypted file is hosted. The API will then decrypt the file and store it temporarily, returning a publicUrl from which the decrypted file can be downloaded. This public URL will be active for one hour.

Send Text Message

POST/api/send-message

Sends a plain text message to a recipient.

Send Image Message

POST/api/send-message

Sends a message with an image attached via a URL.

Send Video Message

POST/api/send-message

Sends a message with a video attached via a URL.

Send Document Message

POST/api/send-message

Sends a message with a document attached via a URL.

Send Audio Message

POST/api/send-message

Sends a message with an audio file attached via a URL.

Send Sticker Message

POST/api/send-message

Sends a message with a sticker attached via a URL (supports .webp format).

Send Contact Card

POST/api/send-message

Sends a message containing a contact card.

Send Location

POST/api/send-message

Sends a message containing a location pin.

Send Quoted Message

POST/api/send-message

Sends a message that quotes or replies to a previous message. This is useful for creating conversational context.

Send Poll Message (beta)

POST/api/send-message

Sends a message containing a poll with multi select support.

Edit a Message

PUT/api/messages/{msgId}

Edits the text content of a previously sent message. Note: This is usually only possible for a short period after the message was sent.

Get Message Info

GET/api/messages/{msgId}/info

Retrieves detailed information about a specific message, such as its content, sender, receiver, status and timestamps.

Delete a Message

DELETE/api/messages/{msgId}

Deletes a specific message for everyone. Note: This is usually only possible for a short period after the message was sent.

Contacts

Endpoints for managing WhatsApp contacts.

Get All Contacts

GET/api/contacts

Retrieves a list of all contacts synced with the WhatsApp session.

Get Contact Info

GET/api/contacts/{contactPhoneNumber}

Retrieves detailed information for a specific contact.

Get Contact Profile Picture

GET/api/contacts/{contactPhoneNumber}/picture

Retrieves the URL of the profile picture for a specific contact.

Block Contact

POST/api/contacts/{contactPhoneNumber}/block

Blocks a specific contact.

Unblock Contact

POST/api/contacts/{contactPhoneNumber}/unblock

Unblocks a specific contact.

Groups

Manage WhatsApp groups directly from your connected sessions. This includes creating groups, retrieving group details, adding or removing participants, and sending messages to group chats.

Create a new group

POST/api/groups

Creates a new WhatsApp group with a given name and a list of participants.

Get All Groups

GET/api/groups

Retrieves a list of all WhatsApp groups the connected account is a member of.

Send Group Message

POST/api/send-message

Sends a message to a specific WhatsApp group using its Group ID.

Get Group Metadata

GET/api/groups/{groupJid}/metadata

Retrieves metadata for a specific group (e.g., subject, description, creation date, owner).

Get Group Participants

GET/api/groups/{groupJid}/participants

Retrieves a list of participants for a specific group. Warning: If the list is empty, it may mean no participants are currently synced or available, or the initial sync is still in progress. If you connected your session before 5/8/2025, you must reconnect it to sync them correctly.

Add Group Participants

POST/api/groups/{groupJid}/participants/add

Adds participants to a specific group. Requires admin privileges in the group.

Remove Group Participants

POST/api/groups/{groupJid}/participants/remove

Removes participants from a specific group. Requires admin privileges in the group.

Update Group Settings

PUT/api/groups/{groupJid}/settings

Updates settings for a specific group (e.g., subject, description, announce mode, restrict mode). Requires admin privileges.

Channels (Communities)

Manage WhatsApp Communities and their linked groups (also known as announcement channels). This section allows you to create communities, add groups to them, and control communication within a larger organized structure.

Send Channel Message

POST/api/send-message

Sends a message to a specific WhatsApp channel using its Channel ID.

Webhooks

Receive real-time updates and events from your WhatsApp sessions through webhooks. This includes incoming messages, message status updates (sent, delivered, read), group events, and session changes.

Webhook: Group Update

Triggered for other group-related updates, such as changes to group settings like announce mode or restrict mode by an admin.

Webhook: Group Participants Update

Triggered when participants are added, removed, promoted, or demoted in a group.

Webhook: Contact Upsert

Triggered when a new contact is added or an existing contact is updated in your session's contact list.

Webhook: Contact Update

Triggered for other contact updates, such as a contact changing their profile picture or status (if available).

Webhook Setup

POST/your-webhook-url

How to set up and verify webhooks to receive real-time events.

Webhook: Chat Update

Triggered when properties of a chat are updated (e.g., unread count, mute status).

Webhook: Group Upsert

Triggered when your session joins a new group or when metadata of an existing group (subject, description, etc.) is updated.

Webhook: Message Sent

Event triggered when a message is successfully sent from your session.

Webhook: Chat Delete

Triggered when a chat is deleted.

Webhook: Chat Upsert

Triggered when a chat is created or updated (e.g., new message, read status change).

Webhook: Session Status

Event triggered when the connection status of your WhatsApp session changes.

Webhook: QR Code Updated

Event triggered when a new QR code is generated for linking your session.

Webhook: Message Upsert

Event triggered when a new message is received in your session.

Webhook: Message Status Update

Event triggered when a message's status is updated (e.g., delivered, read).

Webhook: Message Deleted

Event triggered when a message is deleted.

Webhook: Message Receipt Update

Event triggered specifically for message receipt status changes.

Webhook: Message Reaction

Event triggered when someone reacts to a message.

Responses & Errors

Understand the structure of API responses and how to handle errors effectively. This section outlines standard success responses, common error formats, status codes, and tips for debugging failed requests.

Response Headers

Information about standard headers included in API responses, particularly rate limiting.

Error Responses

Common error responses returned by the API.

Rate Limits

Learn how API rate limiting works to ensure fair usage and system stability. This section explains the allowed number of requests per time window, how to identify throttling, and how to handle rate limit responses.

Understanding Rate Limits

Details on the rate limits applied to API requests based on subscription plans.