ContactShip

Interact with ContactShip API for AI Phone Calls

Actions20

Overview

This node integrates with the ContactShip API to manage phone numbers within an organization. Specifically, the "Phone Number" resource with the "Get All" operation allows users to retrieve a list of all phone numbers associated with their ContactShip account. This is useful for scenarios where you need to display, filter, or process organizational phone numbers in bulk, such as syncing phone number data with other systems, auditing available numbers, or selecting numbers for outbound calls.

Practical examples:

Fetching all phone numbers to populate a dropdown menu in a workflow.
Retrieving phone numbers to analyze usage or assign them dynamically.
Exporting phone number data for reporting or backup purposes.

Properties

Name	Meaning
Options	Collection of optional parameters to control the query results:
	- Limit: Maximum number of phone numbers to return (1 to 100, default 20).
	- Offset: Number of phone numbers to skip before starting to collect results (default 0).
	- Order: Sort order of results, either Ascending or Descending (default Descending).

Output

The output JSON contains a data field which is an array of phone number objects. Each object includes:

id: Unique identifier of the phone number record.
phone_number: The phone number string.
alias: Optional alias or label for the phone number.
type: Type/category of the phone number.
created_at: Timestamp when the phone number was created.

Additionally, a pagination object is included that provides metadata about the result set, such as total count and paging information.

No binary data is output by this operation.

Example output snippet:

{
  "data": [
    {
      "id": "123",
      "phone_number": "+12125551234",
      "alias": "Main Line",
      "type": "mobile",
      "created_at": "2023-01-01T12:00:00Z"
    },
    ...
  ],
  "pagination": {
    "total": 50,
    "limit": 20,
    "offset": 0
  }
}

Dependencies

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

Troubleshooting

Invalid Credentials: If authentication fails, verify that the API key credential is correctly configured and has necessary permissions.
Rate Limits or Pagination Issues: If not all phone numbers are returned, adjust the Limit and Offset options to paginate through results.
Empty Results: Ensure your organization actually has phone numbers registered in ContactShip; otherwise, the data array will be empty.
API Errors: Network issues or API downtime can cause errors; check connectivity and ContactShip service status.

Links and References

ContactShip API Documentation (hypothetical link)
n8n Documentation on Creating Custom Nodes
E.164 Phone Number Format Reference: https://en.wikipedia.org/wiki/E.164

ContactShipInstall