WasenderAPI

https://wasenderapi.com/api-docs
Admin
WasenderAPI is a WhatsApp API platform that enables developers to send and receive messages, manage...
Tokens:23,559
Snippets:277
Trust Score:7.1
Update:1 week ago
Show doc for...
Tokens:
Raw
### qrcode.updated webhook payload example

Source: https://wasenderapi.com/api-docs/webhooks/webhook-qrcode-updated

Example JSON payload for the qrcode.updated webhook event. Contains the event name, session ID, and a data object with the QR string. Use a QR code library to generate an image from the QR string.

```json
{
  "event": "qrcode.updated",
  "sessionId": "YOUR_SESSION_API_KEY",
  "data": {
    "qr": "2@67576ghf/RMXr8A2IP3/...", // This is the QR string. Use a QR code library to generate an image.
  }
}
```

--------------------------------

### session.status webhook payload example

Source: https://wasenderapi.com/api-docs/webhooks/webhook-session-status

Example JSON payload for the session.status webhook event. Contains the event name, session ID (using YOUR_SESSION_API_KEY placeholder), and the new status in the data object.

```json
{
  "event": "session.status",
  "sessionId": "YOUR_SESSION_API_KEY",
  "data": {
    "status": "need_passkey"
  }
}
```

--------------------------------

### Webhook Setup

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## Webhook Setup

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

### Method
POST

### Endpoint
/your-webhook-url
```

--------------------------------

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

Source: https://wasenderapi.com/api-docs

Retrieves details for a specific WhatsApp session.

```APIDOC
## GET /api/whatsapp-sessions/{whatsappSession}

### Description
Retrieves details for a specific WhatsApp session.

### Method
GET

### Endpoint
/api/whatsapp-sessions/{whatsappSession}

### Parameters
#### Path Parameters
- **whatsappSession** (string) - Required - The identifier of the WhatsApp session.

### Response
#### Success Response (200)
- **session** (object) - The WhatsApp session details.

#### Response Example
{
  "session": {}
}
```

--------------------------------

### GET /api/whatsapp-sessions/{whatsappSession}/session-logs

Source: https://wasenderapi.com/api-docs

Retrieves a paginated list of session activity logs.

```APIDOC
## GET /api/whatsapp-sessions/{whatsappSession}/session-logs

### Description
Retrieves a paginated list of session activity logs.

### Method
GET

### Endpoint
/api/whatsapp-sessions/{whatsappSession}/session-logs

### Parameters
#### Path Parameters
- **whatsappSession** (string) - Required - The identifier of the WhatsApp session.

#### Query Parameters
- **page** (integer) - Optional - Page number for pagination.

### Response
#### Success Response (200)
- **logs** (array) - List of session logs.
- **pagination** (object) - Pagination details.

#### Response Example
{
  "logs": [],
  "pagination": {}
}
```

--------------------------------

### Create or Update Contact - Success Response

Source: https://wasenderapi.com/api-docs/contacts/create-or-update-contact

Example success response showing the created or updated contact's JID and full name.

```json
{
    "success": true,
    "data": {
        "jid": "1234567890@s.whatsapp.net",
        "fullName": "John Doe"
    }
}
```

--------------------------------

### GET /api/fetch-username/{contact_identifier}

Source: https://wasenderapi.com/api-docs

Fetches WhatsApp username metadata for a contact.

```APIDOC
## GET /api/fetch-username/{contact_identifier}

### Description
Fetches WhatsApp username metadata for a contact.

### Method
GET

### Endpoint
/api/fetch-username/{contact_identifier}

### Parameters
#### Path Parameters
- **contact_identifier** (string) - Required - The phone number, WhatsApp JID, or username handle.

### Response
#### Success Response (200)
- **username** (string) - The WhatsApp username metadata.

#### Response Example
{
  "username": "..."
}
```

--------------------------------

### GET /api/groups/invite/{inviteCode}

Source: https://wasenderapi.com/api-docs

Retrieves metadata for a group from its invite code.

```APIDOC
## GET /api/groups/invite/{inviteCode}

### Description
Retrieves metadata for a group from its invite code.

### Method
GET

### Endpoint
/api/groups/invite/{inviteCode}

### Parameters
#### Path Parameters
- **inviteCode** (string) - Required - The invite code of the group.

```

--------------------------------

### Success Response for Block Contact

Source: https://wasenderapi.com/api-docs/contacts/block-contact

Example JSON response indicating the contact was blocked successfully.

```json
{
    "success": true,
    "data": {
        "message": "Contact blocked"
    }
}
```

--------------------------------

### GET /api/passkey/pending

Source: https://wasenderapi.com/api-docs

Advanced helper endpoint used to fetch WhatsApp WebAuthn publicKey options and inspect the current Passkey request status.

```APIDOC
## GET /api/passkey/pending

