Maytapi icon

Maytapi

Integrate with Maytapi WhatsApp Unofficial API

Actions55

Chat → Get Conversations

AI-generated

Overview

This node integrates with the Maytapi WhatsApp Unofficial API to manage WhatsApp chats and conversations programmatically. Specifically, the Chat - Get Conversations operation retrieves a paginated list of WhatsApp conversations associated with a given phone instance.

Use cases include:

  • Fetching recent chat conversations for monitoring or analytics.
  • Building dashboards that display active WhatsApp conversations.
  • Automating workflows based on conversation data, such as triggering alerts or follow-ups.

For example, you can use this operation to get the first page of conversations from your WhatsApp instance to analyze customer interactions or to sync chat metadata into a CRM system.

Properties

Name Meaning
Phone ID Source Select how to provide the Phone ID: either "From Credentials" (uses stored credential) or "Custom" (enter manually).
Phone ID The WhatsApp instance Phone ID to use when "Custom" is selected as Phone ID Source. Required in that case.
Page Page number for pagination (0-based). Allows fetching conversations page by page. Optional; defaults to 0.

Output

The output is a JSON object representing the response from the Maytapi API's getConversations endpoint. It typically contains an array of conversation objects with details such as conversation IDs, timestamps, participants, and message summaries.

The exact structure depends on the Maytapi API but generally includes:

  • Conversation identifiers (e.g., phone numbers or group IDs).
  • Metadata about each conversation (last message time, unread counts, etc.).
  • Pagination information if applicable.

No binary data is returned by this operation.

Dependencies

  • Requires an API key credential for the Maytapi WhatsApp API.
  • The Phone ID must be provided either via credentials or custom input.
  • The node makes HTTP requests to https://api.maytapi.com/api/{phoneId}/getConversations.

Troubleshooting

  • Missing Phone ID Error: If neither credentials nor custom Phone ID is provided, the node throws "Phone ID is required." Ensure you have set the Phone ID correctly.
  • Invalid Page Number: Providing a negative page number may cause unexpected results or errors. Use zero or positive integers.
  • API Errors: Network issues or invalid API keys will result in errors from the Maytapi API. Verify your API key and network connectivity.
  • Empty Results: If no conversations are returned, check that the Phone ID corresponds to an active WhatsApp instance with conversations.

Links and References

Discussion