Overview
This node initiates outbound voice calls using a connected VoiceBot from the IVRAPI platform. It allows users to specify a text prompt that the bot will speak, select the caller ID number, configure retry attempts and delays, choose a text-to-speech (TTS) voice, and define one or more recipients by phone number.
Common scenarios include:
- Automated customer outreach where a VoiceBot delivers a message.
- Notifications or alerts sent via voice call.
- Interactive voice response (IVR) campaigns initiated programmatically.
- Testing or demoing VoiceBot capabilities with custom prompts.
For example, a user can set up a call campaign to notify customers about an appointment reminder, specifying the message text, caller ID, and multiple recipients. The node handles retries if calls fail.
Properties
| Name | Meaning |
|---|---|
| Bot Name or ID | Select a VoiceBot from your IVRAPI account by name or ID. This is the bot that will make the call. |
| Prompt Text | The initial text prompt that the VoiceBot will speak during the call. |
| Outbound Caller ID / Virtual Number | The caller ID number shown to the recipient. 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 Polish number excluding certain prefixes. |
| 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 for the prompt. Options include various Polish, English, and German voices with different characteristics (e.g., natural, expressive). "None" means no specific voice selected. |
| Recipients | List of recipients to call. Each recipient requires a Polish 9-digit phone number (without country code), excluding numbers starting with 30, 40, 70, or 80. Multiple recipients can be added. |
Output
The node outputs JSON data containing the response from the IVRAPI service after initiating the call(s). The structure includes details about the created call(s), such as status and identifiers returned by the API.
Example output JSON structure:
{
"callId": "string",
"status": "string",
"details": { /* additional call info */ }
}
No binary data 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 the IVRAPI platform being accessible and properly configured with VoiceBots and virtual numbers.
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: If the caller ID is set to use the bot default but the bot has no CLI configured, an error occurs. Configure a default CLI number for the bot or specify a valid caller ID explicitly.
- Invalid Caller ID or Phone Numbers: Caller ID and recipient phone numbers must be exactly 9 digits and cannot start with 30, 40, 70, or 80. Errors will indicate invalid formats or disallowed prefixes.
- 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: The voice parameter must match allowed patterns corresponding to supported TTS models. Invalid values cause errors.
- No Recipients Specified: At least one recipient must be provided; otherwise, the node throws an error.
To resolve errors, verify all input parameters conform to the expected formats and constraints described above.
Links and References
- IVRAPI VoiceBot Call Documentation
- n8n Expressions Documentation (for dynamic property values)