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 their related data, including comments, call history, tags, boards, and more. Specifically, the "Get Comments" operation under the "Contact" resource retrieves all comments associated with a specified contact. This is useful for scenarios where you want to review or process notes, feedback, or communication logs linked to a contact within your workflows.

Practical examples:

  • Automatically fetching all comments on a contact to analyze customer feedback.
  • Integrating contact comments into CRM systems or support ticketing tools.
  • Triggering follow-up actions based on comment content or timestamps.

Properties

Name Meaning
Contact Identifier The unique identifier of the contact whose comments you want to retrieve. This can be an ID, phone number, or email.

Output

The output json field contains the data returned by the ContactShip API for the comments associated with the specified contact. It typically includes an array of comment objects, each containing details such as content, creation date, author information, and possibly other metadata related to each comment.

No binary data is output by this operation.

Example structure (simplified):

[
  {
    "id": "comment-id",
    "content": "Comment text",
    "created_at": "2024-01-01T12:00:00Z",
    "created_by": "user@example.com",
    "contact_id": "contact-id"
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the ContactShip API.
  • The node depends on the ContactShip API endpoint /v1/contacts/{contactIdentifier}/comments.
  • Proper configuration of the API base URL and authentication credentials in n8n is necessary.

Troubleshooting

  • Invalid Contact Identifier: If the contact identifier is incorrect or does not exist, the API may return an error or empty results. Verify the identifier format and existence.
  • Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions.
  • API Rate Limits: Excessive requests might lead to rate limiting; consider adding delays or handling retries.
  • Network Issues: Connectivity problems can cause request failures; check network access to the ContactShip API.

Common error messages:

  • "Invalid API key": Check and update the API key credential.
  • "Contact not found": Confirm the contact identifier is correct.
  • "Request timed out": Retry or check network connectivity.

Links and References

Discussion