3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node operation retrieves settings related to data connectors from the 3CX telephony system API. It is useful when you want to programmatically access configuration details of data connectors, such as their status, properties, or metadata. Typical use cases include auditing connector configurations, integrating connector settings into workflows for monitoring, or dynamically adjusting behavior based on connector states.

Properties

Name Meaning
Options A collection of query parameters to customize the retrieval of data connector settings:
- 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; supports automatic quoting if the phrase contains spaces.
- Filter ($filter) Filters items by property values using expressions (e.g., State eq 'Connected').
- Count ($count) Includes a count of total items matching the query 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 retrieved data connector settings. The structure corresponds to the queried properties and may include multiple items depending on the query options used. If expanded entities are requested, related data will be nested accordingly. There is no binary output for this operation.

Dependencies

  • Requires an authenticated connection to the 3CX telephony system via an OAuth2 API credential.
  • The base URL for the API is configured through credentials and must point to a valid 3CX server endpoint.
  • The node sends HTTP requests with JSON accept headers to the 3CX API.

Troubleshooting

  • Authentication errors: Ensure that the OAuth2 API credential is correctly configured with valid tokens and the server URL is accurate.
  • Empty results: Check filter, search, and select options for correctness; overly restrictive queries may return no data.
  • Invalid query parameters: The API may reject malformed OData-style query strings; verify syntax especially in $filter and $orderby.
  • Network issues: Confirm network connectivity to the 3CX server and that the server URL does not have trailing slashes beyond what is expected.

Links and References

Discussion