3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system to retrieve license status information. Specifically, the "Get License Status" operation fetches details about the current licenses in use or available within the 3CX system. This is useful for administrators who want to monitor license usage, verify compliance, or audit their telephony system's licensing state.

Practical examples include:

  • Automatically checking license availability before provisioning new users or services.
  • Generating reports on license consumption over time.
  • Integrating license status checks into broader IT management workflows.

Properties

Name Meaning
Options A collection of optional query parameters to customize the request:
- $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 specific properties to be returned (e.g., Id,Name)
- $expand Expand related entities (e.g., RelatedEntity1,RelatedEntity2)

These options allow fine-tuning of the data retrieved from the license status endpoint, enabling filtering, sorting, pagination, and selection of specific fields or related entities.

Output

The node outputs JSON data representing the license status information retrieved from the 3CX API. The structure typically includes details such as license types, counts, states, and possibly related entities if expanded.

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

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 based on user input.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query parameters (e.g., malformed filter or search strings) may result in API errors.
    • Network connectivity problems to the 3CX server can cause request timeouts or failures.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; reconfigure credentials.
    • 400-series errors often mean bad request syntax; verify query parameter formats.
    • 500-series errors suggest server-side issues; retry later or contact 3CX support.

Links and References

Discussion