TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node integrates with the TeleFlow API to manage various telephony-related resources. Specifically, for the Phone Number resource with the Get Many operation, it retrieves multiple phone number records from the TeleFlow system. Users can specify filtering criteria by providing field-value pairs to narrow down the results.

This operation is useful when you want to fetch a list of phone numbers that meet certain conditions, such as all phone numbers of a specific type or belonging to a particular account. For example, you might retrieve all phone numbers assigned to a region or all numbers currently active.

Properties

Name Meaning
Fields A collection of field-value pairs used to filter the phone numbers returned by the query. Each pair consists of:
- Name: The field name to filter on (string).
- Value: The value to match for that field (string).
Multiple pairs can be added to refine the search criteria.

Output

The output is an array of JSON objects representing the phone numbers retrieved from the TeleFlow API. Each object contains the properties of a phone number record as returned by the API, filtered according to the specified fields.

No binary data is output by this node.

Example output structure (simplified):

[
  {
    "id": "12345",
    "number": "+1234567890",
    "type": "mobile",
    "status": "active",
    ...
  },
  {
    "id": "67890",
    "number": "+0987654321",
    "type": "landline",
    "status": "inactive",
    ...
  }
]

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The base URL for the TeleFlow API must be configured in the node credentials.
  • The node sends HTTP GET requests to the TeleFlow API endpoints.

Troubleshooting

  • Missing or invalid API credentials: Ensure that the API key and base URL are correctly set up in the node credentials.
  • Invalid field names or values: If the filtering fields do not match the API's expected parameters, the request may return no results or an error. Verify field names against TeleFlow API documentation.
  • Empty response: This may indicate no phone numbers match the provided filters. Try broadening or removing filters.
  • Network errors or timeouts: Check network connectivity and API availability.
  • Error message "ID is required for get operation" will not occur here since this operation does not require an ID parameter.

Links and References

Discussion