3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically allowing retrieval of logging settings via the "Get Logging Settings" operation. This operation fetches logging configuration data from the 3CX system, which can be useful for monitoring, troubleshooting, or auditing telephony events and system behavior.

Common scenarios include:

  • Retrieving current logging configurations to verify system setup.
  • Filtering logs based on criteria such as state or creation date.
  • Paginating through large sets of logging entries.
  • Selecting specific properties or expanding related entities for detailed inspection.

Practical example:

  • An administrator wants to get the first 10 logging settings entries where the state is "Connected", ordered by creation date descending, to check recent connection logs.

Properties

Name Meaning
Options A collection of query parameters to customize the retrieval of logging settings:
- Top: Show only the first n items.
- Skip: Skip the first n items.
- Search: Search items by search phrases.
- Filter: Filter items by property values (e.g., State eq 'Connected').
- Count: Include count of items (boolean).
- Orderby: Order items by property values (e.g., Name desc, CreatedAt asc).
- Select: Select properties to be returned (e.g., Id,Name).
- Expand: Expand related entities (e.g., RelatedEntity1,RelatedEntity2).

Output

The output JSON contains the retrieved logging settings data structured according to the 3CX API response. It includes the requested logging entries with their properties as specified by the input options (such as selected fields or expanded related entities).

If binary data were involved (not indicated here), it would represent files or attachments related to logging settings, but this operation focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node uses the base URL configured in credentials to connect to the 3CX API endpoint /xapi/v1.
  • No additional external dependencies are indicated beyond the 3CX API access.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Invalid query parameters: Incorrect filter, orderby, or select syntax may cause API errors. Validate OData query expressions.
  • Empty results: May occur if filters exclude all entries or if the system has no logging settings configured.
  • Network issues: Verify connectivity to the 3CX server URL and that the URL is correctly formatted without trailing slashes.

Links and References

Discussion