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 actions such as holding a call. This is useful in telephony automation scenarios where you need to programmatically manage active calls—such as placing a call on hold during customer service workflows or automated call routing.

Practical examples:

  • Automatically place an ongoing support call on hold while fetching customer information.
  • Integrate with CRM systems to control call states based on workflow logic.

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 (placed on hold).
Call → Tag An optional tag associated with the call, possibly for grouping or tracking purposes.

Output

The node outputs a json field containing the result of the "Hold Call" operation from the PortaOne Call Control API. The exact structure depends on the API response, but typically includes status and details about the held call.

Note: This node does not output binary data.

Dependencies

  • External Services: Requires access to the PortaOne Call Control API.
  • API Credentials:
    • For Token Authentication: portaOneCallControlTokenApi credentials must be configured in n8n.
    • For Basic Authentication: portaOneCallControlBasicApi credentials must be configured in n8n.
  • n8n Configuration: Ensure the appropriate credentials are set up in your n8n instance under "Credentials".

Troubleshooting

Common Issues:

  • Invalid Credentials: If the provided credentials are incorrect or missing, the node will fail to authenticate.
  • Missing Required Fields: Not providing the required Call Id may result in errors from the API.
  • API Connectivity: Network issues or incorrect API endpoint configuration can cause connection failures.

Common Error Messages:

  • "Authentication failed" – Check that the correct credentials are selected and valid.
  • "Missing required parameter: id" – Ensure the Call Id is provided in the input properties.
  • "API request failed" – Verify network connectivity and API endpoint accessibility.

Links and References

Discussion