### Description
Advanced helper endpoint used to fetch WhatsApp WebAuthn publicKey options and inspect the current Passkey request status.

### Method
GET

### Endpoint
/api/passkey/pending

### Response
#### Success Response (200)
- **publicKeyOptions** (object) - WebAuthn publicKey options.
- **status** (string) - Current Passkey request status.

#### Response Example
{
  "publicKeyOptions": {},
  "status": "pending"
}
```

--------------------------------

### GET /api/status

Source: https://wasenderapi.com/api-docs

Returns the current status of the WhatsApp session, including QR and Passkey linking states.

```APIDOC
## GET /api/status

### Description
Returns the current status of the WhatsApp session, including QR and Passkey linking states.

### Method
GET

### Endpoint
/api/status

### Response
#### Success Response (200)
- **status** (object) - The current session status.

#### Response Example
{
  "status": {}
}
```

--------------------------------

### messages.received webhook payload example

Source: https://wasenderapi.com/api-docs/webhooks/webhook-message-received

Example JSON payload for the messages.received webhook event. The payload includes the event name, timestamp, and data object containing message details such as key, messageBody, and message content. Note the comment about addressingMode and senderLid.

```json
{
  "event": "messages.received",
  "timestamp": 1633456789,
  "data": {
    "messages": 
      {
        "key": {
          "id": "3EB0X123456789",
          "fromMe": false,
          "remoteJid": "1234567890@s.whatsapp.net", // could also be 555555555@lid based on the addressingMode
          "addressingMode": "pn", 
          "senderPn": "1234567890@s.whatsapp.net",
          "cleanedSenderPn": "1234567890",
          "senderLid": "555555555@lid"
        },
        "messageBody": "Hello, I have a question",
        "message": {
          "conversation": "Hello, I have a question"
        }
      }
  }
}
```

--------------------------------

### GET /api/whatsapp-sessions

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## GET /api/whatsapp-sessions

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

### Method
GET

### Endpoint
/api/whatsapp-sessions

### Response
#### Success Response (200)
- **sessions** (array) - List of WhatsApp sessions.

#### Response Example
{
  "sessions": []
}
```

--------------------------------

### GET /api/whatsapp-sessions/{whatsappSession}/passkey-token

Source: https://wasenderapi.com/api-docs

Retrieves the temporary Passkey token and explains the recommended API flow using the Device Link Helper Chrome extension.

```APIDOC
## GET /api/whatsapp-sessions/{whatsappSession}/passkey-token

### Description
Retrieves the temporary Passkey token and explains the recommended API flow using the Device Link Helper Chrome extension.

### Method
GET

### Endpoint
/api/whatsapp-sessions/{whatsappSession}/passkey-token

### Parameters
#### Path Parameters
- **whatsappSession** (string) - Required - The identifier of the WhatsApp session.

### Response
#### Success Response (200)
- **token** (string) - The temporary Passkey token.

#### Response Example
{
  "token": "..."
}
```

--------------------------------

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

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## GET /api/whatsapp-sessions/{whatsappSession}/qrcode

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

### Method
GET

### Endpoint
/api/whatsapp-sessions/{whatsappSession}/qrcode

### Parameters
#### Path Parameters
- **whatsappSession** (string) - Required - The identifier of the WhatsApp session.

### Response
#### Success Response (200)
- **qrcode** (string) - The QR code data.

#### Response Example
{
  "qrcode": "data:image/png;base64,..."
}
```

--------------------------------

### GET /api/on-whatsapp/{contact_identifier}

Source: https://wasenderapi.com/api-docs

Verifies if a given phone number, WhatsApp JID, or username handle is registered on WhatsApp.

```APIDOC
## GET /api/on-whatsapp/{contact_identifier}

### Description
Verifies if a given phone number, WhatsApp JID, or username handle is registered on WhatsApp.

### Method
GET

### Endpoint
/api/on-whatsapp/{contact_identifier}

### Parameters
#### Path Parameters
- **contact_identifier** (string) - Required - The phone number, WhatsApp JID, or username handle to check.

### Response
#### Success Response (200)
- **onWhatsApp** (boolean) - Whether the contact is on WhatsApp.

#### Response Example
{
  "onWhatsApp": true
}
```

--------------------------------

### GET /api/contacts

Source: https://wasenderapi.com/api-docs/contacts

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

```APIDOC
## GET /api/contacts

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

### Method
GET

### Endpoint
/api/contacts
```

--------------------------------

### GET /api/whatsapp-sessions/{whatsappSession}/message-logs

Source: https://wasenderapi.com/api-docs

Retrieves a paginated list of message logs for a specific session.

```APIDOC
## GET /api/whatsapp-sessions/{whatsappSession}/message-logs

### Description
Retrieves a paginated list of message logs for a specific session.

### Method
GET

### Endpoint
/api/whatsapp-sessions/{whatsappSession}/message-logs

