3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node integrates with the 3CX telephony system, specifically providing functionality to retrieve a list of peers from the system's report endpoint. This operation is useful for scenarios where users need to analyze or monitor telephony peers, such as checking connection statuses, filtering peers by certain criteria, or exporting peer data for reporting purposes.

Practical examples include:

  • Fetching the top 10 connected peers to monitor active telephony endpoints.
  • Searching peers by name or other attributes using search phrases.
  • Filtering peers based on their state (e.g., only those currently connected).
  • Ordering and selecting specific properties to tailor the output for dashboards or further processing.

Properties

Name Meaning
Options A collection of query parameters to customize the retrieval of peers:
- Top ($top) Limits the number of items returned to the first n peers.
- Skip ($skip) Skips the first n peers in the result set, useful for pagination.
- Search ($search) Searches peers by phrases; supports quoted phrases for exact matches.
- Filter ($filter) Filters peers by property values, e.g., State eq 'Connected'.
- Count ($count) Boolean flag to include the total count of items matching the query.
- Select ($select) Specifies which properties of peers to return, e.g., Id,Name.
- Orderby ($orderby) Orders the results by specified properties, e.g., Name desc, CreatedAt asc.
- Expand ($expand) Expands related entities to include additional linked data in the response.

Output

The node outputs JSON data representing the list of peers retrieved from the 3CX system according to the specified query options. The structure typically includes an array of peer objects with properties such as identifiers, names, states, and any other selected fields.

If the $count option is enabled, the output may also include metadata about the total number of peers matching the query.

No binary data output is indicated for this operation.

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 configured in the credentials.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX API.
  • Proper network access to the 3CX server is necessary.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token provided in the credentials is valid and has sufficient permissions.
  • Connection issues: Verify the server URL is correct and accessible from the n8n instance.
  • Invalid query parameters: Incorrect filter, search, or orderby syntax can cause API errors. Refer to 3CX API documentation for correct OData query syntax.
  • Empty results: Check if filters or search terms are too restrictive or if there are no peers matching the criteria.
  • Unexpected response format: Confirm that the 3CX API version matches the expected /xapi/v1 endpoint and that the server is running the compatible version.

Links and References

Discussion