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 SMS messages, among other communication channels. Specifically, for the SMS Messages resource and the Get Messages operation, it retrieves messages from a specified room in the Yup.chat system.
Typical use cases include:
- Fetching conversation history from a chat room for analysis or record-keeping.
- Integrating message retrieval into automated workflows, such as triggering actions based on received messages.
- Monitoring communications in real-time by periodically fetching new messages.
For example, a user might configure this node to get the latest 100 messages from a customer support room to analyze customer inquiries automatically.
Properties
| Name | Meaning |
|---|---|
| Room ID | The unique identifier of the room from which to retrieve messages. |
| Return All | Whether to return all messages available or limit the number of results returned. |
| Limit | Maximum number of messages to return if "Return All" is false. Value range: 1 to 500. |
Output
The node outputs an array of message objects under the json field. Each object represents a single message retrieved from the specified room. The exact structure of each message object depends on the Yup.chat API response but typically includes details such as message content, sender information, timestamps, and message metadata.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for Yup.chat API authentication.
- The base URL for the Yup.chat API defaults to
https://api.yup.chatbut can be configured via credentials. - Network access to the Yup.chat API endpoint is necessary.
Troubleshooting
Common issues:
- Invalid or missing API key will cause authentication failures.
- Incorrect Room ID may result in empty responses or errors.
- Exceeding rate limits imposed by the Yup.chat API could lead to temporary blocking.
Error messages:
- Authentication errors typically indicate invalid credentials; verify the API key.
- "Room not found" or similar errors suggest the Room ID is incorrect or inaccessible.
- Timeout or network errors imply connectivity issues; check internet access and API availability.
To resolve these, ensure correct API credentials are set up, verify the Room ID, and confirm network connectivity.
Links and References
- Yup.chat API Documentation (for detailed API endpoints and message schema)
- n8n Documentation on Creating Custom Nodes