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 PortaOne Call Control node with the Stop Play Prompt operation is designed to interact with the PortaOneCallControl API, specifically to stop a prompt that is currently being played on an active call. This can be useful in scenarios where automated voice prompts need to be interrupted or halted based on user input or workflow logic.
Common use cases:
- Stopping an audio message or IVR prompt when a customer presses a key.
- Halting playback of announcements during a call transfer or escalation.
- Dynamically controlling call flow in telephony automation processes.
Practical example:
A call center workflow uses this node to stop a "please hold" message as soon as an agent becomes available and answers the call.
Properties
| Name | Meaning |
|---|---|
| Authentication | The authentication method to use. Options: Token Authentication, Basic Authentication. |
| Call | Collection of call identification fields: - Id: Unique identifier of the call. - Tag: Optional tag associated with the call. |
| AdditionalFields | Collection of extra parameters: - Order: Numeric value indicating order (purpose may depend on API). |
Output
The output will contain a json field reflecting the response from the PortaOneCallControl API for the Stop Play Prompt operation. The exact structure depends on the API's response, but typically includes status information about the request (e.g., success/failure, call ID, any error messages).
Note: This node does not output binary data.
Dependencies
- External Service: Requires access to the PortaOneCallControl API.
- Authentication: Needs either a Token or Basic Authentication credentials configured in n8n:
- For Token Authentication: Credentials named
portaOneCallControlTokenApi. - For Basic Authentication: Credentials named
portaOneCallControlBasicApi.
- For Token Authentication: Credentials named
- n8n Configuration: Ensure the appropriate credentials are set up in your n8n instance.
Troubleshooting
Common issues:
- Invalid Credentials: If authentication fails, ensure the correct credentials are selected and valid.
- Missing Call ID: The operation requires a valid call identifier; omitting it will result in errors.
- API Connectivity: Network issues or incorrect API endpoint configuration can cause failures.
Error messages you might encounter:
"Authentication failed": Check your credentials and authentication method."Call not found": Verify the Call Id provided matches an active call."Insufficient permissions": Ensure the API user has rights to control calls.