3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing an operation to list gateway parameter values. It is useful for retrieving configuration or status information about gateways in a 3CX environment. Typical use cases include monitoring gateway settings, auditing configurations, or integrating gateway data into workflows for automated management or reporting.

Properties

Name Meaning
Options A collection of query parameters to customize the listing of gateway parameter values:
- Top ($top) Limits the number of items returned to the first n entries.
- Skip ($skip) Skips the first n items in the result set, useful for pagination.
- Search ($search) Searches items by phrases; automatically adds quotes if the phrase contains spaces.
- Filter ($filter) Filters items based on property values (e.g., State eq 'Connected').
- Count ($count) Includes the count of items in the response when set to true.
- Orderby ($orderby) Orders items by specified property values (e.g., Name desc, CreatedAt asc).
- Select ($select) Selects specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expands related entities to include additional linked data (e.g., RelatedEntity1).

Output

The node outputs JSON data representing the list of gateway parameter values retrieved from the 3CX system. The structure corresponds to the queried properties and may include expanded related entities if requested. If the $count option is enabled, the output will also contain the total count of matching items.

No binary data output is indicated for this operation.

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.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in filter, orderby, or search fields can cause API errors. Validate these strings carefully.
  • Empty results: May occur if filters are too restrictive or if there are no gateway parameters configured.
  • Network issues: Verify connectivity to the 3CX server URL and that the server is reachable.

Links and References

Discussion