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 SBCs (Session Border Controllers). It allows users to retrieve a filtered, sorted, and paginated list of SBCs configured in their 3CX environment. This is useful for administrators who want to automate monitoring or management tasks related to their telephony infrastructure.

Common scenarios include:

  • Fetching a subset of SBCs based on specific criteria such as connection state or name.
  • Automating reports on SBC status or configuration.
  • Integrating SBC data into broader communication workflows within n8n.

Properties

Name Meaning
Options A collection of query parameters to customize the list of SBCs returned:
- Top ($top) Show only the first n items.
- Skip ($skip) Skip the first n items.
- Search ($search) Search items by search phrases. If the phrase contains spaces and is not quoted, it will be automatically quoted.
- Filter ($filter) Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
- Count ($count) Include count of items in the response (boolean).
- Orderby ($orderby) Order items by property values (e.g., Name desc, CreatedAt asc).
- Select ($select) Select specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expand related entities (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the list of SBCs retrieved from the 3CX API. The structure corresponds to the properties selected or returned by default from the API endpoint. Each item in the output array represents an SBC with its associated details such as ID, name, state, and other relevant attributes.

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

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects the base URL of the 3CX server to be provided in credentials.
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.
  • Proper network access to the 3CX server is necessary.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is valid and has sufficient permissions.
  • Network errors: Verify connectivity to the 3CX server URL and that the URL is correctly configured without trailing slashes.
  • Invalid query parameters: Incorrect filter, orderby, or select syntax may cause API errors. Use correct OData syntax.
  • Empty results: Check if filters or search terms are too restrictive or incorrect.
  • API limits: Be aware of any rate limits imposed by the 3CX API which might affect large queries.

Links and References

Discussion