PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)
Join our community

Actions34

Overview

This n8n node interacts with the PortaOne API to retrieve all active billing sessions. It is designed for scenarios where you need to monitor, audit, or analyze ongoing billing sessions in a telecom environment managed by PortaOne. Typical use cases include:

  • Fetching real-time data about active calls or sessions for reporting.
  • Filtering sessions based on various criteria (e.g., account, customer, call ID).
  • Integrating session data into automated workflows for monitoring or alerting.

Example:
A telecom operator wants to automatically pull all currently active billing sessions, filter them by customer or account, and process this information for live dashboards or further automation.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
AdditionalFields A collection of optional filters and options to refine the query. Includes:
- Account ID
- Call ID
- Cld (called party number)
- Cli (calling party number)
- Get Total (Yes/No)
- H323 Conf ID
- Hotlined
- Connection ID
- Customer ID
- Node ID
- Parent ID
- Service Type ID
- I Vendor
- Limit
- Offset
- On Net
- Parent Session ID
- Source Ip
- With CLD Country
- With Connections
- With Nodes
- With Resale Hierarchy
- With Vendors
Simplify Whether to simplify the output data. If enabled, only the property specified by "SimplifyPath" will be returned.
SimplifyPath Path to the property that should be returned when "Simplify" is enabled. Default: active_session_list.

Output

  • By default, the node outputs the full JSON response from the PortaOne API containing details about active billing sessions.
  • If Simplify is enabled, only the property specified by SimplifyPath (default: active_session_list) is returned.
  • The structure of active_session_list typically includes an array of session objects, each representing an active billing session with properties such as session IDs, account/customer info, call details, etc.
  • No binary data is produced; output is always in JSON format.

Dependencies

  • External Services: Requires access to the PortaOne API endpoint.
  • Authentication: Needs valid credentials for either Token Authentication or Basic Authentication, configured in n8n credentials.
  • n8n Configuration: Credentials must be set up under the names portaOneTokenApi or portaOneBasicApi.

Troubleshooting

  • Invalid Credentials:

    • Error: "401 Unauthorized" or similar.
      Solution: Check that the correct authentication method and credentials are provided in n8n.

  • Missing Required Fields:

    • Error: "limit is required when offset is specified."
      Solution: When using the "Offset" field, ensure "Limit" is also set.

  • Empty Results:

    • If no sessions match the filters, the output may be an empty list. Double-check your filter criteria in "AdditionalFields".

  • API Connectivity Issues:

    • Error: Network errors or timeouts.
      Solution: Ensure the n8n instance can reach the PortaOne API endpoint and that any firewalls or proxies allow the connection.

Links and References

Discussion