# WhatsApp SDK

> SDK for WhatsApp Web integration with comprehensive API documentation

## Docs

- [Get client status](https://docs.wppagent.com/api-reference/auth/get-client-status.md): Get the status of the WhatsApp client including authentication state and QR code availability
- [Get QR code as image](https://docs.wppagent.com/api-reference/auth/get-qr-code-as-image.md): Get the QR code for WhatsApp authentication as a PNG image (if available)
- [Logout](https://docs.wppagent.com/api-reference/auth/logout.md): Logout from WhatsApp Web
- [API Authentication](https://docs.wppagent.com/api-reference/authentication.md): Authenticating with the WhatsApp SDK API
- [Create a new group chat](https://docs.wppagent.com/api-reference/chat/create-a-new-group-chat.md): Creates a new WhatsApp group with the specified parameters:
- [Delete chat](https://docs.wppagent.com/api-reference/chat/delete-chat.md): Delete a chat
- [Get chat details](https://docs.wppagent.com/api-reference/chat/get-chat-details.md): Retrieve details of a specific chat
- [List chats](https://docs.wppagent.com/api-reference/chat/list-chats.md): List all chats with pagination
- [Update chat](https://docs.wppagent.com/api-reference/chat/update-chat.md): Update chat properties (mute, pin, archive, etc)
- [Update group](https://docs.wppagent.com/api-reference/chat/update-group.md): Update group properties (subject, description, settings, picture) in a single request
- [Update group members](https://docs.wppagent.com/api-reference/chat/update-group-members.md): Manage group members (add, remove, promote, demote)
- [Get client information](https://docs.wppagent.com/api-reference/client/get-client-information.md): Returns consolidated client information including version, state, and battery info
- [Restart the client](https://docs.wppagent.com/api-reference/client/restart-the-client.md)
- [Block or unblock contact](https://docs.wppagent.com/api-reference/contact/block-or-unblock-contact.md): Block or unblock a contact
- [Get common groups](https://docs.wppagent.com/api-reference/contact/get-common-groups.md): Retrieve common groups between the current user and a contact
- [Get contact details](https://docs.wppagent.com/api-reference/contact/get-contact-details.md): Retrieve details of a specific contact including profile picture, about info, and block status
- [List contacts](https://docs.wppagent.com/api-reference/contact/list-contacts.md): List all contacts with pagination
- [Health check endpoint](https://docs.wppagent.com/api-reference/health/health-check-endpoint.md): Verifies that the application is running
- [Readiness check endpoint](https://docs.wppagent.com/api-reference/health/readiness-check-endpoint.md): Verifies that the application is ready to serve traffic
- [Root readiness check endpoint](https://docs.wppagent.com/api-reference/health/root-readiness-check-endpoint.md): Verifies that the application is ready to serve traffic
- [Delete message](https://docs.wppagent.com/api-reference/message/delete-message.md): Delete a message
- [Forward a message](https://docs.wppagent.com/api-reference/message/forward-a-message.md): Forward an existing message to another chat
- [Get message details](https://docs.wppagent.com/api-reference/message/get-message-details.md): Retrieve details of a specific message including content, metadata, mentions, and reactions
- [List messages](https://docs.wppagent.com/api-reference/message/list-messages.md): List messages with pagination
- [Reply to a message](https://docs.wppagent.com/api-reference/message/reply-to-a-message.md): Reply to an existing message
- [Send a message](https://docs.wppagent.com/api-reference/message/send-a-message.md): Send a new message to a contact or group. Supports text messages, media (image, video, audio, document), and location.
- [Update message](https://docs.wppagent.com/api-reference/message/update-message.md): Update message properties (star, pin, react, etc)
- [API Reference Overview](https://docs.wppagent.com/api-reference/overview.md): Introduction to the WhatsApp SDK API endpoints and functionality
- [Get profile information](https://docs.wppagent.com/api-reference/profile/get-profile-information.md): Retrieve the current WhatsApp client profile information
- [Update profile](https://docs.wppagent.com/api-reference/profile/update-profile.md): Update the current WhatsApp client profile properties
- [Changelog](https://docs.wppagent.com/changelog/index.md): Track all notable changes to the WhatsApp SDK
- [Group Chats](https://docs.wppagent.com/core-features/chats/group-chats.md): Managing WhatsApp group conversations with the SDK
- [Individual Chats](https://docs.wppagent.com/core-features/chats/individual-chats.md): Working with one-on-one conversations in the WhatsApp SDK
- [Chats Overview](https://docs.wppagent.com/core-features/chats/overview.md): Understanding WhatsApp chats and conversation management with the SDK
- [Contact Management](https://docs.wppagent.com/core-features/contacts/management.md): Managing contacts, blocking, and retrieving contact information
- [Contacts Overview](https://docs.wppagent.com/core-features/contacts/overview.md): Working with WhatsApp contacts in your applications
- [Media Messages](https://docs.wppagent.com/core-features/messaging/media-messages.md): Send and receive images, videos, documents and other media with the WhatsApp SDK
- [Messaging Overview](https://docs.wppagent.com/core-features/messaging/overview.md): Introduction to messaging capabilities of the WhatsApp SDK
- [Text Messages](https://docs.wppagent.com/core-features/messaging/text-messages.md): Send and receive text messages with the WhatsApp SDK
- [Building a WhatsApp Chatbot](https://docs.wppagent.com/examples/chatbot.md): Learn how to build an interactive chatbot using the WhatsApp SDK
- [Customer Support System](https://docs.wppagent.com/examples/customer-support.md): Building a customer support system with WhatsApp SDK integration
- [WhatsApp Notification Service](https://docs.wppagent.com/examples/notification-service.md): Create a scalable notification service using the WhatsApp SDK
- [Local Authentication](https://docs.wppagent.com/getting-started/authentication/local-auth.md): Implementing local storage based authentication for WhatsApp SDK
- [Authentication Overview](https://docs.wppagent.com/getting-started/authentication/overview.md): Understanding WhatsApp SDK authentication principles and strategies
- [Remote Authentication](https://docs.wppagent.com/getting-started/authentication/remote-auth.md): Implementing cloud-based remote authentication for WhatsApp SDK
- [Configuration Options](https://docs.wppagent.com/getting-started/configuration.md): Configure the WhatsApp SDK to meet your application requirements
- [Installation](https://docs.wppagent.com/getting-started/installation.md): Step-by-step instructions for installing the WhatsApp SDK and its dependencies
- [Quickstart Guide](https://docs.wppagent.com/getting-started/quickstart.md): Get up and running with the WhatsApp SDK quickly
- [AWS Lambda Integration](https://docs.wppagent.com/guides/aws-lambda.md): Deploying WhatsApp SDK with AWS Lambda for serverless applications
- [Express.js Integration](https://docs.wppagent.com/guides/express-integration.md): Integrating WhatsApp SDK with Express.js applications
- [Next.js Integration](https://docs.wppagent.com/guides/nextjs-integration.md): Integrating WhatsApp SDK with Next.js applications
- [Deployment Strategies](https://docs.wppagent.com/infrastructure/deployment.md): Best practices for deploying WhatsApp SDK in various environments
- [Infrastructure Overview](https://docs.wppagent.com/infrastructure/overview.md): Understanding the deployment and infrastructure requirements for the WhatsApp SDK
- [Scaling WhatsApp SDK](https://docs.wppagent.com/infrastructure/scaling.md): Handling high volumes of messages and multiple clients
- [Session Management](https://docs.wppagent.com/infrastructure/session-management.md): Managing WhatsApp sessions and authentication states in production
- [Architecture Overview](https://docs.wppagent.com/introduction/architecture.md): Detailed explanation of the WhatsApp SDK architecture and layered design
- [Core Concepts](https://docs.wppagent.com/introduction/concepts.md): Understanding the fundamental concepts and terminology of the WhatsApp SDK
- [WhatsApp SDK Introduction](https://docs.wppagent.com/introduction/index.md): Introduction to the WhatsApp SDK for Node.js and its capabilities
- [MCP Server API Endpoints](https://docs.wppagent.com/mcp-server/api-endpoints.md): Reference for available API endpoints in the MCP Server
- [Configuring MCP Server](https://docs.wppagent.com/mcp-server/configuration.md): Configuration options and settings for the MCP Server
- [Installing MCP Server](https://docs.wppagent.com/mcp-server/installation.md): Step-by-step guide to installing and setting up the MCP Server
- [MCP Server Overview](https://docs.wppagent.com/mcp-server/overview.md): Introduction to the MCP Server for WhatsApp SDK

## OpenAPI Specs

- [whatsapp-sdk-openapi](https://docs.wppagent.com/openapi/whatsapp-sdk-openapi.json)
- [openapi](https://docs.wppagent.com/openapi.yaml)