TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform various operations on different resources. Specifically, for the "Mobile SIM" resource with the "Get Many" operation, it retrieves multiple Mobile SIM records from the TeleFlow system. This is useful when you want to fetch a list of SIM cards managed in your TeleFlow account, optionally filtering the results by specific fields.

Practical examples include:

  • Retrieving all Mobile SIMs currently active in your system.
  • Filtering Mobile SIMs by certain attributes such as status or assigned user.
  • Integrating SIM inventory data into workflows for reporting or automation.

Properties

Name Meaning
Fields Field-value pairs to filter the query results. You can add multiple fields to narrow down the search. For example, you might specify a field "status" with value "active" to get only active SIMs.

The "Fields" property is a fixed collection allowing multiple entries, each with:

  • Name: The name of the field to filter by (string).
  • Value: The value to match for that field (string).

Output

The output is an array of JSON objects representing the Mobile SIM records returned by the TeleFlow API. Each object contains the properties of a Mobile SIM as provided by the API response.

No binary data output is produced by this operation.

Example output structure (simplified):

[
  {
    "id": "sim123",
    "name": "SIM Card 1",
    "status": "active",
    "phoneNumber": "+1234567890",
    ...
  },
  {
    "id": "sim124",
    "name": "SIM Card 2",
    "status": "inactive",
    "phoneNumber": "+0987654321",
    ...
  }
]

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 uses HTTP requests to communicate with the TeleFlow REST API.

Troubleshooting

  • Missing or invalid API credentials: Ensure that the API key and base URL are correctly set in the node credentials.
  • Invalid field names or values in filters: If the API returns errors or empty results, verify that the field names and values used in the "Fields" property are valid according to the TeleFlow API documentation.
  • Network issues or API downtime: Check network connectivity and TeleFlow service status if requests fail.
  • Error message "ID is required for get/update/delete": This does not apply to "Get Many" but may appear if other operations are selected incorrectly.

Links and References

Discussion