Overview
This node initiates outbound voice calls using a connected VoiceBot via the IVRAPI platform. It allows users to specify a bot, provide an initial text prompt for the call, select the outbound caller ID (virtual number), configure retry attempts and delays, choose a Text-to-Speech (TTS) voice, and define one or more recipients by phone number.
Common scenarios where this node is beneficial include:
- Automated customer outreach campaigns where a VoiceBot delivers a message.
- Customer support callbacks initiated automatically with dynamic prompts.
- Notifications or alerts sent via voice calls using customizable TTS voices.
- Retry logic for calls that fail initially, improving contact success rates.
Practical example: A company wants to notify customers about a service outage. Using this node, they select their VoiceBot, enter the notification text, pick a virtual number as the caller ID, set retries to 2 with 5 minutes delay, choose a friendly English TTS voice, and list multiple customer phone numbers to call.
Properties
| Name | Meaning |
|---|---|
| Bot Name or ID | Select a VoiceBot from your IVRAPI account by name or ID. This is the bot that will handle the voice call. |
| Prompt Text | The initial text prompt that the VoiceBot will speak when the call connects. |
| Outbound Caller ID / Virtual Number | The caller ID shown on the recipient's phone. Can be selected from virtual numbers linked to the bot or use the bot's default CLI (Caller Line Identification). Must be a valid 9-digit number not starting with 30, 40, 70, or 80. |
| Retries | Number of retry attempts if the call fails, between 0 and 10. |
| Retries Delay (Minutes) | Delay in minutes between retry attempts, between 1 and 60. |
| TTS Voice | Select the Text-to-Speech voice used to read the prompt. Options include various Polish, English, and German voices with different characteristics (e.g., natural, expressive, warm). "None" disables TTS voice selection. |
| Recipients | One or more recipients to call. Each recipient requires a Polish 9-digit phone number (without country code). Numbers cannot start with 30, 40, 70, or 80. |
Output
The node outputs JSON data containing the response from the IVRAPI call creation endpoint for each input item processed. The output JSON includes details about the initiated call(s), such as call IDs, status, and any metadata returned by the API.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for the IVRAPI service to authenticate requests.
- Makes HTTP requests to IVRAPI endpoints to fetch bots, virtual numbers, and initiate calls.
- The node depends on proper configuration of the IVRAPI account, including having VoiceBots and virtual numbers set up.
- The service currently supports only Polish phone numbers for recipients and caller IDs.
Troubleshooting
- Invalid Bot ID: If the Bot ID is not a positive integer, the node throws an error. Ensure you select a valid bot from the list or provide a correct ID.
- Missing Default CLI (Caller ID): If no caller ID is specified and the bot has no default CLI configured, an error occurs. Make sure the bot has a default CLI or specify a valid virtual number.
- Invalid Caller ID or Phone Number Format: Both must be exactly 9 digits and cannot start with 30, 40, 70, or 80. Errors will indicate which number is invalid.
- Retries and Delay Limits: Retries must be between 0 and 10; delay must be between 1 and 60 minutes. Values outside these ranges cause errors.
- Invalid TTS Voice Format: The voice string must match allowed models (Wavenet, Chirp, Chirp3) with proper locale prefixes. Otherwise, an error is thrown.
- No Recipients Specified: At least one recipient must be provided; otherwise, the node errors out.
- API Request Failures: Network issues or invalid API keys will cause HTTP request failures. Verify credentials and network connectivity.
Links and References
- IVRAPI VoiceBot Call Documentation
- n8n Expressions Documentation (for dynamic property values)