ContactShip icon

ContactShip

Interact with ContactShip API for AI Phone Calls
Join our community

Actions20

Overview

This node integrates with the ContactShip API to manage contacts and related entities such as calls, agents, tags, and boards. Specifically, the "Contact" resource with the "Get All" operation retrieves a list of contacts from the ContactShip system, optionally filtered by contact attributes.

Common scenarios for this node include:

  • Fetching all contacts in an organization for reporting or synchronization.
  • Filtering contacts by full name, email, or phone number to narrow down results.
  • Using the retrieved contact data to trigger further workflows, such as sending messages or updating CRM systems.

Practical example:

  • A user wants to retrieve all contacts whose email contains "example.com" to send a targeted marketing campaign. They configure the node with the "Contact" resource, "Get All" operation, and set the email filter accordingly.

Properties

Name Meaning
Filters Collection of optional filters to narrow down the contacts returned. Options include:
- Full Name: Filter contacts by their full name (string).
- Email: Filter contacts by their email address (string).
- Phone Number: Filter contacts by their phone number (string).

Output

The output is a JSON object containing the data returned by the ContactShip API for the requested contacts. The structure typically includes an array of contact objects with their details such as ID, full name, email, phone number, country, description, and any additional custom or predefined properties.

Example output structure (simplified):

{
  "data": [
    {
      "id": "contact_id_1",
      "full_name": "John Doe",
      "email": "john.doe@example.com",
      "phone_number": "+12125551234",
      "country": "US",
      "description": "Notes about John",
      "additional_data": [ ... ]
    },
    {
      "id": "contact_id_2",
      "full_name": "Jane Smith",
      "email": "jane.smith@example.com",
      "phone_number": "+12125556789",
      "country": "US",
      "description": "",
      "additional_data": [ ... ]
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the ContactShip API.
  • The node uses the ContactShip base URL and API key from the configured credentials.
  • No other external dependencies are required.

Troubleshooting

  • Invalid phone number format error: Although not directly relevant to "Get All", other operations validate phone numbers strictly in E.164 format (e.g., +12124567890). Ensure phone numbers conform to this format when used.
  • API authentication errors: If the API key is missing, invalid, or expired, the node will fail to fetch data. Verify that the API key credential is correctly configured.
  • Empty results: If no contacts match the provided filters, the output data array will be empty. Double-check filter values for correctness.
  • Rate limits or API errors: The ContactShip API may impose rate limits or return errors. Check the error message returned in the node output for guidance.

Links and References

Discussion