Nimba SMS icon

Nimba SMS

Send SMS, manage campaigns, and track delivery reports using the Nimba SMS API with ease.

Actions8

Overview

The node integrates with the Nimba SMS API to retrieve multiple SMS messages based on specified criteria. It is useful for scenarios where users want to fetch a list of SMS messages sent or received, filter them by status or search terms, and control pagination through limits and offsets. For example, a marketing team could use this node to pull all sent messages within a campaign period or a support team might retrieve failed messages to investigate delivery issues.

Properties

Name Meaning
Return All Whether to return all matching SMS messages or limit the number of results returned.
Limit Maximum number of SMS messages to return when not returning all (minimum 1).
Additional Fields Optional filters and pagination controls:
- Search A search term to filter SMS messages by content or metadata.
- Status Filter messages by their status. Options: Failure, No Credit, Not Available, Received, Sent.
- Offset The starting index from which to return results, used for pagination.

Output

The output is an array of JSON objects representing SMS messages retrieved from the Nimba SMS API. Each object contains details about an individual message such as its content, sender, recipient, status, timestamps, and other metadata provided by the API.

If "Return All" is enabled, the node fetches all available messages matching the criteria; otherwise, it returns up to the specified limit starting from the offset.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Nimba SMS API using an API key credential configured in n8n.
  • The node uses internal helper functions to make authenticated HTTP requests to the Nimba SMS API endpoints.
  • No additional external dependencies are required beyond the configured API credentials.

Troubleshooting

  • Common Issues:

    • Providing invalid filter values (e.g., unsupported status) may result in empty results or API errors.
    • Setting very high limits without "Return All" may cause performance delays or timeouts depending on API rate limits.
    • Incorrect offset values can lead to unexpected pagination results.
  • Error Messages:

    • Errors related to authentication usually indicate missing or invalid API credentials.
    • Network or API errors may occur if the Nimba SMS service is unreachable or returns an error response.
    • If no messages match the filters, the output will simply be an empty array rather than an error.

To resolve these:

  • Verify API credentials are correctly set up.
  • Adjust filters and pagination parameters to valid values.
  • Check network connectivity and API service status.

Links and References

Discussion