### Parameters
#### Path Parameters
- **whatsappSession** (string) - Required - The identifier of the WhatsApp session.

#### Query Parameters
- **page** (integer) - Optional - Page number for pagination.

### Response
#### Success Response (200)
- **logs** (array) - List of message logs.
- **pagination** (object) - Pagination details.

#### Response Example
{
  "logs": [],
  "pagination": {}
}
```

--------------------------------

### GET /api/user

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## GET /api/user

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

### Method
GET

### Endpoint
/api/user

### Response
#### Success Response (200)
- **user** (object) - The WhatsApp user information.

#### Response Example
{
  "user": {}
}
```

--------------------------------

### Success response for send channel message

Source: https://wasenderapi.com/api-docs/channels-communities/send-channel-message

Example of a successful response from the send-message endpoint. The response includes a success flag, a message ID, the JID, and the status 'in_progress'.

```json
{
  "success": true,
  "data": {
    "msgId": 100000,
    "jid": "+123456789",
    "status": "in_progress"
  }
}
```

--------------------------------

### GET /api/groups

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## GET /api/groups

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

### Method
GET

### Endpoint
/api/groups

```

--------------------------------

### GET /api/contacts/{contactPhoneNumber}

Source: https://wasenderapi.com/api-docs/contacts

Retrieves detailed information for a specific contact.

```APIDOC
## GET /api/contacts/{contactPhoneNumber}

### Description
Retrieves detailed information for a specific contact.

### Method
GET

### Endpoint
/api/contacts/{contactPhoneNumber}

### Parameters
#### Path Parameters
- **contactPhoneNumber** (string) - Required - The phone number of the contact.
```

--------------------------------

### GET /api/groups/{groupJid}/invite-link

Source: https://wasenderapi.com/api-docs

This endpoint retrieves the invite link for a specific WhatsApp group.

```APIDOC
## GET /api/groups/{groupJid}/invite-link

### Description
This endpoint retrieves the invite link for a specific WhatsApp group.

### Method
GET

### Endpoint
/api/groups/{groupJid}/invite-link

### Parameters
#### Path Parameters
- **groupJid** (string) - Required - The JID of the group.

```

--------------------------------

### GET /api/groups/{groupJid}/picture

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## GET /api/groups/{groupJid}/picture

### Description
Retrieves the URL of the profile picture for a specific group.

### Method
GET

### Endpoint
/api/groups/{groupJid}/picture

### Parameters
#### Path Parameters
- **groupJid** (string) - Required - The JID of the group.

```

--------------------------------

### GET /api/groups/{groupJid}/participants

Source: https://wasenderapi.com/api-docs

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.

```APIDOC
## GET /api/groups/{groupJid}/participants

### Description
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.

### Method
GET

### Endpoint
/api/groups/{groupJid}/participants

### Parameters
#### Path Parameters
- **groupJid** (string) - Required - The JID of the group.

```

--------------------------------

### GET /api/groups/{groupJid}/metadata

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## GET /api/groups/{groupJid}/metadata

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

### Method
GET

### Endpoint
/api/groups/{groupJid}/metadata

### Parameters
#### Path Parameters
- **groupJid** (string) - Required - The JID of the group.

```

--------------------------------

### GET /api/messages/{msgId}/info

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## GET /api/messages/{msgId}/info

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

### Method
GET

### Endpoint
/api/messages/{msgId}/info
```

--------------------------------

### Express.js webhook endpoint with signature verification

Source: https://wasenderapi.com/api-docs/webhooks/webhook-setup

Example webhook endpoint in Express.js that verifies the X-Webhook-Signature header against a stored secret, handles different event types, and responds with 200 OK.

```javascript
// Example webhook endpoint in Express.js
const express = require('express');
const crypto = require('crypto');
const app = express();

app.use(express.json());

// Verify webhook signature to ensure it's from WasenderApi
function verifySignature(req) {
    const signature = req.headers['x-webhook-signature'];
    const webhookSecret = 'YOUR_WEBHOOK_SECRET'; // Store securely
    if (!signature || !webhookSecret || signature !== webhookSecret) return false;
    return true;
}

app.post('/webhook', (req, res) => {
    if (!verifySignature(req)) {
        return res.status(401).json({ error: 'Invalid signature' });
    }

    const payload = req.body;
    console.log('Received webhook event:', payload.event);

    // Handle different event types (e.g., message.sent, session.status)
    switch (payload.event) {
        case 'messages.upsert':
            console.log('New message received:', payload.data.key.id);
            // Process the incoming message
            break;
        // Add other cases
    }

    res.status(200).json({ received: true });
});

app.listen(3000, () => {
    console.log('Webhook server listening on port 3000');
});
```

--------------------------------

### messages.update webhook payload example

Source: https://wasenderapi.com/api-docs/webhooks/webhook-message-update

