TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

The "Get Many" operation for the SIP Trunk resource in this node allows users to retrieve multiple SIP Trunk records from the TeleFlow API. This operation is useful when you want to list or query SIP Trunks with optional filtering based on specific fields.

Typical use cases include:

  • Fetching all SIP Trunks configured in your TeleFlow account.
  • Querying SIP Trunks that match certain criteria, such as a specific name or host.
  • Integrating SIP Trunk data into workflows for monitoring, reporting, or further processing.

For example, you might use this operation to get all SIP Trunks whose name contains a particular substring or to retrieve SIP Trunks associated with a specific host.

Properties

Name Meaning
Fields A collection of field-value pairs used to filter the SIP Trunks returned by the request. You can specify multiple fields to narrow down the query. For each field, provide:
- Name: The field name to filter by (e.g., "name", "host").
- Value: The value to match for that field.

Output

The output is an array of JSON objects representing the SIP Trunks retrieved from the TeleFlow API. Each object contains the properties of a SIP Trunk as returned by the API, which typically includes identifiers, names, hosts, and other relevant details.

No binary data is output by this operation.

Example output snippet (simplified):

[
  {
    "id": "123",
    "name": "Main SIP Trunk",
    "host": "sip.example.com",
    ...
  },
  {
    "id": "456",
    "name": "Backup SIP Trunk",
    "host": "backup.sip.example.com",
    ...
  }
]

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The node expects the base URL of the TeleFlow API to be configured in the credentials.
  • Internet connectivity to reach the TeleFlow API endpoint.

Troubleshooting

  • Missing or invalid API credentials: Ensure that the API key and base URL are correctly set up in the node's credentials.
  • Invalid field names or values: If filtering fields do not match the API's expected parameters, the request may return no results or errors. Verify field names against TeleFlow API documentation.
  • Empty response: If no SIP Trunks match the specified filters, the output will be an empty array.
  • API errors: Network issues or server errors from TeleFlow will cause the node to throw errors. Check error messages for details.
  • ID required errors: Not applicable for "Get Many" but relevant for other operations like "Get" or "Update".

Links and References

Discussion