3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve notification settings. Specifically, the "Get Notification Settings" operation fetches a list of notification settings from the 3CX API. This is useful for scenarios where you want to programmatically access and manage notification configurations within your telephony environment, such as auditing current notification setups or integrating notification data into other workflows.

Practical examples include:

  • Automatically retrieving notification settings to display in a dashboard.
  • Filtering notification settings based on certain criteria to trigger alerts or updates.
  • Exporting notification settings for backup or migration purposes.

Properties

Name Meaning
Options A collection of query parameters to customize the retrieval of notification settings:
- $top Show only the first n items.
- $skip Skip the first n items.
- $search Search items by search phrases. If the phrase contains spaces and is not already quoted, it will be wrapped in quotes automatically.
- $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-grained control over which notification settings are retrieved and how they are presented.

Output

The node outputs JSON data representing the notification settings retrieved from the 3CX API. The structure typically includes an array of notification setting objects, each containing properties as specified or filtered by the input options.

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

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query parameters (e.g., malformed $filter or $orderby) may result in API errors.
    • Network connectivity problems can prevent the node from reaching the 3CX server.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • API response errors related to query parameters suggest checking the syntax and supported fields for filtering, ordering, and selecting.
    • Timeout or connection errors require verifying network access and the correctness of the server URL.

Links and References

  • 3CX API Documentation — Official documentation for the 3CX API endpoints and query options.
  • OData Query Options — Explanation of common query parameters like $filter, $orderby, $select, etc., used in the node's options.

Discussion