Numi Contacts icon

Numi Contacts

Numi Contacts Node
Join our community

Overview

The Numi Contacts node allows you to interact with a contact management service, enabling you to either retrieve or create contacts associated with a user's phone number. This node is useful in scenarios where you need to automate the process of fetching user contacts (with optional search by name or family relation) or programmatically add new contacts to a user's address book.

Practical examples:

  • Retrieve all contacts for a given user and filter them by name or relationship (e.g., "mom", "brother").
  • Add a new contact to a user's contact list with details such as phone number, name, email, and country code.
  • Integrate with chatbots or voice assistants to fetch or create contacts based on user input.

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 phone number of the user whose contacts are being accessed or modified. Required for both operations.
Search by Name Contact (Get Contacts only) Optional. Filter contacts by matching their name.
Search by Family Relation (Get Contacts only) Optional. Filter contacts by predefined relations (e.g., "mom", "brother").
Contact Phone (Create Contacts only) The phone number of the contact to be created.
firstName Contact (Create Contacts only) The first name of the contact to be created.
lastName Contact (Create Contacts only) The last name of the contact to be created.
Email Contact (Create Contacts only) The email address of the contact to be created.
countryCode Contact (Create Contacts only) The country code of the contact to be created.

Output

For "Get Contacts" operation:

  • contacts: An array of contact objects retrieved for the specified user. If filters are applied, this array may contain only matching contacts.
  • response_contacts: An object containing a message field that summarizes the result, such as listing matched names, confirming a single match, or indicating no matches found.

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 request, under the key createContacts.

Example output:

{
  "response_create_Contacts": {
    "createContacts": {
      // ...result from the contact creation API
    }
  }
}

Dependencies

  • External Service: Requires access to a partner service (via PartnerServiceFactory) for contact retrieval and creation.
  • API Key: Requires n8n credentials named numiKeyApi.
  • Node Package: Uses the fast-fuzzy package for fuzzy searching contact names.

Troubleshooting

Common issues:

  • Missing or invalid API key: Ensure the numiKeyApi credential is correctly configured in n8n.
  • User Phone Number required: This property must be provided; otherwise, the node will not function.
  • No contacts found: If the search criteria do not match any contacts, the response will indicate no matches. Double-check your search terms.
  • Error during contact creation: If the contact cannot be created (e.g., due to invalid data), the node may return an error in the output.

Common error messages:

  • "you have no contacts with that name, want to list your contacts?": No contacts matched the search name.
  • Empty contacts array: No contacts found for the given criteria.
  • Errors thrown during contact creation are returned in the output; check the response_create_Contacts field for details.

Links and References

Discussion