3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing an operation to retrieve "Defs" (definitions or configuration items) from the system. The "Get Defs" operation allows users to query and fetch a list of these definitions with various filtering, sorting, and selection options. This is useful in scenarios where you want to programmatically access telephony configurations, monitor system states, or integrate 3CX data into workflows.

Practical examples include:

  • Fetching a limited number of telephony definitions for display or processing.
  • Searching for specific definitions by keywords.
  • Filtering definitions based on properties such as state or name.
  • Ordering results by creation date or other attributes.
  • Selecting only certain fields to reduce payload size.
  • Expanding related entities to get more detailed information in one request.

Properties

Name Meaning
$top Show only the first n items (limit the number of returned definitions).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be quoted automatically.
$filter Filter items by property values using expressions (e.g., State eq 'Connected').
$count Include count of total items matching the query (boolean).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$select Select which properties to be returned (comma-separated list, e.g., Id,Name).
$expand Expand related entities to include additional linked data (comma-separated list).

Note: The node's input UI groups these under an "Options" collection for the "Get Defs" operation.

Output

The node outputs JSON data representing the retrieved definitions from the 3CX system. The structure typically includes an array of definition objects, each containing the properties requested via $select or all properties if none specified.

If $count is enabled, the output may also include metadata about the total number of matching items.

No binary data output is indicated by the source code or properties.

Dependencies

  • Requires an API key credential for authenticating with the 3CX system (OAuth2-based).
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.
  • The Accept header is set to expect JSON responses.

Troubleshooting

  • Authentication errors: Ensure the OAuth2 API credentials are correctly configured and valid.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other OData-like query options can cause API errors. Validate expressions carefully.
  • Empty results: Check that filters and search terms match existing definitions; try removing filters to verify connectivity.
  • Server URL issues: The base URL must be correct and reachable; trailing slashes are handled but ensure no typos.
  • API version mismatch: The node targets /xapi/v1; if the 3CX server uses a different API version, update accordingly.

Links and References

Discussion