Overview
This node enables sending SMS messages through the Alive5 API. It is designed to facilitate communication by allowing users to send text messages from a selected channel and user within that channel to any valid phone number.
Common scenarios where this node is beneficial include:
- Automated customer notifications or alerts sent via SMS.
- Integrating SMS messaging into workflows for support or sales teams.
- Sending reminders, confirmations, or updates directly to customers' phones.
For example, a business could use this node to automatically send appointment reminders to clients by selecting the appropriate communication channel and agent, specifying the recipient's phone number, and composing the message.
Properties
| Name | Meaning |
|---|---|
| Channel Name or ID | Select the communication channel to send the SMS from. Options are dynamically loaded from available channels. |
| User Name or ID | Select the user (agent) within the chosen channel who will be associated with sending the SMS. |
| To Phone Number | The destination phone number to which the SMS will be sent. Must be in E.164 format (e.g., +1234567890). |
| Message | The content of the SMS message to send. |
Output
The node outputs JSON data containing 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.
The output structure is an array of objects, each with a json property holding the API response for the corresponding input item. If an error occurs and "Continue On Fail" is enabled, the output will include an error field describing the issue.
No binary data is produced by this node.
Dependencies
- Requires an API key credential for authenticating requests to the Alive5 API.
- The node makes HTTP requests to the Alive5 API endpoints:
- To fetch available channels and agents:
GET https://api.alive5.com/public/1.1/objects/channels-and-users/list - To send SMS messages:
POST https://api.alive5.com/public/1.1/conversations/sms/send
- To fetch available channels and agents:
- Proper configuration of the API key credential in n8n is necessary for successful operation.
Troubleshooting
- Invalid Channel or User Selection: If the specified channel or user ID does not exist or is invalid, the node will throw an error indicating the channel was not found.
- Phone Number Format Errors: Both the sender's ("From") and recipient's ("To") phone numbers must be in E.164 format (e.g., +1234567890). If not, the node will raise an error specifying the invalid format.
- API Request Failures: Network issues or incorrect API keys can cause request failures. Check that the API key is valid and has the necessary permissions.
- Empty or Missing Inputs: Required properties such as channel, user, phone number, and message must be provided; otherwise, the node will fail.
- Error Handling: If "Continue On Fail" is enabled, the node will output error details per item instead of stopping execution.
Links and References
- Alive5 API Documentation (for reference on endpoints and usage)
- n8n Expressions Documentation (for using expressions in property fields)