ContactShip icon

ContactShip

Interact with ContactShip API for AI Phone Calls
Join our community

Actions20

Overview

This node integrates with the ContactShip API to enable making AI-powered phone calls through a selected agent. Specifically, the "Make AI Phone Call" operation allows users to initiate an outbound call from a chosen phone number to a target phone number, leveraging an AI agent to conduct the conversation.

Common scenarios for this node include:

  • Automating customer outreach or follow-ups using AI agents.
  • Conducting surveys or collecting information via automated calls.
  • Providing AI-driven support or notifications without human intervention.

For example, a sales team could use this node to automatically call leads with a personalized AI agent, passing additional contextual data to tailor the conversation.

Properties

Name Meaning
Agent Select the AI agent that will make the call.
From Number The phone number from which the call will be placed (must be one of your organization's numbers).
To Number The destination phone number to call, in E.164 format (e.g., +12124567890).
Full Name Full name of the person being called.
Country Country of the person being called.
Email Email address of the person being called (optional).
Additional Fields A collection of optional fields:
- Delay Delay in minutes before initiating the call (0 to 1440).
- Additional Data Key-value pairs of extra data to pass to the agent during the call, allowing customization.

Output

The node outputs JSON data representing the response from the ContactShip API after attempting to make the AI phone call. This typically includes details about the initiated call such as call ID, status, and metadata returned by the API.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "callId": "string",
  "status": "string",
  "details": {
    // Additional call metadata
  }
}

Dependencies

  • Requires an API key credential for the ContactShip service configured in n8n.
  • The node makes HTTP requests to the ContactShip API base URL using this credential.
  • Phone numbers used must be pre-registered and available in the ContactShip account.
  • Proper formatting of phone numbers in E.164 format is mandatory.

Troubleshooting

  • Invalid phone number format error: The node validates both "From Number" and "To Number" inputs to ensure they conform to E.164 format. If you see errors like Invalid "from" phone number format, verify that the numbers start with "+" followed by country code and digits (e.g., +12124567890).

  • API authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions.

  • Call initiation failures: Check if the selected agent and phone numbers are active and properly configured in your ContactShip account.

  • Delay not working as expected: The delay value is in minutes; setting it too high may cause unexpected scheduling delays.

If the node returns an error message from the API, review the message for hints on missing or invalid parameters.

Links and References

Discussion