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 addresses from a blocklist. It is useful in scenarios where users want to retrieve and manage blocked addresses within their 3CX environment, such as monitoring unwanted calls or managing security policies.

A practical example would be an administrator automating the retrieval of blocked phone numbers to audit or export them for further analysis.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of blocklist addresses:
- 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).

Output

The node outputs JSON data representing the list of blocklisted addresses retrieved from the 3CX system. The structure typically includes details about each blocked address according to the selected or default properties.

If binary data were involved (not indicated here), it would represent associated files or media, but this node focuses on JSON data 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 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 prevent data retrieval.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Query parameter errors suggest checking the syntax and allowed values for filters, search, and ordering.
    • Timeout or connection errors require verifying network access and server availability.

Links and References

Discussion