3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing functionality to list trunk templates. This operation retrieves a collection of trunk template records from the 3CX system, allowing users to query and filter these templates based on various criteria.

Common scenarios where this node is beneficial include:

  • Automating the retrieval of trunk templates for reporting or auditing purposes.
  • Integrating 3CX trunk template data into other workflows or systems.
  • Filtering and searching trunk templates dynamically based on user-defined parameters.

For example, a user might want to fetch only the first 10 trunk templates that are currently connected, or search for trunk templates by name containing specific keywords.

Properties

Name Meaning
Options A collection of optional query parameters to customize the list request:
$top Show only the first n items (limit the number of results).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be wrapped in quotes automatically.
$filter Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
$count Include count of items in the response (boolean).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$select Select specific properties to be returned (e.g., Id,Name).
$expand Expand related entities to include additional linked data (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the list of trunk templates retrieved from the 3CX system. The structure typically includes an array of trunk template objects, each containing properties as requested or defaulted by the $select parameter.

If the $count option is enabled, the output may also include metadata about the total number of items available.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other OData parameters can cause errors. Validate the syntax according to OData standards.
  • Empty results: Check if the filters or search terms are too restrictive or incorrect.
  • Network issues: Verify connectivity to the 3CX server URL configured in credentials.

Links and References

Discussion