Wassenger icon

Wassenger

Interact with Wassenger WhatsApp API
Join our community

Actions148

Overview

The "Search Messages" operation under the "Outbound Messages" resource allows users to query and filter outbound WhatsApp messages sent via the Wassenger API. This node is useful for retrieving message records based on various criteria such as status, delivery state, content, sender agent, target type, and time ranges. It supports pagination and sorting, enabling efficient browsing through large sets of messages.

Practical examples include:

  • Fetching all messages that failed to deliver within a specific date range.
  • Searching for messages containing a particular keyword or sent by a certain agent.
  • Retrieving messages targeted to a specific group or channel.
  • Expanding message details to include related device, agent, or event information.

This operation is beneficial for monitoring message delivery, auditing communication history, or integrating message data into workflows for reporting or follow-up actions.

Properties

Name Meaning
Filters A collection of filters to narrow down the search results.
├─ Search Term Text to search in message content, phone number, group, or message IDs.
├─ Status Filter messages by their current status. Options: Queued, Processing, Sent, Delivered, Read, Failed, Pending.
├─ Delivery Status Filter messages by delivery status. Options: Pending, Sent, Delivered, Read, Failed.
├─ Webhook Status Filter messages by webhook callback status. Options: Pending, Success, Failed.
├─ Include Expand subentity documents per message. Options: Device, Agent, Events.
├─ Message IDs Filter by specific message IDs (multiple values allowed).
├─ Agent IDs Filter messages sent by specific agent IDs (multiple values allowed).
├─ Source Origin of message creation. Options: API, Web Chat.
├─ Target Type Kind of chat target. Options: User, Group, Channel.
├─ Message Type Filter messages by type. Options: Text, Image, Video, Audio, Voice, Document, Location, Contact, Buttons, List, Template.
├─ WhatsApp IDs Filter by WhatsApp message IDs (multiple values allowed).
├─ Device IDs Filter by specific device IDs (multiple values allowed).
├─ Device Filter by device ID or phone number.
├─ Reference Filter by message reference (multiple values allowed).
├─ Priority Filter by message priority. Options: Low, Normal, High, Urgent.
├─ Phone Number Filter by target phone number in E.164 format.
├─ Group ID Filter by target group WhatsApp ID.
├─ Channel ID Filter by target channel WhatsApp ID.
├─ Delivery After Filter messages scheduled for delivery after this date/time.
├─ Delivery Before Filter messages scheduled for delivery before this date/time.
├─ Created After Filter messages created after this date/time.
├─ Created Before Filter messages created before this date/time.
├─ Sort Sort order for results. Options: Recent First, Oldest First.
├─ Results Page Size Number of results per page (pagination size).
└─ Page Number Page number to retrieve (starting from 0).

Output

The output is an array of JSON objects representing the outbound messages matching the specified filters. Each object contains detailed information about a message, including but not limited to:

  • Message identifiers and metadata.
  • Status and delivery information.
  • Content and type of the message.
  • Associated device, agent, and event details if requested via the "Include" option.
  • Timestamps for creation and delivery scheduling.

If binary data is involved (not typical for search results), it would represent media files attached to messages, but this operation primarily returns JSON data describing messages.

Dependencies

  • Requires an active connection to the Wassenger WhatsApp API using a valid API key credential.
  • The node depends on the Wassenger API endpoints for outbound messages.
  • Some filter options dynamically load choices (e.g., agents, devices, groups) which require additional API calls to populate dropdowns.

Troubleshooting

  • Common Issues:

    • Invalid or expired API key leading to authentication errors.
    • Using unsupported or malformed filter values causing request failures.
    • Pagination parameters out of range resulting in empty responses.
    • Network connectivity issues preventing API access.

  • Error Messages:

    • Authentication errors typically indicate missing or incorrect API credentials; verify and update the API key.
    • Validation errors on filters suggest checking the input formats, especially for IDs and date-time fields.
    • Rate limiting or quota exceeded errors require waiting or adjusting usage patterns.

Links and References

Discussion