JSON payload structure for the messages.update webhook event. Contains the event name, session ID, update status, message key, and timestamp.

```json
{
  "event": "messages.update",
  "sessionId": "your_api_key",
  "data": {
    "update": {
      "status": 2
    },
    "key": {
      "remoteJid": "123456789@s.whatsapp.net",
      "id": "34874643876",
      "fromMe": false
    }
  },
  "timestamp": 1747775431467
}
```

--------------------------------

### Poll Results Webhook Payload (JSON)

Source: https://wasenderapi.com/api-docs/webhooks/webhook-poll-results

Example payload for the poll.results webhook. Contains event, sessionId, data with key and pollResult array, and timestamp. The pollResult array lists each option with its name and an array of voter IDs.

```json
{
  "event": "poll.results",
  "sessionId": "YOUR_SESSION_API_KEY",
  "data": {
    "key": {
      "remoteJid": "123456789@s.whatsapp.net",
      "fromMe": true,
      "id": "FZNABLUGNI0F3QIJSWPW7H"
    },
    "pollResult": [
      {
        "name": "Pizza",
        "voters": [
          "123456789@s.whatsapp.net"
    ]
      },
      {
        "name": "Humberger",
        "voters": []
      }
    ]
  },
  "timestamp": 1753278982097
}
```

--------------------------------

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

Source: https://wasenderapi.com/api-docs

Initiates the connection process for a WhatsApp session using QR code or Passkey. QR is the default method.

```APIDOC
## POST /api/whatsapp-sessions/{whatsappSession}/connect

### Description
Initiates the connection process for a WhatsApp session using QR code or Passkey. QR is the default method.

### Method
POST

### Endpoint
/api/whatsapp-sessions/{whatsappSession}/connect

### Parameters
#### Path Parameters
- **whatsappSession** (string) - Required - The identifier of the WhatsApp session.

### Response
#### Success Response (200)
- **status** (string) - Connection initiation status.

#### Response Example
{
  "status": "connecting"
}
```

--------------------------------

### POST /api/whatsapp-sessions

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## POST /api/whatsapp-sessions

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

### Method
POST

### Endpoint
/api/whatsapp-sessions

### Parameters
#### Request Body
- **details** (object) - Required - Details of the WhatsApp session to create.

### Request Example
{
  "details": {}
}

### Response
#### Success Response (201)
- **session** (object) - The created WhatsApp session.

#### Response Example
{
  "session": {}
}
```

--------------------------------

### POST /api/upload

Source: https://wasenderapi.com/api-docs

Uploads a media file, supporting both raw binary and Base64-encoded uploads.

```APIDOC
## POST /api/upload

### Description
This endpoint uploads media files. It supports both raw binary and Base64-encoded file uploads.

### Method
POST

### Endpoint
/api/upload
```

--------------------------------

### POST /api/whatsapp-sessions/{whatsappSession}/restart

Source: https://wasenderapi.com/api-docs

Restarts a specific, currently connected WhatsApp session.

```APIDOC
## POST /api/whatsapp-sessions/{whatsappSession}/restart

### Description
Restarts a specific, currently connected WhatsApp session.

### Method
POST

### Endpoint
/api/whatsapp-sessions/{whatsappSession}/restart

### Parameters
#### Path Parameters
- **whatsappSession** (string) - Required - The identifier of the WhatsApp session.

### Response
#### Success Response (200)
- **status** (string) - Restart status.

#### Response Example
{
  "status": "restarted"
}
```

--------------------------------

### GET /api/contacts/{contactPhoneNumber}/picture

Source: https://wasenderapi.com/api-docs/contacts

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

```APIDOC
## GET /api/contacts/{contactPhoneNumber}/picture

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

### Method
GET

### Endpoint
/api/contacts/{contactPhoneNumber}/picture

### Parameters
#### Path Parameters
- **contactPhoneNumber** (string) - Required - The phone number of the contact.
```

--------------------------------

### POST /api/groups

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## POST /api/groups

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

### Method
POST

### Endpoint
/api/groups

```

--------------------------------

### POST /your-webhook-url

Source: https://wasenderapi.com/api-docs/webhooks/webhook-setup

Webhook endpoint that receives real-time events from WasenderApi. Must respond with 200 OK to acknowledge receipt. Verify the X-Webhook-Signature header to ensure the request is genuine.

