WhatsApp API (1.0.0)

Download OpenAPI specification:Download

Cette API permet d'intégrer des fonctionnalités de WhatsApp dans vos applications. Note importante : Il s'agit d'une API non officielle de WhatsApp.

Prix : 10 000 FCFA par mois pour un nombre d'utilisateurs illimité.

Exemples d'utilisation :

  1. Service client automatisé : Intégrez l'API pour automatiser les réponses et interagir avec vos clients directement via WhatsApp. Vous pouvez répondre instantanément à des demandes fréquentes, améliorer la satisfaction client, et économiser sur les coûts des équipes de support.

  2. Notifications et alertes : Utilisez l'API pour envoyer des notifications personnalisées aux utilisateurs, telles que des confirmations de commande, des rappels d'abonnement, ou des alertes de promotion.

  3. Marketing par WhatsApp : Envoyez des messages de promotion, des codes de réduction, ou des offres spéciales à vos clients, augmentant ainsi les ventes tout en réduisant les coûts d'acquisition client.

  4. Gestion des commandes et suivi : Utilisez l'API pour recevoir et gérer des commandes, envoyer des confirmations et des suivis de livraison directement sur WhatsApp.

En utilisant cette API, vous pouvez facilement intégrer WhatsApp dans vos services, offrir une meilleure expérience à vos utilisateurs, et générer des revenus supplémentaires.

Vous avez besoin d'aide ? Nous sommes disponibles. Contactez-nous sur WhatsApp

Session

Handling multiple sessions logic, creation and deletion

Start new session

Starts a session for the given session ID.

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Session initiated successfully"
}

Get session status

Status of the session with the given session ID.

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "state": "CONNECTED",
  • "message": "session_connected"
}

Get session QR code

QR code of the session with the given session ID.

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

Get session QR code as image

QR code as image of the session with the given session ID.

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

Restart session

Restarts the session with the given session ID.

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Restarted successfully"
}

Terminate session

Terminates the session with the given session ID.

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Logged out successfully"
}

Terminate inactive sessions

Terminates all inactive sessions.

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Flush completed successfully"
}

Terminate all sessions

Terminates all sessions.

Authorizations:
apiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Flush completed successfully"
}

Client

All functions related to the client

/client/getClassInfo/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/acceptInvite/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
inviteCode
string

Invitation code

Responses

Request samples

