PortaOneCallControl icon

PortaOneCallControl

Consume PortaOneCallControl API (v.0.1.0)

Overview

The PortaOneCallControl node for n8n allows you to originate (initiate) advanced calls using the PortaOne Call Control API. This is particularly useful for automating telephony workflows, such as programmatically placing outbound calls, integrating call origination into business processes, or triggering calls based on events in your automation.

Common scenarios:

  • Automatically dialing customers for appointment reminders.
  • Initiating support or sales calls from CRM systems.
  • Integrating with notification systems to trigger voice alerts.

Practical example:
A business could use this node to automatically call a customer when a new order is placed, passing relevant information and tracking the call status via callbacks.


Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
This allows the application to display the current call statuses to users... Informational notice about call status tracking and callback options.
Call Collection of call-related parameters:
- Id: Identifier for the call.
- Tag: Tag for categorizing or identifying the call.
Callee Id The identifier of the party to be called. Required.
AdditionalFields Collection of optional fields:
- Bill Id: Billing identifier.
- Callee Auto Pickup: Option to auto-answer the callee.
- Caller Id: Caller’s identifier.
- State Callback: URL for call state notifications.
- State Callback Events: List of specific call states to receive notifications for.

Output

  • The node outputs a json object containing the result of the "Originate Advanced Call" operation.
  • The structure typically includes details about the initiated call, such as call identifiers, status, and any response data from the PortaOne API.
  • If binary data is involved (not typical for this operation), it would represent call recordings or similar artifacts.

Dependencies

  • External Service: Requires access to the PortaOne Call Control API.
  • API Credentials:
    • For Token Authentication: portaOneCallControlTokenApi
    • For Basic Authentication: portaOneCallControlBasicApi
  • n8n Configuration: Credentials must be set up in n8n under the appropriate authentication method.

Troubleshooting

Common issues:

  • Invalid credentials: Ensure the correct authentication method and valid credentials are provided.
  • Missing required fields: The "Callee Id" is mandatory; omitting it will cause errors.
  • Callback misconfiguration: If using state callbacks, ensure the callback URL is reachable and correctly formatted.

Error messages and resolutions:

  • "Authentication failed": Check that the selected authentication method matches the credentials provided.
  • "Missing required parameter 'callee_id'": Make sure to fill in the Callee Id property.
  • "Failed to connect to PortaOne API": Verify network connectivity and API endpoint configuration.

Links and References

Discussion