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 messaging and communication tasks across multiple channels, including RCS (Rich Communication Services). Specifically, for the RCS Messages resource with the Get Messages operation, it retrieves messages from a specified chat room.

Use cases include:

  • Fetching conversation history from an RCS-enabled chat room.
  • Monitoring ongoing communications in customer support or sales chat rooms.
  • Archiving or analyzing message data from RCS conversations.

For example, a customer support team could use this node to pull all messages from a particular support room to analyze customer interactions or to feed the data into a CRM system.

Properties

Name Meaning
Room ID The unique identifier of the chat room from which to retrieve messages.
Return All Whether to return all messages or limit the number of results returned.
Limit Maximum number of messages to return if "Return All" is false. Value between 1 and 500.

Output

The output is an array of JSON objects representing individual messages retrieved from the specified RCS chat room. Each item corresponds to one message with its associated metadata as provided by the Yup.chat API.

No binary data output is involved in this operation.

Example output structure (simplified):

[
  {
    "json": {
      "id": "message-id-123",
      "roomId": "room-id-456",
      "from": "sender-identifier",
      "to": "recipient-identifier",
      "body": "Message content",
      "timestamp": "2024-01-01T12:00:00Z",
      ...
    }
  },
  ...
]

Dependencies

  • Requires an API key credential for Yup.chat API access.
  • The node uses the Yup.chat base URL (default: https://api.yup.chat) and authenticates requests via an API key header.
  • No additional external dependencies beyond HTTP access to the Yup.chat API.

Troubleshooting

  • Common issues:

    • Invalid or missing Room ID will cause the API request to fail.
    • Exceeding rate limits imposed by the Yup.chat API may result in errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Errors returned from the API are caught and can be output as error messages if "Continue On Fail" is enabled.
    • Typical error messages might include authentication failures ("Invalid API key"), resource not found ("Room not found"), or parameter validation errors.

  • Resolutions:

    • Verify that the Room ID is correct and exists in your Yup.chat account.
    • Ensure the API key credential is valid and has necessary permissions.
    • Use the "Return All" property carefully to avoid large data requests that might time out.
    • Enable "Continue On Fail" to handle errors gracefully during batch processing.

Links and References

Discussion