3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve remote archiving settings. Specifically, the "Get Remote Archiving Settings" operation fetches configuration details related to remote archiving within the 3CX system. This can be useful for administrators or automation workflows that need to monitor, audit, or manage archiving configurations remotely.

Practical examples include:

  • Automatically retrieving current remote archiving settings to verify compliance.
  • Integrating archiving status checks into broader communication system monitoring.
  • Using filters and search options to find specific archiving configurations based on criteria.

Properties

Name Meaning
Options A collection of optional query parameters to customize the retrieval of remote archiving settings:
- Top: Show only the first n items.
- Skip: Skip the first n items.
- Search: Search items by search phrases (supports phrase quoting).
- 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 specific properties to be returned (e.g., Id,Name).
- Expand: Expand related entities (e.g., RelatedEntity1,RelatedEntity2).

Note: The "Options" property appears twice in the provided JSON but represents the same set of configurable query parameters.

Output

The node outputs JSON data representing the remote archiving settings retrieved from the 3CX system. The structure corresponds to the queried properties and any expanded related entities as specified by the input options.

If binary data were involved (not indicated here), it would typically represent files or attachments related to the archiving settings, but this node focuses on JSON metadata output.

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

  • Authentication errors: Ensure the API key or OAuth2 token is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect filter, search, or select syntax may cause API errors. Validate OData-like query expressions.
  • Empty results: Check if filters or search terms are too restrictive or if the remote archiving settings exist.
  • Network issues: Verify connectivity to the 3CX server URL and that the server is reachable.

Links and References

Discussion