PortaOneInstall

Overview

The PortaOne node for n8n, when configured with the Customer Xdrs resource and the Get All operation, retrieves a list of customer xDRs (Call Detail Records) from the PortaOne API. This is useful for telecom billing, auditing, or analytics scenarios where you need to fetch detailed records of customer calls, including filtering by various criteria such as date range, call status, customer ID, and more.

Common use cases:

• Generating reports of all customer call activities within a specific period.
• Filtering xDRs by call quality, roaming status, or recording availability.
• Integrating PortaOne call data into other business processes or dashboards.

Practical examples:

• Fetching all xDRs for a given customer in the last month.
• Retrieving only successful calls with recordings for compliance checks.
• Paginating through large sets of xDRs for data warehousing.

Properties

Output

• By default, the node outputs the full JSON response from the PortaOne API containing customer xDRs and related metadata.
• If Simplify is enabled, only the property specified by SimplifyPath (default: xdr_list) is returned, which typically contains an array of xDR objects.
• Each xDR object may include fields such as call details, timestamps, customer identifiers, call quality, and optionally download IDs for recordings or net access usage statistics if requested.

Example output structure (simplified):

{
  "xdr_list": [
    {
      "call_id": "12345",
      "customer_id": 678,
      "start_time": "2024-06-01T12:00:00Z",
      "duration": 120,
      "quality": "good",
      "recording_ids": [ ... ],
      ...
    },
    ...
  ],
  "total": 100,
  "offset": 0,
  "limit": 50
}

• If binary data is requested (e.g., call recordings), the node may provide download IDs or links, but does not directly output binary files.

Dependencies

• External Services: Requires access to a PortaOne API endpoint.
• API Credentials:
  • Token Authentication: Needs valid PortaOne API token credentials.
  • Basic Authentication: Needs valid username/password credentials.
• n8n Configuration: Ensure the appropriate credential type is set up in n8n under the node's credentials section.

Troubleshooting

Common issues:

• Authentication errors: Occur if credentials are missing or incorrect. Ensure the correct authentication method and credentials are selected.
• Missing required fields: Some filters (like offset) require limit to be set. Check the error message and provide all mandatory parameters.
• Large data sets: If too much data is requested without proper filtering or pagination (limit/offset), the API may time out or return errors.
• Invalid filter values: Providing unsupported or incorrectly formatted filter values can result in API errors.

Error messages and resolutions:

• "Invalid credentials": Double-check your API credentials and authentication method.
• "Missing required parameter: limit": When using offset, ensure limit is also specified.
• "Too many results": Use filters or pagination to reduce the result set size.

Links and References

• PortaOne Official Documentation
• n8n Documentation: Custom Nodes
• Call Detail Records (Wikipedia)