> ## Documentation Index > Fetch the complete documentation index at: https://docs.wppfy.com/llms.txt > Use this file to discover all available pages before exploring further. # Get instance status > Returns the current status of an instance, including: - Connection state - Updated QR code (if connecting) - Pairing code (if available) - Information about the last disconnection - Full instance details This endpoint is particularly useful for: 1. Monitoring connection progress 2. Getting updated QR codes during the connection process 3. Checking the current state of the instance 4. Identifying connection problems Possible states: - `disconnected`: Disconnected from WhatsApp - `connecting`: Connecting (waiting for QR code or pairing code) - `connected`: Successfully connected and authenticated - `hibernated`: Session paused, with credentials preserved for reconnection ## OpenAPI ````yaml /openapi-en.json get /instance/status openapi: 3.1.0 info: title: WppFy - WhatsApp API version: 1.0.0 description: > API for managing WhatsApp instances and communications. ## Important Recommendation: WhatsApp Business **It is HIGHLY RECOMMENDED to use WhatsApp Business accounts** instead of regular WhatsApp for integration; regular WhatsApp may present inconsistencies, disconnections, limitations, and instability when used with our API. ## Authentication - Regular endpoints require a 'token' header with the instance token ## Instance States Instances can be in the following states: - `disconnected`: Disconnected from WhatsApp - `connecting`: Connection in progress - `connected`: Successfully connected and authenticated servers: - url: https://api.wppfy.com security: - token: [] tags: - name: Instance description: | Operations related to an instance's lifecycle, such as connecting, disconnecting, and checking status. - name: Proxy description: > WppFy uses an internal proxy by default. You can keep this default, configure your own proxy via `proxy_url`, or use your Android phone as a proxy by installing the app from https://github.com/WppFy/silver_proxy_apk (direct APK: https://github.com/WppFy/silver_proxy_apk/raw/refs/heads/main/silver_proxy.apk). If nothing is sent, we keep using the internal proxy. IPs are Brazilian; for international clients, consider a proxy in the client's region. - name: Profile description: | Operations related to the WhatsApp instance profile, such as changing the profile name and picture. - name: Business description: | โš ๏ธ **EXPERIMENTAL** - Endpoints not yet fully tested. Operations related to the WhatsApp Business business profile. Allows querying and updating business profile data such as description, address, email, categories, and managing the product catalog. **Requirements:** - The currently connected account must be a **WhatsApp Business** account - Personal WhatsApp accounts do not have a business profile **Note:** These endpoints may not work as expected. Report any problems found. - name: Calls description: | Operations related to WhatsApp calls. Allows making and rejecting calls programmatically. - name: Send Message description: > Endpoints for sending WhatsApp messages with different content types. ## Common Optional Fields All message sending endpoints support the following optional fields: - **`delay`** *(integer)*: Delay in milliseconds before sending - During the delay, "Typing..." or "Recording audio..." will appear depending on the type - Example: `5000` (5 seconds) - **`readchat`** *(boolean)*: Mark chat as read after sending - Removes the unread message counter from the chat - Example: `true` - **`readmessages`** *(boolean)*: Mark last received messages as read - Marks the last 10 **received** messages (not sent by you) as read - Useful to confirm reading pending messages before replying - Different from `readchat` which only removes the unread counter - Example: `true` - **`replyid`** *(string)*: ID of the message to reply to - Creates a reply linked to the original message - Support varies by message type - Example: `"3A12345678901234567890123456789012"` - **`mentions`** *(string)*: Numbers to mention (only for group sending) - Specific numbers: `"5511999999999,5511888888888"` - Mention all: `"all"` - **`forward`** *(boolean)*: Marks the message as forwarded in WhatsApp - Adds the "Forwarded" indicator to the message - Example: `true` - **`track_source`** *(string)*: Message tracking source - Identifies the system or source sending the message - Useful for integrations (e.g., "chatwoot", "crm", "chatbot") - Example: `"chatwoot"` - **`track_id`** *(string)*: ID for message tracking - Free identifier to track the message in external systems - Allows correlating messages between different platforms - **Note**: The system accepts duplicate values - there is no uniqueness validation - Use the same ID in multiple messages if it makes sense for your integration - Example: `"msg_123456789"` ### Sending to Groups - **`number`** *(string)*: To send a message to a group, use the group ID ending with `@g.us` - Example: `"120363012345678901@g.us"` - **How to get the Group ID:** - Use the `chatid` from the webhook received when someone sends a message in the group - Use the `GET /group/list` endpoint to list all groups and their IDs ## Available Placeholders All message sending endpoints support dynamic placeholders for automatic personalization: ### Name Fields - **`{{name}}`**: Consolidated chat name, using the first available option: 1. Lead name (`lead_name`) 2. Lead full name (`lead_fullName`) 3. WhatsApp contact name (`wa_contactName`) 4. WhatsApp profile name (`wa_name`) - **`{{first_name}}`**: First valid word of the consolidated name (minimum 2 characters) ### WhatsApp Fields - **`{{wa_name}}`**: WhatsApp profile name - **`{{wa_contactName}}`**: Contact name as saved in WhatsApp ### Lead Fields - **`{{lead_name}}`**: Lead name - **`{{lead_fullName}}`**: Lead full name - **`{{lead_personalid}}`**: Personal ID (SSN, CPF, CNPJ, etc) - **`{{lead_email}}`**: Lead email - **`{{lead_status}}`**: Current lead status - **`{{lead_notes}}`**: Lead notes - **`{{lead_assignedAttendant_id}}`**: ID of the assigned attendant ### Custom Fields Fields added via custom fields are accessible using `{{lead_field01}}` to `{{lead_field20}}` or use `{{fieldname}}` defined in `/instance/updateFieldsMap`. ### Usage Example ``` Hello {{name}}! I saw you work at {{company}}. Is your email {{lead_email}} correct? ``` **๐Ÿ’ก Tip**: Use `/chat/find` to fetch chat data and see available fields before sending messages with placeholders. - name: Async Message description: > Operational controls for the internal asynchronous send queue used when a send endpoint receives `async=true`. This section is used to: - check the current state of the async queue - configure the delay between messages sent with `async=true` - clear pending backlog and cancel messages not yet completed Scope: - covers only the internal queue of async direct messages - does not change messages already sent successfully - name: Message Actions and Search - name: Chats - name: Contacts - name: Blocklist - name: Labels - name: Groups and Communities - name: Newsletters and Channels description: > Operations for reading and following WhatsApp channels (newsletters). Main use cases: - list posts already published in a channel - edit recent posts in a channel - delete recent posts in a channel - check post views and reactions - integrate channels without needing to persist messages locally Notes: - `/newsletter/messages` returns the post content - `/newsletter/messages/edit` edits the content of recent posts - `/newsletter/messages/delete` deletes recent posts - views (`viewsCount`) and reactions (`reactionCounts`) come in each post of `/newsletter/messages`, not via webhook event - `/newsletter/updates` is deprecated: WhatsApp does not respond and the API returns 504 - newsletters use their own routes and must not use `/message/edit` or `/message/delete` - name: Quick Replies description: > Management of quick replies to streamline service. **โš ๏ธ Important**: This feature is only useful if you use a custom frontend/interface to register and use the replies. The API only stores the replies, but does not apply them automatically. ### How it works: - **Create**: Register pre-defined responses with titles and content - **List**: Retrieve all registered responses to display in your interface - **Use**: Your frontend system can use these responses to speed up typing ### Use cases: - Custom web service interfaces - Mobile apps with reply suggestions - CRM systems with message templates - Productivity tools for attendants **Not a chatbot**: For automatic responses, use Chatbot features. - name: CRM description: > Complete customer relationship management system integrated with the API. **๐Ÿ’พ Internal Storage**: All lead data is saved directly in the API, eliminating the need for external databases. Your application can focus only on the interface and business logic. ### Available Features: - **๐Ÿ“‹ 20+ customizable fields**: Name, phone, email, company, notes, etc. - **๐Ÿท๏ธ Label System**: Organize and categorize your contacts - **๐Ÿ” Advanced Search**: Filter by any field or label - **๐Ÿ“Š Complete History**: All interactions are registered automatically ### ๐ŸŽฏ Placeholders in messages: Use dynamic variables in messages for automatic personalization: ``` Hello {{name}}! I saw you work at {{company}}. Is your email {{email}} correct? Notes: {{notes}} ``` ### Typical Flow: 1. **Capture**: Leads arrive via WhatsApp or forms 2. **Enrichment**: Add data using `/chat/editLead` 3. **Segmentation**: Organize with labels 4. **Communication**: Send personalized messages with placeholders 5. **Follow-up**: History is saved automatically **Ideal for**: Sales, marketing, support, lead qualification - name: Chatwoot Integration description: > **๐Ÿšง BETA INTEGRATION - Chatwoot integration system for unified service** **โš ๏ธ WARNING**: This integration is in BETA phase. Use at your own risk. We recommend testing in a non-production environment before use in production. This category contains resources to configure and manage integration with Chatwoot, an open-source customer service platform. The integration allows centralizing WhatsApp conversations in Chatwoot. ### Available Features: - ๐Ÿ”ง **Complete Configuration**: Configure URL, tokens, and Chatwoot credentials - ๐Ÿ“ฌ **Bidirectional Sync**: New messages between WhatsApp and Chatwoot are synced automatically - ๐Ÿ“ฑ **Contact Management**: Automatic sync of names and phones - ๐Ÿ”„ **LIDโ†’PN Update**: Automatic migration from Local ID to Phone Number - ๐Ÿท๏ธ **Smart Names**: Name system with tilde (~) for automatic update - ๐Ÿšซ **Group Separation**: Option to ignore groups in sync - ๐Ÿ‘ค **Message Signature**: Agent identification in sent messages - ๐Ÿ”— **Automatic Webhook**: URL generated automatically to configure in Chatwoot ### ๐Ÿท๏ธ Smart Name System: - **Names with tilde (~)**: Updated automatically when contact modifies name in WhatsApp - **Specific names**: For fixed name, remove tilde (~) from name in Chatwoot - **Example**: "~John Doe" = automatic, "John Doe" = fixed - **LIDโ†’PN Migration**: No conversation duplication during transition - **Native responses**: Appear directly in Chatwoot without external markings ### โš ๏ธ Known Limitations: - **History sync**: Not implemented - only new messages are synced ### Use Cases: - Centralized service in Chatwoot - Support teams with multiple agents - CRM integration via Chatwoot - Communication channel centralization - Automatic contact and name management **Ideal for**: Companies with service teams, call centers, technical support (in test environment) **Requires**: Configured Chatwoot instance, API tokens, and test environment **๐Ÿšง Remember**: BETA integration - features may change without prior notice - name: Server-Sent Events (SSE) paths: /instance/status: get: tags: - Instance summary: Get instance status description: > Returns the current status of an instance, including: - Connection state - Updated QR code (if connecting) - Pairing code (if available) - Information about the last disconnection - Full instance details This endpoint is particularly useful for: 1. Monitoring connection progress 2. Getting updated QR codes during the connection process 3. Checking the current state of the instance 4. Identifying connection problems Possible states: - `disconnected`: Disconnected from WhatsApp - `connecting`: Connecting (waiting for QR code or pairing code) - `connected`: Successfully connected and authenticated - `hibernated`: Session paused, with credentials preserved for reconnection responses: '200': description: Success content: application/json: schema: type: object properties: instance: $ref: '#/components/schemas/Instance' status: type: object properties: connected: type: boolean description: Indicates if connected to WhatsApp loggedIn: type: boolean description: Indicates if authenticated on WhatsApp jid: type: - object - 'null' description: WhatsApp ID when connected example: instance: id: r183e2ef9597845 name: minha-instancia status: connected profileName: Meu WhatsApp currentTime: '2024-01-25T12:00:00.000Z' status: connected: true loggedIn: true jid: user: '5511999999999' agent: 0 device: 0 server: s.whatsapp.net '401': description: Invalid/expired token content: application/json: schema: type: object properties: error: type: string example: instance info not found '404': description: Instance not found '500': description: Internal error components: schemas: Instance: type: object description: Represents a WhatsApp instance properties: id: type: string description: >- Opaque identifier generated by the server. Do not assume UUID format. token: type: string description: Instance authentication token status: type: string description: Current connection status enum: - disconnected - connecting - connected - hibernated paircode: type: string description: Pairing code qrcode: type: string description: Base64 QR Code for authentication name: type: string description: Instance name profileName: type: string description: WhatsApp profile name profilePicUrl: type: string format: uri description: Profile picture URL isBusiness: type: boolean description: Indicates whether it is a business account plataform: type: string description: Source platform (iOS/Android/Web) systemName: type: string description: Operating system name owner: type: string description: Instance owner current_presence: type: string description: Current presence status of the instance (non-persisted field) enum: - available - unavailable example: available lastDisconnect: type: string description: Textual date/time of the last disconnection lastDisconnectReason: type: string description: Reason for the last disconnection adminField01: type: string description: Admin field 01 adminField02: type: string description: Admin field 02 openai_apikey: type: string description: OpenAI API key chatbot_enabled: type: boolean description: Enable automatic chatbot chatbot_ignoreGroups: type: boolean description: Ignore group messages chatbot_stopConversation: type: string description: Keyword to stop conversation chatbot_stopMinutes: type: integer description: How long the chatbot will stay paused when using stop conversation chatbot_stopWhenYouSendMsg: type: integer description: >- How long the conversation will stay paused when you send a message manually fieldsMap: type: object description: Map of the instance's custom fields (when present) additionalProperties: true currentTime: type: string description: Current time returned by the API created: type: string description: >- Creation date returned by the API. Treat the value as text; the format may vary. updated: type: string description: >- Last update date returned by the API. Treat the value as text; the format may vary. example: id: i91011ijkl token: abc123xyz status: connected paircode: 1234-5678 qrcode: data:image/png;base64,iVBORw0KGg... name: Instรขncia Principal profileName: Loja ABC profilePicUrl: https://example.com/profile.jpg isBusiness: true plataform: Android systemName: WppFy owner: user@example.com lastDisconnect: '2025-01-24T14:00:00Z' lastDisconnectReason: Network error adminField01: custom_data openai_apikey: sk-...xyz chatbot_enabled: true chatbot_ignoreGroups: true chatbot_stopConversation: parar chatbot_stopMinutes: 60 created: '2025-01-24T14:00:00Z' updated: '2025-01-24T14:30:00Z' currentPresence: available securitySchemes: token: name: token type: apiKey in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.