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 the "Ring Call" operation. This operation is typically used to initiate or control call ringing actions within a telephony or VoIP environment managed by PortaOne.

Common scenarios:

  • Automatically triggering a phone to ring as part of a workflow (e.g., alerting an agent when a new support ticket arrives).
  • Integrating call control into business processes, such as automated outbound calling or notification systems.
  • Managing calls programmatically in customer service, sales, or operations workflows.

Practical example:
A company uses this node to automatically ring a support agent's phone when a high-priority ticket is created in their helpdesk system.


Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Call → Id The unique identifier of the call to be controlled.
Call → Tag An optional tag associated with the call, possibly for tracking or categorization.

Output

The output will be a json object containing the result of the "Ring Call" operation from the PortaOne Call Control API. The exact structure depends on the API response, but it typically includes information about the call status and any relevant identifiers.

Note: If the API returns binary data, it will represent call-related media or logs, but this node primarily deals with JSON responses.


Dependencies

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

Troubleshooting

Common issues:

  • Invalid Credentials: If the provided token or basic auth credentials are incorrect, the node will fail to authenticate.
  • Missing Required Fields: Not providing the required "Id" for the call may result in errors from the API.
  • Network Issues: Connectivity problems between n8n and the PortaOne API endpoint can cause failures.

Error messages and resolutions:

  • "Authentication failed": Check that your credentials are correct and have sufficient permissions.
  • "Missing call id": Ensure the "Id" field under "Call" is filled in.
  • "API unreachable": Verify network connectivity and API endpoint configuration.

Links and References

Discussion