WaliChat icon

WaliChat

Interact with WaliChat WhatsApp API

Actions148

Chat Files → Get Files

AI-generated

Overview

The node interacts with the WaliChat WhatsApp API to retrieve files associated with WhatsApp chats. Specifically, the "Chat Files" resource with the "Get Files" operation allows users to fetch media and document files exchanged in WhatsApp conversations linked to a specified WhatsApp number. This is useful for scenarios such as archiving chat attachments, analyzing shared media content, or integrating WhatsApp file data into other workflows.

Practical examples include:

  • Automatically downloading images or videos sent to a business WhatsApp number for further processing.
  • Filtering and retrieving documents shared within specific chats for compliance or record-keeping.
  • Searching voice notes or stickers exchanged in conversations for sentiment analysis or customer support review.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number (device) from which to retrieve chat files. This identifies the source WhatsApp account.
Filters A collection of optional filters to narrow down the files retrieved:
- File Type Filter files by media type. Options include: Image, Video, Audio, Voice (push-to-talk), Document, Sticker.
- Search Search files by filename, caption, message ID, or chat ID.
- Chat IDs Filter files by one or more WhatsApp chat IDs (e.g., 447362053576@c.us).
- File IDs Filter files by one or more specific file IDs.
- Message IDs Filter files by origin message WhatsApp IDs.
- Flow Filter files by message flow direction containing the file: Inbound or Outbound.
- Created After Only include files created after this date/time.
- Created Before Only include files created before this date/time.
- Results Page Size Number of results to return per page (pagination size). Default is 20.
- Page Number Page number to retrieve, starting from 0. Used for pagination.
- Sort Sorting criteria for the files returned. Options are: Recent First, Oldest First, Largest First, Smallest First.

Output

The node outputs an array of JSON objects representing the files matching the specified filters. Each object contains metadata about a chat file, such as its ID, type, associated chat and message IDs, creation date, size, and possibly URLs or references to download the actual media content.

If the node supports binary data output (not explicitly shown here), it would typically provide the actual file content in a binary field alongside the JSON metadata.

Dependencies

  • Requires a valid API key credential for authenticating with the WaliChat WhatsApp API.
  • The node depends on the WaliChat API service being accessible and properly configured.
  • Pagination and filtering rely on the API's support for these features.

Troubleshooting

  • Common issues:
    • Invalid or missing WhatsApp number ID will result in no files being returned or an error.
    • Incorrect filter values (e.g., invalid chat IDs or file IDs) may cause empty results.
    • API rate limits or connectivity problems can cause request failures.
  • Error messages:
    • Errors related to authentication usually indicate missing or invalid API credentials.
    • Pagination parameters out of range might cause errors or empty responses.
  • Resolutions:
    • Verify that the WhatsApp number ID is correct and linked to your WaliChat account.
    • Check API credentials and permissions.
    • Adjust filter parameters to valid values.
    • Handle pagination carefully, ensuring page numbers start at 0 and sizes are reasonable.

Links and References

Discussion