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 retrieve MCU (Multipoint Control Unit) rows from the conference settings. It is useful in scenarios where users need to programmatically access and manage conference call data within 3CX, such as monitoring active conferences or integrating conference details into other workflows.

For example, a user might use this node to fetch a list of current conference sessions filtered by certain criteria, or to paginate through large sets of conference data for reporting purposes.

Properties

Name Meaning
Options A collection of query parameters to control the retrieval of MCU rows:
- Top Show only the first n items (pagination limit).
- Skip Skip the first n items (pagination offset).
- Search Search items by search phrases; supports automatic quoting if spaces are present.
- Filter Filter items by property values using OData-like syntax (e.g., State eq 'Connected').
- Count Include count of items in the response (boolean).

Output

The node outputs JSON data representing the MCU rows retrieved from the 3CX conference settings. The structure typically includes an array of conference entries matching the query parameters. If the Count option is enabled, the output will also include the total number of items available.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects a base URL for the 3CX server, configured via credentials.
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token provided is valid and has sufficient permissions.
  • Invalid filter/search syntax: Use correct OData-like syntax for filters; improper formatting may cause request failures.
  • Pagination issues: When using Top and Skip, ensure values are numeric strings; invalid values may result in unexpected results or errors.
  • Empty responses: Verify that the search/filter criteria match existing conference data; otherwise, no rows will be returned.

Links and References

Discussion