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 list event logs. It is useful for scenarios where users want to retrieve and analyze telephony event data such as call records, system events, or user activities within the 3CX environment. For example, a user might use this node to fetch recent call logs filtered by date or status, enabling integration with reporting tools or triggering workflows based on specific telephony events.

Properties

Name Meaning
Options A collection of query parameters to customize the event log listing:
- Top ($top) Show only the first n items (limit the number of results returned).
- Skip ($skip) Skip the first n items (useful for pagination).
- Search ($search) Search items by search phrases; supports automatic quoting if the phrase contains spaces.
- Filter ($filter) Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
- Count ($count) Include count of total items in the response (boolean).
- Orderby ($orderby) Order items by property values (e.g., Name desc, CreatedAt asc).
- Select ($select) Select specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expand related entities to include additional linked data (e.g., RelatedEntity1).

Output

The node outputs JSON data representing the list of event logs retrieved from the 3CX system. Each item corresponds to an event log entry with properties depending on the selected fields or defaults. The output can include metadata such as counts if requested. There is no indication that binary data is returned by this operation.

Dependencies

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

Troubleshooting

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

Links and References

Discussion