> ## 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. # Group message status > Shows who received and who read a message you sent in a group: first a summary with the totals, then the list of each participant. `source` tells where the response came from. - `source: "memory"`: once this route is used for a group, the API starts tracking in memory the receipts of the instance's groups, up to 24 hours after the last query. From then on, messages sent after that point and the ones the phone has already answered are served from there, instantly and without depending on the phone, with the receipts that arrived later added up. Each message stays in memory for up to 24 hours; on instances with heavy group sending, the oldest ones are evicted earlier. - `source: "phone"`: the first query for a message sent before that, or for any message after a server restart, asks the account's phone. The phone must be on and connected to the internet. With WhatsApp open, the response comes in about 1 second; with the phone idle (an iPhone in the background, for example), it may not come. With no response within 40 seconds, the route returns `504`. The list is the one stored by the phone: right after being offline, it may respond before receiving the receipts that arrived in the meantime. - `summary`: how many participants received (`delivered`) and read (`read`). Those who read also count as received, and those who listened to an audio or watched a video count as read. - `receipts`: one item per participant and state, in time order and paginated, like the other API lists: for the next page, send `pagination.nextOffset` in `offset` while `pagination.hasMore` is `true`. The summary comes in all pages. - Those who read may come without the `Delivered` item, when the phone did not store the delivery time. - `state` filters the list by state: `Delivered`, `Read` or `Played`. The summary keeps the message totals. - `id` accepts the full or short message ID, which must be in the instance's history. - The API does not store receipts in a database. To track them live, use the `messages_update` webhook with `type: "GroupReceipts"`. ## OpenAPI ````yaml /openapi-en.json post /message/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: /message/status: post: tags: - Message Actions and Search summary: Group message status description: > Shows who received and who read a message you sent in a group: first a summary with the totals, then the list of each participant. `source` tells where the response came from. - `source: "memory"`: once this route is used for a group, the API starts tracking in memory the receipts of the instance's groups, up to 24 hours after the last query. From then on, messages sent after that point and the ones the phone has already answered are served from there, instantly and without depending on the phone, with the receipts that arrived later added up. Each message stays in memory for up to 24 hours; on instances with heavy group sending, the oldest ones are evicted earlier. - `source: "phone"`: the first query for a message sent before that, or for any message after a server restart, asks the account's phone. The phone must be on and connected to the internet. With WhatsApp open, the response comes in about 1 second; with the phone idle (an iPhone in the background, for example), it may not come. With no response within 40 seconds, the route returns `504`. The list is the one stored by the phone: right after being offline, it may respond before receiving the receipts that arrived in the meantime. - `summary`: how many participants received (`delivered`) and read (`read`). Those who read also count as received, and those who listened to an audio or watched a video count as read. - `receipts`: one item per participant and state, in time order and paginated, like the other API lists: for the next page, send `pagination.nextOffset` in `offset` while `pagination.hasMore` is `true`. The summary comes in all pages. - Those who read may come without the `Delivered` item, when the phone did not store the delivery time. - `state` filters the list by state: `Delivered`, `Read` or `Played`. The summary keeps the message totals. - `id` accepts the full or short message ID, which must be in the instance's history. - The API does not store receipts in a database. To track them live, use the `messages_update` webhook with `type: "GroupReceipts"`. requestBody: required: true content: application/json: schema: type: object required: - id properties: id: type: string description: Message ID (full or short). example: 3EB0538DA65A59F6D8A251 state: type: string enum: - Delivered - Read - Played description: Only receipts in this state. Without it, all of them. limit: type: integer minimum: 1 maximum: 500 default: 100 description: Items per page. Values above 500 use 500. offset: type: integer minimum: 0 default: 0 description: >- Zero-based offset; use the `pagination.nextOffset` from the previous page. responses: '200': description: Summary and page of receipts, in chronological order. content: application/json: schema: type: object required: - source - summary - receipts - pagination properties: source: type: string enum: - memory - phone description: >- Where the response came from: `memory` (confirmations the API tracked, added to the phone's previous response when there was one) or `phone` (the account's phone, in this query). summary: type: object description: Participant totals; the same on every page. required: - delivered - read properties: delivered: type: integer format: int64 description: >- Participants who received, including those who read or listened. read: type: integer format: int64 description: >- Participants who read, including those who listened to an audio or watched a video. receipts: type: array items: type: object required: - participant - participant_pn - participant_lid - state - timestamp properties: participant: type: string description: >- Who confirmed: the number when known; otherwise, the LID. participant_pn: type: - string - 'null' participant_lid: type: - string - 'null' state: type: string enum: - Delivered - Read - Played timestamp: type: integer format: int64 description: >- Unix seconds of this receipt, as stored by the phone. pagination: type: object required: - totalRecords - limit - offset - hasMore - nextOffset properties: totalRecords: type: integer format: int64 description: Total receipts for the message. limit: type: integer description: Limit applied to the current page. offset: type: integer description: >- Returned offset, limited to the range from zero to totalRecords. hasMore: type: boolean description: There are more acknowledgments after this page. nextOffset: type: integer description: Offset of the next page. '400': description: Invalid payload or missing `id` '401': description: Invalid or missing token '404': description: Message outside the instance's history or from another number '500': description: Error fetching the message '503': description: Instance offline, no way to ask the phone '504': description: >- The phone did not respond within 40 seconds; it must be turned on and connected to the internet components: securitySchemes: token: name: token type: apiKey in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.