Nimba SMS icon

Nimba SMS

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

Actions8

Overview

This node interacts with the Nimba SMS API to manage contacts among other resources. Specifically, the Contact - Get All operation retrieves a list of contacts stored in the Nimba SMS system. It supports filtering and pagination, allowing users to fetch either all contacts or a limited subset based on criteria such as search terms and offset.

Common scenarios where this node is beneficial include:

  • Synchronizing contact lists from Nimba SMS into other systems.
  • Fetching contacts for targeted SMS campaigns.
  • Auditing or reporting on stored contacts.

For example, a marketing automation workflow could use this node to pull all contacts matching a search term, then send personalized SMS messages to them.

Properties

Name Meaning
Return All Whether to return all contacts or only up to a specified limit.
Limit Maximum number of contacts to return (used only if "Return All" is false).
Filters Collection of filters to narrow down results:
  Search Search term to filter contacts by name, number, or other searchable fields.
  Offset The starting index from which to return results, useful for pagination.

Output

The output is a JSON array where each item represents a contact object retrieved from the Nimba SMS API. Each contact typically includes fields such as phone number, name, and associated groups.

Example structure of one contact item (fields may vary):

{
  "numero": "+1234567890",
  "name": "John Doe",
  "groups": ["Group A", "Group B"]
}

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Nimba SMS API via an API key credential configured in n8n.
  • The node uses internal helper functions to format and validate phone numbers and to handle API requests.
  • No additional external dependencies beyond the Nimba SMS API are required.

Troubleshooting

  • Invalid phone number errors: If contacts have improperly formatted phone numbers, the node might throw validation errors. Ensure that phone numbers conform to international formats.
  • API rate limits or authentication failures: Errors related to API access usually indicate missing or invalid API credentials. Verify that the API key is correctly set up in n8n.
  • Empty results despite existing contacts: Check the filter parameters like search and offset. An incorrect offset or overly restrictive search term can result in no returned contacts.
  • Limit ignored when Return All is true: When "Return All" is enabled, the node ignores the "Limit" property and fetches all contacts, which might lead to longer execution times or timeouts if the contact list is very large.

Links and References

Discussion