3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing an operation to retrieve chat log settings. This operation allows users to query and obtain configuration details related to chat logs within the 3CX environment. It is useful for scenarios where you need to audit, monitor, or manage chat log configurations programmatically, such as integrating chat log data into reporting tools or automating compliance checks.

Properties

Name Meaning
Options A collection of optional query parameters to customize the retrieval of chat log settings:
- Top ($top) Show only the first n items (string).
- Skip ($skip) Skip the first n items (string).
- Search ($search) Search items by search phrases (string). Supports automatic quoting if phrase contains spaces.
- Filter ($filter) Filter items by property values (string), e.g., State eq 'Connected'.
- Count ($count) Include count of items (boolean).
- Orderby ($orderby) Order items by property values (string), e.g., Name desc, CreatedAt asc.
- Select ($select) Select properties to be returned (string), e.g., Id,Name.
- Expand ($expand) Expand related entities (string), e.g., RelatedEntity1,RelatedEntity2.

These options allow fine-grained control over the data retrieved from the chat log settings endpoint, enabling filtering, sorting, pagination, and selection of specific fields or related entities.

Output

The output consists of JSON data representing the chat log settings retrieved from the 3CX system. The structure will reflect the properties selected or expanded via the input options. Typically, this includes an array of chat log setting objects with their respective attributes.

If binary data were involved (not indicated here), it would represent files or media related to chat logs, but this operation focuses on JSON metadata.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token provided is valid and has sufficient permissions to access chat log settings.
  • Invalid query parameters: Incorrect syntax in filter, orderby, or other OData-like query options may cause API errors. Validate these strings carefully.
  • Empty results: If no chat log settings are returned, verify that the 3CX system actually has chat log settings configured and that filters/search terms are not overly restrictive.
  • Network issues: Confirm that the base URL is correct and reachable from the n8n instance.

Links and References

Discussion