```APIDOC
## POST /your-webhook-url

### Description
Webhook endpoint that receives real-time events from WasenderApi. Must respond with 200 OK to acknowledge receipt. Verify the X-Webhook-Signature header to ensure the request is genuine.

### Method
POST

### Endpoint
/your-webhook-url

### Parameters
#### Headers
- **X-Webhook-Signature** (string) - Required - Secret key used to verify the webhook came from WasenderApi.
- **Content-Type** (string) - Required - Should be `application/json`.

### Request Example
```json
{
  "event": "messages.upsert",
  "data": {
    "key": {
      "id": "message-id"
    }
  }
}
```

### Response
#### Success Response (200)
- **received** (boolean) - Indicates the webhook was received.

#### Response Example
```json
{
  "received": true
}
```

### Error Handling
- **401 Unauthorized** - Returned if the X-Webhook-Signature header does not match the webhook secret.

### Code Example (JavaScript)
```javascript
const express = require('express');
const crypto = require('crypto');
const app = express();

app.use(express.json());

// Verify webhook signature to ensure it's from WasenderApi
function verifySignature(req) {
    const signature = req.headers['x-webhook-signature'];
    const webhookSecret = 'YOUR_WEBHOOK_SECRET'; // Store securely
    if (!signature || !webhookSecret || signature !== webhookSecret) return false;
    return true;
}

app.post('/webhook', (req, res) => {
    if (!verifySignature(req)) {
        return res.status(401).json({ error: 'Invalid signature' });
    }

    const payload = req.body;
    console.log('Received webhook event:', payload.event);

    // Handle different event types (e.g., message.sent, session.status)
    switch (payload.event) {
        case 'messages.upsert':
            console.log('New message received:', payload.data.key.id);
            // Process the incoming message
            break;
        // Add other cases
    }

    res.status(200).json({ received: true });
});

app.listen(3000, () => {
    console.log('Webhook server listening on port 3000');
});
```
```

--------------------------------

### POST /api/passkey/confirm

Source: https://wasenderapi.com/api-docs

Advanced helper endpoint used to confirm a Passkey linking request. Most API integrations should use the Device Link Helper manual token flow instead.

```APIDOC
## POST /api/passkey/confirm

### Description
Advanced helper endpoint used to confirm a Passkey linking request. Most API integrations should use the Device Link Helper manual token flow instead.

### Method
POST

### Endpoint
/api/passkey/confirm

### Parameters
#### Request Body
- **confirmation** (object) - Required - The confirmation details.

### Request Example
{
  "confirmation": {}
}

### Response
#### Success Response (200)
- **status** (string) - Confirmation status.

#### Response Example
{
  "status": "confirmed"
}
```

--------------------------------

### POST /api/groups/invite/accept

Source: https://wasenderapi.com/api-docs

Accept a group invitation using an invite code.

```APIDOC
## POST /api/groups/invite/accept

### Description
Accept a group invitation using an invite code.

### Method
POST

### Endpoint
/api/groups/invite/accept

```

--------------------------------

### GET /api/pn-from-lid/{lid}

Source: https://wasenderapi.com/api-docs/contacts

Retrieves the real phone number (PN) associated with a Link ID (LID).

```APIDOC
## GET /api/pn-from-lid/{lid}

### Description
Retrieves the real phone number (PN) associated with a Link ID (LID).

### Method
GET

### Endpoint
/api/pn-from-lid/{lid}

### Parameters
#### Path Parameters
- **lid** (string) - Required - The Link ID.
```

--------------------------------

### POST /api/send-message (Audio)

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## POST /api/send-message

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

### Method
POST

### Endpoint
/api/send-message
```

--------------------------------

### GET /api/lid-from-pn/{pn}

Source: https://wasenderapi.com/api-docs/contacts

Retrieves the Link ID (LID) associated with a real phone number (PN).

```APIDOC
## GET /api/lid-from-pn/{pn}

### Description
Retrieves the Link ID (LID) associated with a real phone number (PN).

### Method
GET

### Endpoint
/api/lid-from-pn/{pn}

### Parameters
#### Path Parameters
- **pn** (string) - Required - The real phone number.
```

--------------------------------

### POST /api/send-message (Video)

Source: https://wasenderapi.com/api-docs

Sends a message with a video attached via a URL.

```APIDOC
## POST /api/send-message

### Description
Sends a message with a video attached via a URL.

### Method
POST

### Endpoint
/api/send-message
```

--------------------------------

### POST /api/send-message (View Once)

Source: https://wasenderapi.com/api-docs

Sends an image, video, or audio message that can only be viewed a single time.

```APIDOC
## POST /api/send-message

### Description
Sends an image, video, or audio message that can only be viewed a single time.

### Method
POST

### Endpoint
/api/send-message
```

--------------------------------

### passkey.updated

Source: https://wasenderapi.com/api-docs/webhooks/webhook-passkey-updated

Triggered when a WhatsApp Passkey linking request changes stage. Use this webhook to track Passkey linking progress in real time.

```APIDOC
## Webhook Event: `passkey.updated`

### Description
Triggered when a WhatsApp Passkey linking request changes stage. This event is useful if your application wants to track Passkey linking progress in real time.

### Method
POST

### Endpoint
[Your configured webhook URL]

