Overview
The Numi Contacts node allows you to interact with a contact management system via two main operations: retrieving contacts associated with a user's phone number, and creating new contacts for that user. This node is useful in scenarios where you need to automate the process of fetching or adding contacts based on user input, such as integrating with chatbots, CRM systems, or automating personal assistant workflows.
Practical examples:
- Fetching a list of contacts for a given user and searching by name or family relation.
- Creating a new contact (with details like phone, name, email, country code) for a user programmatically.
Properties
| Name | Meaning |
|---|---|
| Operation | Selects the action to perform: - Get Contacts: Retrieve contacts for a user. - Create Contacts: Add a new contact for a user. |
| User Phone Number | The telephone number of the user whose contacts are being managed. Required for both operations. |
| Search by Name Contact | (Get Contacts only) Filter contacts by the contact's name. |
| Search by Family Relation | (Get Contacts only) Filter contacts by family relation (e.g., "mom", "brother"). |
| Contact Phone | (Create Contacts only) The phone number of the contact to create. |
| firstName Contact | (Create Contacts only) The first name of the contact to create. |
| lastName Contact | (Create Contacts only) The last name of the contact to create. |
| Email Contact | (Create Contacts only) The email address of the contact to create. |
| countryCode Contact | (Create Contacts only) The country code of the contact to create. |
Output
For "Get Contacts" operation:
contacts: An array of contact objects retrieved for the specified user. If search filters are applied, this array may be filtered accordingly.response_contacts: An object containing amessagefield, which provides feedback about the search results (e.g., listing matching names, asking for clarification, or indicating no matches).
Example output:
{
"contacts": [
{
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
// ...other contact fields
}
],
"response_contacts": {
"message": "John Doe"
}
}
For "Create Contacts" operation:
response_create_Contacts: An object containing the result of the contact creation operation, under the keycreateContacts.
Example output:
{
"response_create_Contacts": {
"createContacts": {
// ...result from the contact creation API
}
}
}
Dependencies
- External Service: Requires access to a partner service (via
PartnerServiceFactory) for managing contacts. - API Key: Requires n8n credentials named
numiKeyApi. - Node dependencies: Uses the
fast-fuzzylibrary for fuzzy searching contact names.
Troubleshooting
- Missing or invalid API key: If the required
numiKeyApicredential is not configured, the node will fail to connect to the external service. - Empty or incorrect User Phone Number: The node requires a valid user phone number; missing or invalid values will result in errors or empty results.
- No matching contacts found: When searching by name or family relation, if no contacts match, the response will indicate this and may prompt to list all contacts.
- Error during contact creation: If the contact cannot be created (e.g., due to invalid data), the error will be returned in the output.
Links and References
- n8n Documentation: Credentials
- fast-fuzzy npm package
- (If available) Documentation for your specific partner service API.