Actions17
- Contacts Actions
- SMS Messages Actions
- WhatsApp Messages Actions
- RCS Messages Actions
- Omni Rooms Actions
- Message Templates Actions
Overview
This node integrates with the Yup.chat API to manage communications and messaging across multiple channels such as SMS, WhatsApp, RCS, and Omni Rooms. Specifically, for the Contacts resource with the Get Messages operation (which actually applies to the "rooms" resource), it retrieves messages from a specified chat room.
Use cases include:
- Fetching conversation history from a specific chat room in an omnichannel environment.
- Monitoring or archiving messages exchanged in customer support or sales chat rooms.
- Integrating chat message retrieval into automated workflows for analysis or reporting.
For example, you can use this node to pull all messages from a customer support room to analyze customer interactions or trigger follow-up actions based on message content.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all messages from the room or limit the number of results returned. |
| Limit | Maximum number of messages to return if "Return All" is false. Value between 1 and 500. |
| Room ID | The unique identifier of the room from which to retrieve messages. (Required) |
Note: The Room ID property is required to specify which room's messages to fetch.
Output
The node outputs an array of JSON objects representing messages retrieved from the specified room. Each item corresponds to a single message object as returned by the Yup.chat API.
The exact structure of each message depends on the API response but typically includes fields like message content, sender info, timestamps, and metadata.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for Yup.chat to authenticate requests.
- The node uses the Yup.chat base URL (defaulting to
https://api.yup.chat) and sends HTTP requests to the Yup.chat REST API. - Proper configuration of the Yup.chat API credentials in n8n is necessary.
Troubleshooting
- Common issues:
- Invalid or missing Room ID will cause the API request to fail.
- Incorrect or expired API key will result in authentication errors.
- Requesting too many messages without setting "Return All" may lead to incomplete data.
- Error messages:
- Authentication errors usually indicate invalid API keys; verify and update credentials.
- HTTP 404 errors may mean the specified room does not exist or is inaccessible.
- Rate limiting errors from the API require respecting usage limits or adding delays.
- To resolve errors, ensure all required parameters are correctly set, credentials are valid, and API limits are respected.
Links and References
- Yup.chat API Documentation (for detailed API endpoints and message schema)
- n8n HTTP Request Node Documentation (for understanding how HTTP requests are made within n8n)