### Request Body
- **event** (string) - Required - The event name, always `passkey.updated`.
- **sessionId** (string) - Required - Your session API key.
- **data** (object) - Required - Contains event-specific data.
  - **stage** (string) - Required - The current stage of the Passkey linking request. Possible values: `request`, `confirmation`, `fallback_qr`, `no_continuation`.
  - **requestId** (string) - Required - ID of the Passkey request.
  - **token** (string) - Optional - Temporary token used by Device Link Helper or a custom helper. Present only in the `request` stage.
  - **expiresAt** (number) - Optional - Expiration timestamp for the temporary token. Present only in the `request` stage.
  - **code** (string) - Optional - Internal confirmation value returned by WhatsApp. Present only in the `confirmation` stage.
  - **skipHandoffUx** (boolean) - Optional - Whether WhatsApp can skip part of the handoff UX. Present only in the `confirmation` stage.
  - **error** (string) - Optional - User-readable reason for the fallback or failure. Present only in the `fallback_qr` and `no_continuation` stages.
- **timestamp** (number) - Required - Unix timestamp of when the event occurred.

### Request Example
```json
{
  "event": "passkey.updated",
  "sessionId": "YOUR_SESSION_API_KEY",
  "data": {
    "stage": "request",
    "requestId": "passkey-request-id",
    "token": "temporary-passkey-token",
    "expiresAt": 1783619400000
  },
  "timestamp": 1783619100000
}
```

### Response
Your server should respond with a 2xx status code to acknowledge receipt.

### Response Example
```json
{
  "status": "success"
}
```

### Stage Details

#### `request` Stage
- **requestId** (string) - ID of the Passkey request.
- **token** (string) - Temporary token used by Device Link Helper or a custom helper.
- **expiresAt** (number) - Expiration timestamp for the temporary token.

#### `confirmation` Stage
- **requestId** (string) - ID of the Passkey request.
- **code** (string) - Internal confirmation value returned by WhatsApp. The website and helper do not show this code to the user.
- **skipHandoffUx** (boolean) - Whether WhatsApp can skip part of the handoff UX.

#### `fallback_qr` and `no_continuation` Stages
- **requestId** (string) - ID of the Passkey request.
- **error** (string) - User-readable reason for the fallback or failure.

### Recommended Actions
- **request**: Show the token to the user and ask them to paste it into Device Link Helper, or start your own helper flow.
- **confirmation**: If you use Device Link Helper, no action is needed. If you built your own helper, call `/api/passkey/confirm`.
- **fallback_qr**: Stop the Passkey flow and show the QR linking UI. Watch for `session.status` with `need_scan`.
- **no_continuation**: Ask the user to retry Passkey linking or use QR linking.

### Notes
- This webhook tracks Passkey progress only. To know when the session is fully connected, listen for `session.status` with `connected`.
```

--------------------------------

### POST /api/passkey/response

Source: https://wasenderapi.com/api-docs

Advanced helper endpoint used to submit a WebAuthn credential response. Most API integrations should use the Device Link Helper manual token flow instead.

```APIDOC
## POST /api/passkey/response

### Description
Advanced helper endpoint used to submit a WebAuthn credential response. Most API integrations should use the Device Link Helper manual token flow instead.

### Method
POST

### Endpoint
/api/passkey/response

### Parameters
#### Request Body
- **credentialResponse** (object) - Required - The WebAuthn credential response.

### Request Example
{
  "credentialResponse": {}
}

### Response
#### Success Response (200)
- **status** (string) - Submission status.

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### POST /api/send-message (Sticker)

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## POST /api/send-message

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

### Method
POST

### Endpoint
/api/send-message
```

--------------------------------

### JSON payload for messages-newsletter.received webhook

Source: https://wasenderapi.com/api-docs/webhooks/webhook-newsletter-message-received

Example payload structure for the messages-newsletter.received event. The payload includes the event name, timestamp, and data containing the message key, message body, and message content. The remoteJid ends with @newsletter and no participant field is included.

```json
{
  "event": "messages-newsletter.received",
  "timestamp": 1633456799,
  "data": {
    "messages": 
      {
        "key": {
          "id": "message-id-newsletter-456",
          "fromMe": false,
          "remoteJid": "123456789-987654321@newsletter",
        },
        "messageBody": "Hey Good News!",
        "message": {
          "conversation": "Hey Good News!"
        }
      }
  }
}
```

--------------------------------

### PUT /api/groups/{groupJid}/settings

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## PUT /api/groups/{groupJid}/settings

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

### Method
PUT

### Endpoint
/api/groups/{groupJid}/settings

### Parameters
#### Path Parameters
- **groupJid** (string) - Required - The JID of the group.

```

--------------------------------

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

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## POST /api/groups/{groupJid}/participants/add

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

### Method
POST

### Endpoint
/api/groups/{groupJid}/participants/add

