3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing functionality to retrieve onboard MCU (Multipoint Control Unit) data under the "Conference Settings" resource. This operation is useful for users who want to manage or monitor conference call settings and details within their 3CX environment. For example, it can be used to fetch a list of active conference MCUs, filter them by status, or paginate through large sets of conference data.

Properties

Name Meaning
Options A collection of optional query parameters to refine the data retrieval:
- Top ($top) Limits the number of items returned to the first n entries.
- Skip ($skip) Skips the first n items in the result set, useful for pagination.
- Search ($search) Searches items by phrases; supports automatic quoting if the phrase contains spaces.
- Filter ($filter) Filters items based on property values, e.g., filtering by state like "State eq 'Connected'".
- Count ($count) Boolean flag to include the count of total items matching the query.

Output

The node outputs JSON data representing the onboard MCU information retrieved from the 3CX system. The structure typically includes details about each MCU instance such as its state, identifiers, and other relevant properties depending on the API response. If binary data were involved, it would be summarized accordingly, but this node focuses on JSON conference data.

Dependencies

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

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query parameters (e.g., malformed filters or search strings) may result in API errors.
    • Network connectivity problems to the 3CX server can prevent data retrieval.
  • Error messages:
    • Authentication errors usually indicate invalid or expired credentials; reconfigure the API key.
    • Query parameter errors suggest checking the syntax of $filter, $search, etc.
    • Timeout or connection errors require verifying network access and server availability.

Links and References

Discussion