Actions23
- Call Control Actions
- Answer Call
- Convert To On Spot Conference
- Delete On Spot Conference Participant
- Disable Api Notifications
- Enable Api Notifications
- Get On Spot Conference List
- Get On Spot Conference Participant List
- Get Sip Calls List
- Hold Call
- Join Calls
- Join On Spot Conference
- Join To Active Call
- Originate Advanced Call
- Play Prompt
- Progress Call
- Ring Call
- Start DTMF Detect
- Stop DTMF Detect
- Stop Play Prompt
- Terminate Call
- Transfer Call
- Unhold Call
- Update On Spot Conference Participant
Overview
The PortaOneCallControl node for n8n allows you to interact with the PortaOne Call Control API, specifically to perform the "Play Prompt" operation on a call. This operation is typically used to play an audio prompt (such as a message or announcement) to a participant in an ongoing call. Common scenarios include automated IVR systems, customer notifications, or any workflow where you need to play a specific audio file during a call.
Practical examples:
- Playing a welcome message when a call is connected.
- Delivering important information or instructions to callers before connecting them to an agent.
- Implementing menu options in an IVR system by playing prompts and waiting for user input.
Properties
| Name | Meaning |
|---|---|
| Authentication | The authentication method to use. Options: Token Authentication, Basic Authentication. |
| Call | Information about the call. Includes: - Id: The unique identifier of the call. - Tag: An optional tag associated with the call. |
| Url | The URL of the audio file to be played as a prompt. |
| AdditionalFields | Optional fields: - Order: The order in which the prompt should be played. - Repeat: Number of times the prompt should be repeated. |
Output
The output will contain a json field with the result of the "Play Prompt" operation. The structure typically includes:
- Status of the operation (e.g., success/failure).
- Any identifiers or metadata returned by the PortaOne API related to the prompt playback.
- Error messages if the operation failed.
Note: The exact structure depends on the response from the PortaOne Call Control API.
Dependencies
- External Service: PortaOne Call Control API.
- API Credentials: Requires either Token Authentication or Basic Authentication credentials configured in n8n.
- n8n Configuration: You must set up the appropriate credentials (
portaOneCallControlTokenApiorportaOneCallControlBasicApi) in your n8n instance.
Troubleshooting
Common Issues:
- Invalid Credentials: If authentication fails, ensure that the correct credentials are selected and properly configured in n8n.
- Missing Required Fields: The "Url" property is required. If omitted, the node will throw an error.
- Incorrect Call ID: Providing an invalid or non-existent call ID will result in the operation failing.
Common Error Messages:
- "Authentication failed" – Check your credentials and authentication method.
- "Missing required parameter: url" – Ensure the "Url" property is provided.
- "Call not found" – Verify the call ID is correct and the call is active.