ContactShip icon

ContactShip

Interact with ContactShip API for AI Phone Calls

Overview

This node integrates with the ContactShip API to manage contacts and related data such as comments, call history, tags, boards, and agents. Specifically, the Contact - Add Comment operation allows users to add a comment to an existing contact by specifying the contact identifier, the content of the comment, and the email of the person creating it.

Common scenarios for this node include:

  • Adding notes or remarks to a contact record after interactions.
  • Logging feedback or additional information related to a contact.
  • Collaborating within teams by attaching comments to contacts for shared context.

Practical example:

  • After a customer support call, automatically add a comment summarizing the conversation to the customer's contact record.

Properties

Name Meaning
Contact Identifier The unique identifier of the contact. Can be an ID, phone number, or email address.
Content The text content of the comment to add to the contact.
Created By Email address of the person who is creating the comment.

Output

The output JSON contains the response from the ContactShip API after adding the comment. This typically includes details about the newly created comment such as its ID, content, creator, timestamp, and associated contact ID.

Example output structure (simplified):

{
  "id": "comment_id",
  "content": "The comment text",
  "created_by": "creator_email",
  "contact_id": "contact_identifier",
  "created_at": "timestamp"
}

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the ContactShip API via an API key credential.
  • The node expects the API base URL and API key to be configured in the credentials.
  • Network access to ContactShip API endpoints is necessary.

Troubleshooting

  • Invalid Contact Identifier: If the contact identifier does not exist or is malformed, the API may return an error. Verify that the identifier is correct and corresponds to an existing contact.
  • Missing Required Fields: The content and createdBy fields are required. Omitting them will cause errors.
  • API Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Rate Limits or Network Issues: Temporary failures might occur due to network problems or API rate limits; retrying later may help.
  • Phone Number Format: Although not directly relevant to adding comments, other operations require phone numbers in E.164 format (e.g., +12124567890).

Links and References

Discussion