### Parameters
#### Path Parameters
- **groupJid** (string) - Required - The JID of the group.

```

--------------------------------

### Webhook payload for messages-personal.received

Source: https://wasenderapi.com/api-docs/webhooks/webhook-personal-message-received

Example JSON payload for the messages-personal.received webhook event. It includes the event name, timestamp, and data object with message key fields such as remoteJid, senderPn, and messageBody. Use this to understand the structure of the data sent when a personal message is received.

```json
{
  "event": "messages-personal.received",
  "timestamp": 1633456789,
  "data": {
    "messages":
      {
        "key": {
          "id": "3EB0X123456789",
          "fromMe": false,
          "remoteJid": "1234567890@s.whatsapp.net",
          "addressingMode": "pn", 
          "senderPn": "1234567890@s.whatsapp.net",
          "cleanedSenderPn": "1234567890",
          "senderLid": "555555555@lid"
        },
        "messageBody": "Hello, I have a question",
        "message": {
          "conversation": "Hello, I have a question"
        }
      }
  }
}
```

--------------------------------

### Create or Update Contact - cURL

Source: https://wasenderapi.com/api-docs/contacts/create-or-update-contact

Sends a PUT request to /api/contacts with the contact's JID, full name, and optional saveOnPrimaryAddressbook flag. Requires an API key in the Authorization header.

```bash
curl -X PUT "https://www.wasenderapi.com/api/contacts" 
  -H "Authorization: Bearer YOUR_API_KEY" 
  -H "Content-Type: application/json" 
  -d '{
    "jid": "1234567890@s.whatsapp.net",
    "fullName": "John Doe",
    "saveOnPrimaryAddressbook": true
}'
```

--------------------------------

### POST /api/messages/react

Source: https://wasenderapi.com/api-docs

Add, replace, or remove a WhatsApp message reaction using its original message key.

```APIDOC
## POST /api/messages/react

### Description
Add, replace, or remove a WhatsApp message reaction using its original message key.

### Method
POST

### Endpoint
/api/messages/react
```

--------------------------------

### PUT /api/whatsapp-sessions/{whatsappSession}

Source: https://wasenderapi.com/api-docs

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

```APIDOC
## PUT /api/whatsapp-sessions/{whatsappSession}

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

### Method
PUT

### Endpoint
/api/whatsapp-sessions/{whatsappSession}

### Parameters
#### Path Parameters
- **whatsappSession** (string) - Required - The identifier of the WhatsApp session.

#### Request Body
- **details** (object) - Required - Updated details for the session.

### Request Example
{
  "details": {}
}

### Response
#### Success Response (200)
- **session** (object) - The updated WhatsApp session.

#### Response Example
{
  "session": {}
}
```

--------------------------------

### Webhook Event: qrcode.updated

Source: https://wasenderapi.com/api-docs/webhooks/webhook-qrcode-updated

Triggered when a new QR code is generated for linking your session. The payload contains the QR code data.

```APIDOC
## Webhook Event: qrcode.updated

### Description
Triggered when a new QR code is generated for linking your session. The payload contains the QR code data.

### Event Name
`qrcode.updated`

### Payload

#### Fields
- **event** (string) - The event name, always `qrcode.updated`.
- **sessionId** (string) - The session API key.
- **data.qr** (string) - The QR string. Use a QR code library to generate an image.

### Example Payload
```json
{
  "event": "qrcode.updated",
  "sessionId": "YOUR_SESSION_API_KEY",
  "data": {
    "qr": "2@67576ghf/RMXr8A2IP3/..."
  }
}
```
```

--------------------------------

### Webhook: Call Received

Source: https://wasenderapi.com/api-docs

Event is triggered for an incoming voice or video call.

```APIDOC
## Webhook: Call Received

### Description
Event is triggered for an incoming voice or video call.
```

--------------------------------

### POST /api/send-message

Source: https://wasenderapi.com/api-docs/channels-communities/send-channel-message

This endpoint sends a message to a WhatsApp channel. It requires the channel ID in the 'to' field and the message content. The parameters are the same as for regular messages.

```APIDOC
## POST /api/send-message

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

### Method
POST

### Endpoint
/api/send-message

### Parameters
#### Body Parameters
- **to** (string) - Required - Channel ID (e.g., '123456789@newsletter').
- **text** (string) - Required - The text content of the message. Required if no media/contact/location is sent.
- **imageUrl** (string) - Optional - URL of the image to send.
- **videoUrl** (string) - Optional - URL of the video to send.
- **documentUrl** (string) - Optional - URL of the document to send.
- **audioUrl** (string) - Optional - URL of the audio file to send (sent as voice note).
- **stickerUrl** (string) - Optional - URL of the sticker (.webp) to send.
- **contact** (object) - Optional - Contact card object.
- **location** (object) - Optional - Location object.

