Alive5 Send SMS icon

Alive5 Send SMS

Send SMS messages via Alive5 API
Join our community

Overview

This node allows sending SMS messages via the Alive5 API. It is designed to facilitate communication by programmatically sending text messages from a specified phone number through a chosen channel and user ID. This node is useful in scenarios such as automated notifications, alerts, marketing campaigns, or any workflow requiring SMS delivery.

For example, you can use this node to send appointment reminders to customers, notify users about system status changes, or deliver verification codes.

Properties

Name Meaning
Channel The communication channel to use for sending the SMS. Options are dynamically loaded from Alive5 API channels.
User ID The identifier of the user who is sending the SMS message.
From Phone Number The phone number from which the SMS will be sent. Must include the country code with a "+" prefix (e.g., +15402173882).
To Phone Number The recipient's phone number. Must include the country code with a "+" prefix (e.g., +18888888888).
Message The content of the SMS message to send. Supports multiline input.

Output

The node outputs JSON data representing the response from the Alive5 API after attempting to send the SMS. Each output item corresponds to an input item processed and contains either the successful response data or an error message if sending failed.

If the node encounters an error during sending and "Continue On Fail" is enabled, it outputs an object with an error field containing the error message for that item.

No binary data is produced by this node.

Dependencies

  • Requires an API key credential for the Alive5 API.
  • The node makes HTTP requests to:
    • https://api-v2.alive5.com/public/1.0/objects/channels-and-users/list to load available channels.
    • https://api.alive5.com/public/1.0/conversations/sms/send to send SMS messages.
  • Proper configuration of the API key credential in n8n is necessary for authentication.

Troubleshooting

  • Missing API Key: If no API key is provided in credentials, the node throws an error "No API key provided in credentials". Ensure the API key credential is configured correctly.
  • Invalid Channel/User ID/Phone Numbers: Providing invalid or empty values for required fields like Channel, User ID, or phone numbers may cause the API request to fail. Verify all inputs are correct and formatted properly (phone numbers must include country code with "+" prefix).
  • API Request Failures: Network issues or incorrect API keys can lead to request failures. Check network connectivity and API key validity.
  • Error Handling: If "Continue On Fail" is enabled, errors for individual items will be returned in the output JSON under an error property instead of stopping execution.

Links and References

Discussion