Actions20
- Call Actions
- Contact Actions
- Agent Actions
- Phone Number Actions
Overview
This node integrates with the ContactShip API to manage contacts and related data. Specifically, the Contact - Get operation retrieves detailed information about a contact using one of three identifier types: ID, phone number, or email. This is useful in scenarios where you need to fetch contact details dynamically based on different identifiers, such as when syncing contact data from other systems, verifying contact existence, or enriching workflows with contact information.
Practical examples:
- Retrieve a contact's full profile by their unique ID before sending a personalized message.
- Look up a contact by their phone number to check call history or add comments.
- Fetch contact details by email for CRM updates or marketing automation.
Properties
| Name | Meaning |
|---|---|
| Contact Identifier | The value used to identify the contact. It can be the contact's ID, phone number, or email. |
| Identifier Type | Specifies the type of identifier provided. Options are: ID, Phone Number, or Email. |
Output
The output JSON contains the contact data returned by the ContactShip API for the specified identifier. This typically includes all available fields of the contact such as name, phone number, email, country, description, additional custom properties, and metadata.
The structure depends on the API response but generally represents a single contact object with its attributes.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the ContactShip API.
- The node expects the ContactShip API base URL and API key to be configured in the credentials.
- Network access to ContactShip API endpoints is necessary.
Troubleshooting
- Invalid Identifier Format: If the contact identifier (especially phone number) is not in the expected format (e.g., E.164 for phone numbers), the node may throw validation errors. Ensure phone numbers are formatted correctly.
- Contact Not Found: If no contact matches the given identifier, the API may return an empty result or error. Verify the identifier is correct and exists in the system.
- Authentication Errors: Missing or invalid API key will cause authentication failures. Confirm that the API key credential is properly set up.
- API Rate Limits or Downtime: Temporary API issues may cause request failures. Retry after some time or check ContactShip service status.
Links and References
- ContactShip API Documentation (hypothetical link, replace with actual if available)
- E.164 Phone Number Formatting
This summary focuses exclusively on the "Contact" resource with the "Get" operation as requested.