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 trunks within the system. This operation is useful for retrieving and managing telephony trunk configurations, which are essential for routing calls through different service providers or gateways.

Common scenarios include:

  • Auditing or monitoring existing trunks in a 3CX installation.
  • Integrating trunk data into workflows for reporting or automated configuration management.
  • Filtering and searching trunks based on specific criteria such as status or name.

For example, a user might want to retrieve only the first 10 trunks that are currently connected or search for trunks by a partial name match.

Properties

Name Meaning
Options A collection of query parameters to control the listing of trunks:
$top Show only the first n items (limit the number of trunks returned).
$skip Skip the first n items (useful for pagination).
$search Search trunks by phrases; supports automatic quoting if the phrase contains spaces.
$filter Filter trunks by property values using expressions (e.g., State eq 'Connected').
$count Include the count of items in the response (boolean).
$orderby Order trunks by specified property values (e.g., Name desc, CreatedAt asc).
$select Select specific properties of trunks to be returned (e.g., Id,Name).
$expand Expand related entities linked to trunks (e.g., related configurations or metadata).

Output

The node outputs JSON data representing the list of trunks retrieved from the 3CX system. The structure typically includes an array of trunk objects, each containing properties such as identifiers, names, states, and any other selected or expanded fields based on the input options.

If binary data were involved (not indicated here), it would represent associated files or media related to trunks, but this node focuses on JSON data output.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Invalid query parameters: Incorrect filter, orderby, or select syntax may cause API errors. Validate expressions against 3CX API documentation.
  • Empty results: Check if filters or search terms are too restrictive or if the 3CX server contains trunks matching the criteria.
  • Connection issues: Verify the server URL is correct and accessible from the n8n environment.

Links and References

Discussion