3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system to list active calls. It is useful for scenarios where users need to monitor ongoing calls, retrieve call details in real-time, or build dashboards and reports based on current call activity. For example, a customer support team could use this node to display all active calls in their queue or an administrator might track call volume during peak hours.

Properties

Name Meaning
Options A collection of query parameters to customize the listing of active calls:
- Top ($top) Limits the number of returned items 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; if the phrase contains spaces and is not quoted, it will be automatically quoted.
- Filter ($filter) Filters items by property values using OData syntax (e.g., State eq 'Connected').
- Count ($count) Includes the 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 list of active calls retrieved from the 3CX system. Each item in the output array corresponds to an active call and includes properties as specified by the $select option or defaults to all available fields. The output may also include metadata such as counts if requested.

If binary data were involved (e.g., recordings), it would be indicated here, but this operation focuses on JSON call data only.

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 with appropriate query parameters.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is valid and has sufficient permissions.
  • Invalid query parameters: Using incorrect OData filter syntax or unsupported property names in options like $filter, $orderby, or $select can cause errors. Verify parameter correctness against 3CX API documentation.
  • Empty results: If no active calls are returned, check if there are indeed active calls at the time or adjust filters/search criteria.
  • Network issues: Confirm that the server URL is correct and accessible from n8n.

Links and References

Discussion