ContactShip icon

ContactShip

Interact with ContactShip API for AI Phone Calls
Join our community

Actions20

Overview

This node integrates with the ContactShip API to manage agents, contacts, calls, credits, and phone numbers within an AI phone call system. Specifically, for the Agent - Get operation, it retrieves detailed information about a single agent by their unique ID.

Use cases include:

  • Fetching agent details such as name, voice settings, language, and conversation purpose.
  • Integrating agent data into workflows that require dynamic access to agent configurations.
  • Automating updates or audits of agent profiles in bulk processes.

Example: You want to retrieve the configuration of a specific AI agent before initiating a call or updating its settings.

Properties

Name Meaning
Agent ID The unique identifier of the agent to retrieve. This is required to specify which agent's details to fetch.

Output

The output JSON contains the full data object returned by the ContactShip API for the requested agent. This typically includes fields such as:

  • id: Agent's unique ID.
  • name: Reference name of the agent.
  • person_name: Name used during calls.
  • voice_id: Identifier of the voice used.
  • language: Language setting for speech recognition.
  • ambient_sound: Background sound setting.
  • webhook_url: URL for webhook notifications.
  • conversation_purpose: Purpose description of conversations.
  • prompt: Prompt template text.
  • voice_speed, voice_temperature, volume: Voice characteristics.
  • interruption_sensitivity: Sensitivity to interruptions during calls.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for the ContactShip API.
  • The node uses the ContactShip API base URL and API key from configured credentials.
  • Network connectivity to ContactShip API endpoints is necessary.

Troubleshooting

  • Invalid Agent ID: If the provided Agent ID does not exist or is malformed, the API will return an error. Verify the Agent ID is correct.
  • Authentication Errors: Missing or invalid API key credential will cause authentication failures. Ensure the API key is correctly set up in n8n credentials.
  • Network Issues: Connectivity problems to the ContactShip API endpoint can cause request failures. Check network access and firewall rules.
  • API Rate Limits: Excessive requests may be throttled by the API. Implement retry logic or reduce request frequency if needed.

Links and References

Discussion