Overview
This node sends voice notifications via the IVRAPI service. It allows users to create automated phone calls that play a text-to-speech (TTS) message to specified recipients in Poland. The node supports setting caller ID, retry attempts with delay, and selecting different TTS voices.
Common scenarios where this node is beneficial include:
- Automated alerts or reminders sent by phone.
- Notifications for appointments, deliveries, or emergencies.
- Customer engagement through personalized voice messages.
Practical example: A business can use this node to call customers with a reminder about an upcoming appointment, using a natural-sounding Polish or English TTS voice, specifying the outbound caller number, and retrying the call if not answered.
Properties
| Name | Meaning |
|---|---|
| Notification Name | Name of the notification action; must be at least 4 characters long. |
| Prompt Text | The text content that will be converted to speech and played during the call. |
| Outbound Caller ID / Virtual Number | The 9-digit Polish phone number used as the caller ID for the outgoing call. Numbers cannot start with 30, 40, 70, or 80. Can be selected from available virtual numbers or specified via expression. |
| 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 | Selects the voice model for text-to-speech synthesis. Options include various Polish, English, and German voices with different characteristics (e.g., natural, expressive, warm). "None" disables TTS voice selection. |
| Recipients | List of recipients to call. Each recipient requires a Polish 9-digit phone number (without country code), which cannot start with 30, 40, 70, or 80. Multiple recipients can be added. |
Output
The node outputs a JSON array containing the response from the IVRAPI announcements API after sending the voice notification request. The structure includes details about the created announcement/call but is not explicitly detailed in the source code.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for the IVRAPI service.
- Uses the IVRAPI REST API endpoints:
- To fetch available virtual numbers:
GET https://api.ivrapi.com/api/vnumbers - To send voice notifications:
POST https://api.ivrapi.com/api/announcements
- To fetch available virtual numbers:
- The node expects the environment to have internet access to reach the IVRAPI endpoints.
- Proper configuration of the API key credential in n8n is mandatory.
Troubleshooting
- Missing API Key: If the API key credential is not set or invalid, the node will throw an error indicating the missing API key.
- Invalid Phone Numbers: Phone numbers must be exactly 9 digits and cannot start with 30, 40, 70, or 80. Violations cause errors.
- Invalid Caller ID (CLIP): Similar restrictions apply to the outbound caller ID number.
- Notification Name Too Short: Names shorter than 4 characters will cause an error.
- Retries Out of Range: Retry count must be between 0 and 10.
- Retries Delay Out of Range: Delay must be between 1 and 60 minutes.
- Invalid TTS Voice Format: Only specific voice models are allowed; incorrect formats cause errors.
- No Recipients Specified: At least one recipient must be provided.
- Failed to Load Virtual Numbers: Network issues or invalid credentials may prevent loading available caller IDs.
To resolve these errors, verify input values against the constraints, ensure valid API credentials, and confirm network connectivity.
Links and References
- IVRAPI Voice Notification Documentation
- n8n Expressions Documentation (for dynamic property values)