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 start DTMF (Dual-Tone Multi-Frequency) detection on a call. This is useful in telephony workflows where you need to detect keypresses during a call, such as for IVR (Interactive Voice Response) systems, automated surveys, or any scenario requiring user input via phone keypad.

Example use cases:

  • Triggering actions when a caller presses certain keys during a call.
  • Collecting numeric input from callers (e.g., PIN codes, menu selections).
  • Integrating with other systems based on detected DTMF tones.

Properties

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

Output

The node outputs a json object containing the result of the "Start DTMF Detect" operation. The exact structure depends on the API response, but typically includes:

  • Status of the DTMF detection initiation.
  • Any relevant identifiers or metadata returned by the API.

Note: If the API returns binary data, it will be included in the output as a binary property, but this operation is expected to return JSON.

Dependencies

  • External Service: Requires access to the PortaOne Call Control API.
  • API Credentials: You must provide either a Token or Basic Authentication credentials, configured in n8n's credential store as:
    • portaOneCallControlTokenApi (for Token Authentication)
    • portaOneCallControlBasicApi (for Basic Authentication)

Troubleshooting

Common Issues:

  • Invalid Credentials: If authentication fails, ensure your credentials are correct and have sufficient permissions.
  • Missing Call ID: The "Id" field under "Call" is required; omitting it may cause errors or no action.
  • API Connectivity: Network issues or incorrect API endpoint configuration can prevent successful execution.

Error Messages:

  • "Authentication failed" – Check that the selected authentication method matches the provided credentials.
  • "Call not found" – Ensure the Call Id is valid and active.
  • "DTMF detection already started" – The operation may not be repeatable on the same call without stopping previous detection.

Links and References

Discussion