3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically to retrieve conference settings. The "Get Conference Settings" operation fetches a list of conference configurations from the 3CX system, allowing users to query and filter these settings based on various criteria.

This node is useful in scenarios where you need to automate the management or monitoring of conference call settings within 3CX, such as integrating conference data into dashboards, auditing conference configurations, or triggering workflows based on specific conference parameters.

Practical examples:

  • Retrieve the first 10 conference settings sorted by creation date.
  • Search for conference settings containing a specific keyword.
  • Filter conference settings to only those currently active or connected.
  • Select only certain properties (e.g., Id and Name) to reduce payload size.

Properties

Name Meaning
Options A collection of optional query parameters to customize the request:
$top Show only the first n items (limit the number of results).
$skip Skip the first n items (offset 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 OData syntax (e.g., State eq 'Connected').
$count Include count of items in the response (boolean).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$select Select specific properties to be returned (e.g., Id,Name).
$expand Expand related entities to include additional linked data.

Note: The $select and $expand options appear twice in the provided properties but serve the same purpose — to specify which fields to return and which related entities to expand.

Output

The output JSON contains an array of conference setting objects retrieved from the 3CX API. Each object represents a conference configuration with its properties as requested via the $select option or all properties if none specified.

If binary data were involved (not indicated here), it would typically represent files or media related to conferences, but this node focuses on JSON data representing conference settings.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the node 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 correctly configured and has sufficient permissions to access conference settings.
  • Invalid query parameters: Using incorrect OData syntax in $filter, $orderby, or other query options may cause API errors. Validate your queries against 3CX API documentation.
  • Empty responses: If no conference settings are returned, check if filters or search terms are too restrictive.
  • Network issues: Verify connectivity to the 3CX server URL and that the URL is correctly set without trailing slashes.

Links and References

Discussion