3CX icon

3CX

Interact with 3CX telephony system

Actions462

Defs → List Gateway Parameters

AI-generated

Overview

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

Properties

Name Meaning
Options A collection of query options to customize the listing of gateway parameters:
- Top ($top) Limits the number of items returned to the first n entries.
- Skip ($skip) Skips the first n items in the result set.
- 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 parameters retrieved from the 3CX system. The structure typically includes an array of parameter objects, each containing details such as parameter names, values, and possibly metadata depending on the selected properties and expansions.

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

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 based on user input.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is valid and has sufficient permissions to access gateway parameters.
  • Empty results: Check filter and search query syntax; incorrect filters may return no data.
  • Invalid query parameters: Make sure that $top, $skip, $filter, etc., are correctly formatted according to OData conventions used by the 3CX API.
  • Connection issues: Verify the server URL is correct and reachable from the n8n instance.
  • Unexpected response format: Confirm that the 3CX API version matches the expected schema and that the node’s version is compatible.

Links and References

Discussion