Content type
{
  • "inviteCode": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/archiveChat/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

ID of the chat

Responses

Request samples

Content type
{
  • "chatId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/createGroup/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getBlockedContacts/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getChatById/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

ID of the chat

Responses

Request samples

Content type
{
  • "chatId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getChatLabels/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

ID of the chat

Responses

Request samples

Content type
{
  • "chatId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getChats/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getChatsByLabelId/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
labelId
string

ID of the label

Responses

Request samples

Content type
{
  • "labelId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getCommonGroups/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
contactId
string

The whatsapp user's ID (_serialized format)

Responses

Request samples

Content type
{
  • "contactId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getContactById/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
contactId
string

The whatsapp user's ID

Responses

Request samples

Content type
{
  • "contactId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getContacts/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getInviteInfo/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
inviteCode
string

Invitation code

Responses

Request samples

Content type
{
  • "inviteCode": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getLabelById/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
labelId
string

ID of the label

Responses

Request samples

Content type
{
  • "labelId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getLabels/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/addOrRemoveLabels/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
labelIds
Array of arrays

Array of label IDs

chatIds
Array of arrays

Array of chat IDs

Responses

Request samples

Content type
{
  • "labelIds": [ ],
  • "chatIds": [ ]
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getNumberId/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
number
string

The number or ID ('@c.us' will be automatically appended if not specified)

Responses

Request samples

Content type
{
  • "number": "6281288888888"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/isRegisteredUser/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
number
string

The number or ID ('@c.us' will be automatically appended if not specified)

Responses

Request samples

Content type
{
  • "number": "6281288888888"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getProfilePicUrl/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
contactId
string

The contact ID's of profile

Responses

Request samples

Content type
{
  • "contactId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getState/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/markChatUnread/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

ID of the chat

Responses

Request samples

Content type
{
  • "chatId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/muteChat/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

ID of the chat

unmuteDate
string

Date when the chat will be muted, leave as is to mute forever

Responses

Request samples

Content type
{
  • "chatId": "",
  • "unmuteDate": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/pinChat/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

ID of the chat

Responses

Request samples

Content type
{
  • "chatId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/searchMessages/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
query
string

Search string

options
object

Search options

Responses

Request samples

Content type
{
  • "query": "",
  • "options": { }
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/sendMessage/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema: application/json
required
chatId
string

The Chat id which contains the message (Group or Individual)

contentType
string

The type of message content, must be one of the following: string, MessageMedia, MessageMediaFromURL, Location, Buttons, or List

content
object

The content of the message, can be a string or an object

options
object

The message send options

Responses

Request samples

Content type
application/json
Example
{
  • "chatId": "6281288888888@c.us",
  • "contentType": "string",
  • "content": "Hello World!"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/sendPresenceAvailable/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/sendPresenceUnavailable/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/sendSeen/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

ID of the chat

Responses

Request samples

Content type
{
  • "chatId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/setDisplayName/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
displayName
string

New display name

Responses

Request samples

Content type
{
  • "displayName": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/setProfilePicture/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
pictureMimetype
string

The mimetype of the picture to set as the profile picture for the user WhatsApp account.

pictureData
string

The base64 data of the picture to set as the profile picture for the user WhatsApp account.

Responses

Request samples

Content type
{
  • "pictureMimetype": "image/png",
  • "pictureData": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX +/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII="
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/setStatus/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
status
string

New status message

Responses

Request samples

Content type
{
  • "status": "I'm running WhatsApp Web Api"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/unarchiveChat/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

ID of the chat

Responses

Request samples

Content type
{
  • "chatId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/unmuteChat/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

ID of the chat

Responses

Request samples

Content type
{
  • "chatId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/unpinChat/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

ID of the chat

Responses

Request samples

Content type
{
  • "chatId": ""
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/client/getWWebVersion/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

Message

May fail if the message is too old (Only from the last 100 Messages of the given chat)

/message/getClassInfo/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/delete/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/downloadMedia/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/forward/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/getInfo/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/getMentions/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/getOrder/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/getPayment/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/getQuotedMessage/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/react/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/reply/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/star/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/message/unstar/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

The Chat id which contains the message

messageId
string

Unique whatsApp identifier for the message

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "messageId": "ABCDEF999999999"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

Various

/ping

Responses

/localCallbackExample

Authorizations:
apiKeyAuth
header Parameters
x-api-key
string

Responses

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

Chat

/chat/getClassInfo/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/chat/clearMessages/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/chat/clearState/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/chat/delete/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/chat/fetchMessages/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

searchOptions
object

Search options for fetching messages

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us",
  • "searchOptions": "{}"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/chat/getContact/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/chat/sendStateRecording/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/chat/sendStateTyping/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

Group Chat

/groupChat/getClassInfo/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/addParticipants/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/demoteParticipants/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/getInviteCode/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/leave/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/promoteParticipants/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/removeParticipants/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/revokeInvite/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/setDescription/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/setInfoAdminsOnly/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/setMessagesAdminsOnly/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/setSubject/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/setPicture/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/groupChat/deletePicture/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
chatId
string

Unique whatsApp identifier for the given Chat (either group or personnal)

Responses

Request samples

Content type
{
  • "chatId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

Contact

/contact/getClassInfo/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
contactId
string

Unique whatsApp identifier for the contact

Responses

Request samples

Content type
{
  • "contactId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/contact/block/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
contactId
string

Unique whatsApp identifier for the contact

Responses

Request samples

Content type
{
  • "contactId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/contact/getAbout/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
contactId
string

Unique whatsApp identifier for the contact

Responses

Request samples

Content type
{
  • "contactId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/contact/getChat/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
contactId
string

Unique whatsApp identifier for the contact

Responses

Request samples

Content type
{
  • "contactId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/contact/unblock/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
contactId
string

Unique whatsApp identifier for the contact

Responses

Request samples

Content type
{
  • "contactId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/contact/getFormattedNumber/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
contactId
string

Unique whatsApp identifier for the contact

Responses

Request samples

Content type
{
  • "contactId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/contact/getCountryCode/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
contactId
string

Unique whatsApp identifier for the contact

Responses

Request samples

Content type
{
  • "contactId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}

/contact/getProfilePicUrl/{sessionId}

Authorizations:
apiKeyAuth
path Parameters
sessionId
required
string
Example: f8377d8d-a589-4242-9ba6-9486a04ef80c

Unique identifier for the session (alphanumeric and - allowed)

Request Body schema:
required
contactId
string

Unique whatsApp identifier for the contact

Responses

Request samples

Content type
{
  • "contactId": "6281288888888@c.us"
}

Response samples

Content type
application/json
{
  • "success": false,
  • "error": "Invalid API key"
}