Kudosity icon

Kudosity

Send and manage SMS messages via Kudosity
Join our community

Actions2

Overview

This node allows users to list SMS messages managed via the Kudosity service. It is useful for retrieving historical SMS data, filtering messages by various criteria such as date range, sender, recipient, status, and direction. Typical use cases include monitoring message delivery statuses, auditing sent or received messages, and extracting subsets of SMS data for reporting or further processing.

For example, a user might want to retrieve all SMS messages sent within the last month that were successfully delivered, or filter inbound messages from a specific phone number.

Properties

Name Meaning
Return All Whether to return all matching SMS messages or limit the results to a specified maximum number.
Limit The maximum number of SMS messages to return when "Return All" is false. Range: 1 to 100.
Filters A collection of optional filters to narrow down the list of SMS messages:
- Start Date Only include messages sent or received on or after this date (in RFC 3339 format).
- End Date Only include messages sent or received on or before this date (in RFC 3339 format).
- Message Reference Filter messages by a custom reference string assigned to them.
- Sender Filter messages by the sender's phone number.
- Recipient Filter messages by the recipient's phone number.
- Status Filter messages by their delivery status. Options: Sent, Delivered, Hard Bounce, Soft Bounce.
- Direction Filter messages by direction. Options: Inbound, Outbound.

Output

The node outputs JSON data representing the list of SMS messages retrieved from the Kudosity API. Each item in the output array corresponds to an individual SMS message with details such as sender, recipient, message content, timestamps, status, and any other metadata provided by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Kudosity SMS service.
  • The node makes HTTP GET requests to the Kudosity API endpoint /v2/sms to fetch SMS message data.
  • Proper configuration of the API key credential in n8n is necessary for successful authentication.

Troubleshooting

  • Authentication Errors: If the node returns an authentication failure, verify that the API key credential is correctly configured and valid.
  • Invalid Filter Values: Ensure date filters are provided in proper RFC 3339 format; otherwise, the API may reject the request or return no results.
  • Limit Exceeded: The Limit property must be between 1 and 100. Setting values outside this range may cause errors or unexpected behavior.
  • Empty Results: If no messages match the filters, the output will be empty. Double-check filter criteria for correctness.
  • API Endpoint Issues: Network issues or changes in the Kudosity API could cause failures. Check connectivity and API status if problems persist.

Links and References

Discussion