TeleFlow icon

TeleFlow

Interact with TeleFlow API

Actions82

Overview

This node integrates with the TeleFlow API to perform various operations on multiple resources, including Mobile SIMs. Specifically, the "Get" operation for the Mobile SIM resource retrieves detailed information about a single Mobile SIM by its unique identifier. This is useful in scenarios where you need to fetch current data or status of a specific SIM card managed within TeleFlow, such as verifying SIM details before provisioning or auditing.

Practical examples:

  • Retrieve a Mobile SIM's details by its ID to display or process in a workflow.
  • Fetch specific fields of a Mobile SIM to minimize data transfer and focus on relevant attributes.

Properties

Name Meaning
ID The unique identifier of the Mobile SIM resource to retrieve. This is required.
Fields Optional key-value pairs specifying additional query parameters to filter or customize the request. Each pair consists of a field name and its corresponding value.

Output

The output is a JSON object representing the Mobile SIM resource retrieved from the TeleFlow API. It contains all the properties of the Mobile SIM as returned by the API, which may include identifiers, status, configuration, and other metadata.

If the user specifies particular fields via the "Fields" property, those are included as query parameters to refine the response.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "string",
  "status": "string",
  "phoneNumber": "string",
  "carrier": "string",
  "activationDate": "string",
  ...
}

Dependencies

  • Requires an active connection to the TeleFlow API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the API must be set in the credentials.
  • The node uses HTTP GET requests to fetch data.

Troubleshooting

  • Missing ID error: If the "ID" property is not provided, the node throws an error stating that the ID is required. Ensure the ID is correctly set.
  • API connectivity issues: Network problems or incorrect API credentials can cause failures. Verify API keys and network access.
  • Invalid field names: Providing unsupported or misspelled field names in the "Fields" property may result in incomplete or failed responses.
  • Handling errors gracefully: If "Continue On Fail" is enabled, errors will be returned as part of the output JSON instead of stopping execution.

Links and References

Discussion