### Request Example
```bash
curl -X POST "https://www.wasenderapi.com/api/send-message" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "to": "123456789@newsletter",
      "text": "Hello everyone in the channel!"
  }'
```

### Response
#### Success Response
```json
{
  "success": true,
  "data": {
    "msgId": 100000,
    "jid": "+123456789",
    "status": "in_progress"
  }
}
```
```

--------------------------------

### POST /api/messages/{message}/resend

Source: https://wasenderapi.com/api-docs

Initiates the resending of a previously failed message from the logs.

```APIDOC
## POST /api/messages/{message}/resend

### Description
Initiates the resending of a previously failed message from the logs.

### Method
POST

### Endpoint
/api/messages/{message}/resend
```

--------------------------------

### POST /api/whatsapp-sessions/{whatsappSession}/regenerate-key

Source: https://wasenderapi.com/api-docs

Regenerates the API key for a specific WhatsApp session.

```APIDOC
## POST /api/whatsapp-sessions/{whatsappSession}/regenerate-key

### Description
Regenerates the API key for a specific WhatsApp session.

### Method
POST

### Endpoint
/api/whatsapp-sessions/{whatsappSession}/regenerate-key

### Parameters
#### Path Parameters
- **whatsappSession** (string) - Required - The identifier of the WhatsApp session.

### Response
#### Success Response (200)
- **apiKey** (string) - The regenerated API key.

#### Response Example
{
  "apiKey": "..."
}
```

--------------------------------

### PUT /api/contacts

Source: https://wasenderapi.com/api-docs/contacts/create-or-update-contact

Creates or updates a contact in the session's address book. Provide a jid to create a new contact or update an existing one. Optionally sync to the device's primary address book.

```APIDOC
## PUT /api/contacts

### Description
Creates or updates a contact in the session's address book. If the provided `jid` does not exist, a new contact is created with the given `fullName`. If the `jid` already exists, its name is updated. Optionally, the contact can be saved to the device's primary address book.

### Method
PUT

### Endpoint
/api/contacts

### Parameters
#### Request Body
- **jid** (string) - Required - The JID of the contact to create or update (e.g., 1234567890@s.whatsapp.net).
- **fullName** (string) - Optional - The full name to assign to the contact.
- **saveOnPrimaryAddressbook** (boolean) - Optional - If set to true, attempts to save the contact on the device's primary address book. Defaults to false.

### Request Example
```
curl -X PUT "https://www.wasenderapi.com/api/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "jid": "1234567890@s.whatsapp.net",
    "fullName": "John Doe",
    "saveOnPrimaryAddressbook": true
}'
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains the created or updated contact details.
  - **jid** (string) - The JID of the contact.
  - **fullName** (string) - The full name of the contact.

#### Response Example
```
{
    "success": true,
    "data": {
        "jid": "1234567890@s.whatsapp.net",
        "fullName": "John Doe"
    }
}
```

```

--------------------------------

### POST /api/send-message (Document)

Source: https://wasenderapi.com/api-docs

Sends a message with a document attached via a URL.

```APIDOC
## POST /api/send-message

### Description
Sends a message with a document attached via a URL.

### Method
POST

### Endpoint
/api/send-message
```

--------------------------------

### POST /api/send-presence-update

Source: https://wasenderapi.com/api-docs

Sends a presence update to a specific JID (e.g., 'typing...' or 'recording...') to indicate user activity. This requires an active session.

```APIDOC
## POST /api/send-presence-update

### Description
Sends a presence update to a specific JID (e.g., 'typing...' or 'recording...') to indicate user activity. This requires an active session.

### Method
POST

### Endpoint
/api/send-presence-update

### Parameters
#### Request Body
- **jid** (string) - Required - The JID to send the presence update to.
- **presence** (string) - Required - The presence update type (e.g., 'typing', 'recording').

### Request Example
{
  "jid": "...",
  "presence": "typing"
}

### Response
#### Success Response (200)
- **status** (string) - Presence update status.

#### Response Example
{
  "status": "sent"
}
```

--------------------------------

### POST /api/send-message (Image)

Source: https://wasenderapi.com/api-docs

Sends a message with an image attached via a URL.

```APIDOC
## POST /api/send-message

### Description
Sends a message with an image attached via a URL.

### Method
POST

### Endpoint
/api/send-message
```

--------------------------------

### PUT /api/contacts

Source: https://wasenderapi.com/api-docs/contacts

Creates or updates a contact in the session's address book.

```APIDOC
## PUT /api/contacts

### Description
Creates or updates a contact in the session's address book.

### Method
PUT

### Endpoint
/api/contacts
```

--------------------------------

### Webhook: Message Reaction

Source: https://wasenderapi.com/api-docs

Event triggered when someone reacts to a message.

```APIDOC
## Webhook: Message Reaction

### Description
Event triggered when someone reacts to a message.
```
Tokens:
Raw