n8n-nodes-kudosity

This is an n8n community node for the Kudosity SMS API. It provides functionality to send and manage SMS messages through the Kudosity platform.

Features

• Send SMS messages
• Retrieve SMS details
• List SMS messages with filtering options
• Get available sender numbers
• Support for message references and link tracking
• E.164 phone number format support

Installation

Local Installation

1. Clone the Repository:

   git clone https://github.com/kudosity/n8n-nodes-kudosity.git

2. Install Dependencies:

   cd n8n-nodes-kudosity
   npm install

3. Build the Package:

   npm run build

4. Link to Your n8n Installation: Ensure you have a custom nodes folder for n8n. If it doesn't exist, create it:

   mkdir -p ~/.n8n/custom

   Then, register the package globally from within the repository:

   npm link

   And in the custom nodes folder, link it:

   cd ~/.n8n/custom
   npm link n8n-nodes-kudosity

Global Installation (via npm)

Note: The package is not published on npm, so global installation via npm is not available.

Running n8n

Ensure you are using a supported version of Node.js (v18.17.0, v20, or v22). If you use a Node version manager like fnm, switch to a supported version with:

fnm install 18.17.0
fnm use 18.17.0

Then, launch n8n:

• If n8n is installed globally:

  n8n start

• Or using npx:

  npx n8n

n8n will be accessible at http://localhost:5678.

Configuration

1. Get your Kudosity API key from the Kudosity Developer Portal.
2. In the n8n web interface, go to Settings > Credentials > New.
3. Search for "Kudosity API" and enter your API key.
4. Save the credentials.

Usage

Sending an SMS

1. Add the Kudosity node to your workflow.
2. Select 'SMS' as the Resource.
3. Choose 'Send' as the Operation.
4. Configure the following required fields:
   • Message: Your SMS content.
   • Sender: Your sender number in E.164 format (e.g., 61426306925).
   • Recipient: The recipient's number in E.164 format (e.g., 61438333061).
5. Optionally, configure additional fields:
   • Message Reference: Your system reference.
   • Track Links: Enable link tracking.

Retrieving SMS Details

1. Select 'SMS' as the Resource.
2. Choose 'Get' as the Operation.
3. Enter the SMS ID to retrieve.

Listing SMS Messages

1. Select 'SMS' as the Resource.
2. Choose 'List' as the Operation.
3. Configure optional filters:
   • Start Date
   • End Date
   • Message Reference
   • Sender
   • Recipient
   • Status
   • Direction

Getting Available Senders

1. Select 'Sender' as the Resource.
2. Choose 'Get Available' as the Operation.

Version Control

For version control, ensure the following folders are ignored by adding them to your .gitignore file:

• node_modules/
• build/ or dist/ (if build artifacts are generated)
• .n8n/ (n8n configuration folder, if present)
• *.log

API Documentation

For detailed API documentation, visit Kudosity API Documentation.

Error Handling

The node handles various error scenarios:

• Invalid API key
• Invalid phone numbers
• Rate limiting
• Network errors
• API response errors

Error messages are formatted to be user-friendly in the n8n interface.

Best Practices

1. Always validate phone numbers are in E.164 format:

   • AU: 0438333061 → 61438333061
   • NZ: 0212172782 → 64212172782
   • US: (281)869-1226 → 12818691226

2. Keep messages within length limits:

   • Single SMS: 160 chars/part
   • Multi-part SMS: 153 chars/part
   • Unicode/Emoji SMS: 70 chars/part
   • Unicode Multi-part: 67 chars/part

3. Use message references for tracking and webhook integration.

4. Enable link tracking when sending messages with URLs.

Support

For support, please:

1. Check the Kudosity Documentation.
2. Visit the n8n Community Forum.
3. Contact Kudosity Support.

License

MIT