ContactShip icon

ContactShip

Interact with ContactShip API for AI Phone Calls
Join our community

Actions20

Overview

This node interacts with the ContactShip API to manage contacts and their related call history. Specifically, the Get Call History operation for the Contact resource retrieves the call records associated with a specified contact. This is useful for scenarios where you want to analyze or audit phone interactions with a particular contact, such as reviewing inbound/outbound calls, filtering by call status, or examining call activity within a date range.

Practical examples include:

  • Fetching all answered calls for a customer in the last month.
  • Retrieving missed outbound calls to follow up on.
  • Auditing call logs filtered by direction (inbound/outbound) and status (answered, missed, rejected, etc.).

Properties

Name Meaning
Contact Identifier The unique identifier of the contact. Can be an ID, phone number, or email.
Filters A collection of filters to narrow down the call history results:
- Start Date Only include calls that occurred on or after this date.
- End Date Only include calls that occurred on or before this date.
- Direction Filter calls by direction: Inbound or Outbound.
- Status Filter calls by call status: Answered, Missed, Rejected, Busy, or Failed.

Output

The output JSON contains the call history data retrieved from the ContactShip API for the specified contact. It typically includes an array of call records, each containing details such as call timestamps, direction, status, duration, and other metadata provided by the API.

No binary data output is produced by this operation.

Example structure (simplified):

{
  "data": [
    {
      "id": "call_id_1",
      "timestamp": "2024-05-01T10:00:00Z",
      "direction": "inbound",
      "status": "answered",
      "duration": 120,
      ...
    },
    {
      "id": "call_id_2",
      "timestamp": "2024-05-02T15:30:00Z",
      "direction": "outbound",
      "status": "missed",
      "duration": 0,
      ...
    }
  ]
}

Dependencies

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

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.
  • Date Filter Issues: Ensure that start and end dates are valid ISO date strings. Incorrect formats may cause the API to reject the request.
  • API Authentication Errors: If the API key is missing or invalid, authentication errors will occur. Confirm that the API key credential is correctly set up.
  • Empty Results: If no call history matches the filters, the output will be empty. Try broadening filter criteria.
  • Rate Limits or Network Issues: Temporary API rate limits or connectivity problems can cause failures. Retry after some time or check network settings.

Links and References

Discussion