N8N Tools - Yup.chat icon

N8N Tools - Yup.chat

Send messages and manage communications through Yup.chat
Join our community

Actions17

Overview

This node integrates with the Yup.chat API to manage SMS messages, specifically allowing users to retrieve multiple SMS messages ("Get Many" operation). It is useful for scenarios where you want to fetch a list of SMS messages sent or received via Yup.chat, such as for reporting, monitoring communication history, or syncing message data into other systems.

For example, you might use this node to:

  • Retrieve all SMS messages within a certain date range.
  • Fetch a limited number of recent SMS messages for quick review.
  • Apply filters to get messages matching specific criteria (e.g., created after a certain date).

Properties

Name Meaning
Return All Whether to return all SMS messages or only up to a specified limit.
Limit Maximum number of SMS messages to return when "Return All" is false. Value between 1 and 500.
Filters Optional filter parameters to narrow down the results, e.g., filter=created_at:2023-01-01.

Output

The output is an array of JSON objects representing SMS messages retrieved from Yup.chat. Each item corresponds to one SMS message with its associated data fields as returned by the Yup.chat API.

The node does not output binary data for this operation.

Dependencies

  • Requires an API key credential for Yup.chat to authenticate requests.
  • The base URL for the Yup.chat API defaults to https://api.yup.chat but can be configured via credentials.
  • The node uses HTTP requests to interact with the Yup.chat REST API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing API key will cause authentication errors.
    • Incorrect filter syntax may result in empty responses or API errors.
    • Requesting too many items without setting "Return All" to true may truncate results unexpectedly.

  • Error messages:

    • Authentication failures typically indicate problems with the provided API key; verify the credential configuration.
    • HTTP request errors may include rate limiting or invalid parameter errors; check the Yup.chat API documentation for correct usage.
    • If the node throws an error during execution, enabling "Continue On Fail" allows processing to continue while logging the error message in the output.

Links and References

Discussion