ContactShip icon

ContactShip

Interact with ContactShip API for AI Phone Calls
Join our community

Actions20

Overview

The node allows updating an existing Agent's details in the ContactShip system via its API. This operation is useful when you want to modify properties of an AI phone call agent, such as changing their voice settings, language, or webhook URL for notifications.

Typical use cases include:

  • Adjusting the speech characteristics (speed, volume, temperature) of an AI agent.
  • Updating the agent’s name or the person name used during calls.
  • Changing the language or ambient sound environment for better call experience.
  • Setting or modifying a webhook URL to receive call event notifications.
  • Defining or updating the conversation purpose or prompt template for the agent.

For example, you might update an agent to speak with a British English accent at a slower speed and add a webhook URL to track call events.

Properties

Name Meaning
Agent ID The unique identifier of the agent to update.
Update Fields A collection of fields to update on the agent:
- Name Reference name of the agent in your system.
- Person Name Name of the agent as it appears in calls.
- Voice ID Identifier of the voice to be used by the agent.
- Language Language for speech recognition. Options include English (US, UK, India), Spanish, German, French, Italian, Portuguese (Brazil, Portugal), Dutch, Hindi, Japanese, Chinese, Russian, Korean, Polish, Turkish, Vietnamese, Multilingual. Default is English (US).
- Ambient Sound Background ambient sound during calls. Options: None, Coffee Shop, Convention Hall, Summer Outdoor, Mountain Outdoor, Static Noise, Call Center. Default is None.
- Webhook URL URL to receive webhook notifications after calls.
- Conversation Purpose Description of the purpose of conversations handled by this agent.
- Prompt Template text prompt used by the agent during calls.
- Voice Speed Speed of speech from 0.5 (slow) to 2 (fast), default 1.
- Voice Temperature Voice stability from 0 (most stable) to 2 (most varied), default 1.
- Volume Volume level from 0 (mute) to 2 (loud), default 1.
- Interruption Sensitivity Sensitivity to interruptions from 0.1 (least sensitive) to 1 (most sensitive), default 1.

Output

The output JSON contains the updated agent data returned from the ContactShip API after the update request. It reflects the current state of the agent including all updated fields.

Example structure (simplified):

{
  "id": "agent-id",
  "name": "Updated Agent Name",
  "person_name": "Agent Person Name",
  "voice_id": "voice-123",
  "language": "en-US",
  "ambient_sound": "coffee-shop",
  "webhook_url": "https://example.com/webhook",
  "conversation_purpose": "Customer support calls",
  "prompt": "Hello, how can I assist you today?",
  "voice_speed": 1,
  "voice_temperature": 1,
  "volume": 1,
  "interruption_sensitivity": 1
}

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the ContactShip API.
  • The node uses the ContactShip REST API endpoint configured via credentials.
  • Proper network access to ContactShip API endpoints is necessary.

Troubleshooting

  • Invalid Agent ID: If the provided Agent ID does not exist, the API will return an error. Verify the Agent ID is correct.
  • Invalid Field Values: Providing unsupported values for fields like language or ambient sound may cause errors. Use only the allowed options.
  • Webhook URL Issues: Ensure the webhook URL is reachable and correctly formatted; otherwise, notifications may fail.
  • API Authentication Errors: Check that the API key credential is valid and has sufficient permissions.
  • Network Errors: Connectivity issues to the ContactShip API will prevent updates; verify network and firewall settings.

Common error messages:

  • "Invalid 'agentId' provided": Confirm the agent ID exists.
  • "Unauthorized": Check API key validity.
  • "Validation failed": Review field values for correctness.

Links and References

Discussion