PortaOneCallControl icon

PortaOneCallControl

Consume PortaOneCallControl API (v.0.1.0)

Overview

The PortaOneCallControl node for n8n allows you to interact with the PortaOne Call Control API, specifically to perform operations related to call management. In this configuration, the focus is on the "Stop DTMF Detect" operation under the Call Control resource. This operation is typically used to stop the detection of DTMF (Dual-Tone Multi-Frequency) signals during a call, which is useful in telephony workflows where you need to control or terminate digit collection (e.g., after collecting a PIN or menu selection).

Common scenarios:

  • Stopping DTMF detection after receiving required input from a caller.
  • Managing interactive voice response (IVR) flows.
  • Automating call handling processes that require precise control over DTMF signal processing.

Practical example:
You might use this node in a workflow where an incoming call is routed through an IVR system, and after the user enters their selection, you want to stop listening for further DTMF tones before proceeding to the next step.


Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Call → Id The unique identifier of the call for which to stop DTMF detection.
Call → Tag An optional tag associated with the call, if applicable.

Output

The output will be a JSON object reflecting the result of the "Stop DTMF Detect" operation. While the exact structure depends on the API's response, you can expect fields such as:

{
  "success": true,
  "message": "DTMF detection stopped",
  "callId": "string",
  "details": { /* additional information if provided by API */ }
}

If the node supports binary data output, it would generally relate to call recordings or similar artifacts, but for this operation, only JSON output is expected.


Dependencies

  • External Services: Requires access to the PortaOne Call Control API.
  • API Credentials: You must provide valid credentials:
    • For Token Authentication: portaOneCallControlTokenApi
    • For Basic Authentication: portaOneCallControlBasicApi
  • n8n Configuration: Ensure the appropriate credentials are set up in n8n’s credential manager.

Troubleshooting

Common issues:

  • Invalid Credentials: If authentication fails, ensure your API credentials are correct and have sufficient permissions.
  • Missing Call ID: The operation requires a valid call ID. If not provided or incorrect, the API may return an error indicating the call was not found.
  • Network/Connectivity Issues: Errors related to network timeouts or inability to reach the PortaOne API endpoint.

Common error messages:

  • "Authentication failed": Check your selected authentication method and credentials.
  • "Call not found": Verify the Call Id property is correctly set and refers to an active call.
  • "Insufficient permissions": Ensure your API user has rights to control calls and stop DTMF detection.

Links and References

Discussion