TeleFlow icon

TeleFlow

Interact with TeleFlow API
Join our community

Actions145

Overview

This node integrates with the TeleFlow API to perform various operations on different resources, including "Number Port". Specifically, the Get operation for the Number Port resource retrieves detailed information about a specific number port entry by its unique ID. This is useful in scenarios where you need to fetch current status, details, or metadata of a number port request or record within your telephony management workflows.

Practical examples include:

  • Retrieving the status and details of a phone number porting request to monitor progress.
  • Fetching specific number port data to validate or audit porting activities.
  • Integrating number port information into broader automated reporting or provisioning workflows.

Properties

Name Meaning
ID The unique identifier of the Number Port resource to retrieve. This is required.
Fields Optional key-value pairs specifying additional fields to include in the request query. You can add multiple field name and value pairs to filter or customize the returned data.

Output

The output is a JSON object representing the retrieved Number Port resource data as returned by the TeleFlow API. It contains all the properties and metadata associated with the specified number port entry.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "string",
  "status": "string",
  "number": "string",
  "portDate": "string",
  "details": { /* additional nested info */ }
}

The exact fields depend on the TeleFlow API response for the Number Port resource.

Dependencies

  • Requires an active connection to the TeleFlow API.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • The base URL for the TeleFlow API must be set in the node credentials.
  • The node uses HTTP requests to communicate with the TeleFlow REST endpoints.

Troubleshooting

  • Missing ID error: If the ID property is not provided for the Get operation, the node will throw an error stating that the ID is required. Ensure you provide a valid ID.
  • Authentication errors: If the API key or credentials are invalid or missing, the node will fail to connect. Verify your API credentials and base URL configuration.
  • Invalid field names: Providing incorrect field names in the Fields collection may result in incomplete or empty responses. Double-check field names against the TeleFlow API documentation.
  • Network issues: Connectivity problems to the TeleFlow API endpoint will cause request failures. Check network access and API availability.

Links and References

Discussion