PortaOneCallControl icon

PortaOneCallControl

Consume PortaOneCallControl API (v.0.1.0)

Overview

The PortaOneCallControl node for n8n enables users to interact with the PortaOne Call Control API, specifically to perform actions such as transferring calls. This node is useful in automated workflows where telephony operations need to be managed programmatically, such as routing customer support calls, automating call transfers based on business logic, or integrating telephony events with other systems.

Practical examples:

  • Automatically transfer an incoming support call to a specific agent or department.
  • Integrate call transfer functionality into CRM or helpdesk workflows.
  • Route calls based on caller ID, time of day, or other workflow conditions.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Call A collection containing:
- Id: The unique identifier of the call.
- Tag: An optional tag associated with the call.
Cld The destination number (Called Line Destination) to which the call will be transferred. Required.

Output

The output structure depends on the response from the PortaOne Call Control API after performing the "Transfer Call" operation. Typically, it will include a json field containing the result of the transfer action, such as status, confirmation, or error details. The exact fields may vary according to the API's response schema.

If binary data is returned (unlikely for this operation), it would represent raw API responses or logs related to the call transfer.

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 that the appropriate credentials are set up in n8n under the node’s credential options.

Troubleshooting

Common Issues:

  • Invalid Credentials: If the provided authentication details are incorrect, the node will fail to connect to the PortaOne API. Double-check your API token or username/password.
  • Missing Required Fields: The "Cld" property is required. Omitting it will result in an error.
  • API Errors: If the API returns an error (e.g., invalid call ID, call not found, or transfer not permitted), the node will output the error message received from the API.

Error Messages and Resolutions:

  • "Authentication failed" – Check that you have selected the correct authentication method and provided valid credentials.
  • "Missing required parameter: Cld" – Ensure the "Cld" field is filled in with a valid destination number.
  • "Call not found" – Verify that the "Id" provided in the Call collection matches an active call in the system.

Links and References

Discussion