PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)
Join our community

Actions34

Overview

The PortaOne node for n8n allows you to interact with the PortaOne API, specifically to retrieve a list of DID (Direct Inward Dialing) numbers using the "Get All" operation. This is useful for telecom service providers or administrators who need to manage, filter, and analyze available DID numbers in their PortaOne system.

Common scenarios:

  • Fetching all available DID numbers for inventory management.
  • Filtering DID numbers by country, area code, city, or other criteria.
  • Integrating DID number data into automated workflows for provisioning, reporting, or customer assignment.

Practical examples:

  • Automatically sync available DID numbers to a CRM.
  • Generate reports on DID number availability by region.
  • Check which DIDs are assigned or available for a specific customer.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Area Code Filters DID numbers using an area code search pattern.
Area Code Description Filters DID numbers using an area code description search pattern.
Available To Customer Filter by whether the DID is available to the customer (numeric value).
Check Usage Check whether the customer has entities assigned. Options: No, Yes.
City Name Filters DID numbers by the area the numbers belong to.
Country The code of the country in ISO 3166-1 alpha-2 format.
Description Filters DID numbers using a description search pattern.
External Filter by external status (numeric value).
Format Allows API user to get xDRs in other formats via SOAP attachment.
Get Total Get the total number of the retrieved customers. Options: No, Yes.
Customer ID The unique ID of the customer record.
Dv Batch ID The batch ID for DV (number batch).
Group ID The group ID for filtering.
I Vendor Vendor ID for filtering.
Limit The number of rows to retrieve. Mandatory if offset is specified.
Managed By Manager ID for filtering.
Max Activation Fee Maximum activation fee for filtering.
Max Periodic Fee Maximum periodic fee for filtering.
Min Activation Fee Minimum activation fee for filtering.
Min Periodic Fee Minimum periodic fee for filtering.
Number Filters DID numbers using a number search pattern.
Offset The number of rows to skip at the beginning of the list. Requires limit to be specified.
Owner Batch Owner batch ID for filtering.
Owner Batch Individual Filters DID numbers by the type of DID pricing batch. Options: Include only DID numbers with individual pricing batch, Include only DID numbers with non-individual pricing batches.
Reserve Term Reserve term for filtering.
Start Number Filters DID numbers using a starting DID number pattern.
Usage Filter DID number list by usage.
Use DID Location Use DID location (numeric value).
With Extended Info Whether to include extended info. Options: Yes, No.
Simplify Whether to simplify the output data.
SimplifyPath Path to the property that should be returned (default: number_list).

Output

  • JSON Output:

    • By default, the node returns the full response from the PortaOne API for the DID Numbers "Get All" operation.
    • If Simplify is enabled, the node will return only the property specified by SimplifyPath (default: number_list), which typically contains an array of DID number objects.
    • Each DID number object may include fields such as number, area code, city, country, status, fees, etc., depending on the API response and selected filters.

  • Binary Data:

    • This node does not output binary data.

Dependencies

  • External Services: Requires access to a PortaOne instance with API enabled.
  • API Credentials:
    • Token Authentication: Needs a valid PortaOne API token.
    • Basic Authentication: Needs valid username and password.
  • n8n Configuration:
    • Credentials must be set up in n8n under "portaOneTokenApi" or "portaOneBasicApi" as appropriate.

Troubleshooting

Common Issues:

  • Authentication Errors:
    • If credentials are missing or incorrect, the node will fail to connect. Ensure the correct authentication method and credentials are configured.
  • Missing Required Fields:
    • If "offset" is specified without "limit", the API may return an error. Always specify "limit" when using "offset".
  • Invalid Filter Values:
    • Providing invalid values for filters (e.g., wrong country code format) may result in empty results or errors.
  • API Rate Limits/Timeouts:
    • Large queries or frequent requests may hit rate limits or timeouts; consider narrowing your filters or paginating results.

Error Messages:

  • "Invalid credentials" – Check your API key or username/password.
  • "Missing required parameter: limit" – Add the "Limit" property when using "Offset".
  • "No data found" – Adjust your filters; there may be no matching DID numbers.

Links and References

Discussion