Kipps.AI Voicebot icon

Kipps.AI Voicebot

Manage and interact with a Kipps.AI Voicebot for handling calls.

Overview

This node allows you to manage and interact with a Kipps.AI Voicebot for handling phone calls. It supports starting outbound calls, sending audio or text inputs to an ongoing call session, and ending calls. This is useful in scenarios where you want to automate voice interactions, such as customer support, surveys, or voice-driven workflows.

Practical examples:

  • Automatically initiate a call to a customer and start a conversation using a configured voicebot.
  • Send dynamic text or audio messages to an active call session for real-time interaction.
  • End a call programmatically once the conversation or task is complete.

Properties

Name Meaning
Action The operation to perform:
• Start Call
• Send Audio/Text
• End Call
Voicebot ID The unique identifier of the voicebot to use for the call or interaction
Phone Number The destination phone number to call (required only when starting a call)
Room Name A unique name identifying the call session or room where actions are performed
Input Type The type of input to send to the voicebot when sending data: Text or Audio
Text Input The text message content to send to the voicebot (used if Input Type is Text)
Audio Input The path or URL to the audio file to send to the voicebot (used if Input Type is Audio)

Output

The node outputs JSON data containing the response from the Kipps.AI backend API. The output includes:

  • response: The full API response object.
  • debug: An object showing the request details including:
    • body: The JSON payload sent to the API.
    • headers: HTTP headers used.
    • endpoint: The API endpoint URL called.
    • method: The HTTP method used (POST or PATCH).

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Kipps.AI backend service.
  • The node makes HTTP requests to the Kipps.AI API endpoints:
    • Starting calls: https://backend.kipps.ai/speech/phone-call/
    • Sending audio/text: https://backend.kipps.ai/speech/web-call/
    • Ending calls: https://backend.kipps.ai/speech/phone-call/{roomName}/

Ensure the API key credential is properly configured in n8n before using this node.

Troubleshooting

  • Missing Phone Number: When starting a call, if the phone number is empty or missing, the node throws an error stating "Phone Number is required for starting a call." Make sure to provide a valid phone number.
  • API Errors: If the API returns an error (e.g., invalid voicebot ID, network issues), the node will throw an error including the status code and message from the API response.
  • Incorrect Room Name: For sending audio/text or ending calls, ensure the Room Name matches an active call session; otherwise, the API may reject the request.
  • Input Type Mismatch: When sending audio/text, selecting the wrong input type without providing the corresponding input (text or audio) will cause incomplete requests.

If Continue On Fail is enabled, errors will be returned as part of the output instead of stopping execution.

Links and References

Discussion