Overview
This node integrates with the Alive5 API to send SMS messages. It allows users to select a communication channel and an agent (user) within that channel, specify a recipient phone number, and compose a message to be sent via SMS.
Common scenarios where this node is beneficial include:
- Automating customer notifications or alerts via SMS.
- Sending personalized messages from specific channels or agents.
- Integrating SMS messaging into workflows for marketing, support, or transactional communications.
For example, a business could use this node to automatically send appointment reminders to customers by selecting the appropriate channel and agent responsible for the communication.
Properties
| Name | Meaning |
|---|---|
| Channel Name or ID | Select a communication channel from a list loaded dynamically or specify its ID via expression. |
| User Name or ID | Select a user (agent) associated with the chosen channel or specify their ID via expression. |
| To Phone Number | The recipient's phone number in E.164 format (e.g., +1234567890) to which the SMS will be sent. |
| Message | The text content of the SMS message to be sent. |
Output
The node outputs JSON data representing the response from the Alive5 API after attempting to send the SMS. This includes details about the message delivery status and any relevant metadata returned by the API.
If the node encounters errors during execution and "Continue On Fail" is enabled, it outputs the original input data along with error information for each failed item.
The node does not output binary data.
Dependencies
- Requires an API key credential for authenticating requests to the Alive5 API.
- Makes HTTP GET requests to fetch available channels and agents.
- Makes HTTP POST requests to send SMS messages via the Alive5 API endpoint.
- Uses form-data encoding for sending SMS message parameters.
Troubleshooting
- Invalid phone number format: Both sender ("From") and recipient ("To") phone numbers must be in E.164 format (e.g., +1234567890). Errors will be thrown if the format is incorrect.
- Channel not found: If the specified channel ID does not exist in the fetched list, the node throws an error indicating the channel was not found.
- API request failures: Network issues or invalid API keys can cause request failures. Check that the API key credential is correctly configured and has necessary permissions.
- Empty or missing required fields: Ensure all required properties (channel, user, phone number, message) are provided; otherwise, the node will fail.
- Loading options failure: If channels or agents fail to load in dropdowns, verify API connectivity and credentials.
Links and References
- Alive5 API Documentation (for reference on endpoints used)
- n8n Expressions Documentation (for using expressions in property fields)