3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing functionality to list parameters from the system. It is useful for scenarios where users need to retrieve configuration or operational parameters from their 3CX environment, such as fetching system settings, user preferences, or other configurable options.

A practical example would be an automation workflow that periodically retrieves and processes telephony parameters to monitor system status or adjust call routing dynamically based on current configurations.

Properties

Name Meaning
Options A collection of query options to control the listing of parameters:
- Top ($top) Show only the first n items (limit the number of results returned).
- Skip ($skip) Skip the first n items (useful for pagination).
- Search ($search) Search items by search phrases; supports phrase searching with quotes if needed.
- Filter ($filter) Filter items by property values using expressions (e.g., State eq 'Connected').
- Count ($count) Include count of items in the response (boolean).
- Orderby ($orderby) Order items by property values (e.g., Name desc, CreatedAt asc).
- Select ($select) Select specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expand related entities to include additional linked data.

Output

The node outputs JSON data representing the list of parameters retrieved from the 3CX system. Each item corresponds to a parameter object with its properties as returned by the API. The output structure depends on the selected $select and $expand options but generally includes parameter identifiers, names, values, and possibly related entity data.

If binary data were involved, it would be summarized here, but this node deals primarily with JSON data.

Dependencies

  • Requires an API key credential for authenticating with the 3CX system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.
  • The request headers specify Accept: application/json.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query option values (e.g., malformed filter expressions) may result in API errors.
    • Network connectivity problems to the 3CX server can cause timeouts or connection errors.

  • Error messages:

    • Authentication errors typically indicate invalid or expired credentials; reconfigure the API key.
    • Query syntax errors from the API suggest checking the formatting of $filter, $orderby, and $search inputs.
    • Connection errors require verifying the server URL and network access.

Links and References

Discussion