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 peers within the system. It is useful for scenarios where you need to retrieve and manage information about connected peers, such as extensions or devices registered in the 3CX environment. Practical examples include monitoring active connections, auditing peer configurations, or integrating peer data into other workflows.

Properties

Name Meaning
Options A collection of query parameters to customize the listing of peers:
- Top ($top) Show only the first n items (limit the number of results returned).
- Skip ($skip) Skip the first n items (useful for pagination).
- Search ($search) Search items by search phrases; supports phrase searching with automatic quoting if needed.
- Filter ($filter) Filter items by property values, 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 peers retrieved from the 3CX system. The structure corresponds to the queried peer objects, potentially including selected fields, expanded related entities, and metadata like counts if requested. If binary data were involved, it would typically represent media or files related to peers, 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 orderby 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.
    • Query parameter errors often return descriptive messages from the 3CX API; verify syntax and allowed values.
    • Connection errors suggest checking network access and server URL correctness.

Links and References

Discussion