Session Info
Retrieve complete information about a WhatsApp session, including connection status, authenticated user info, and server details.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Poll this endpoint every 3-5 seconds while waiting for the user to scan the QR code.
Stop polling once the status becomes 'WORKING'.
Use this endpoint to build a 'System Status' page in your application dashboard.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
Request Body
Sent as a JSON objectstring | The 12-character ID of the instance to check Example: | ||
string | Your API Access Token Example: |
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"name": "wawp-84729105",
"status": "WORKING",
"config": {
"webhooks": {
},
"proxy": null
},
"me": {
"id": "201012345678@c.us",
"pushName": "John Doe"
}
}Command Palette
Search for a command to run...