3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing an operation to list service information. It allows users to retrieve detailed data about services configured in their 3CX environment. This can be useful for administrators who want to monitor or audit service statuses, filter services based on criteria, or integrate service data into workflows.

Common scenarios include:

  • Fetching a list of active or connected services.
  • Searching for specific services by name or other attributes.
  • Paginating through large sets of services using skip and top options.
  • Selecting only certain properties of services to reduce payload size.
  • Expanding related entities to get more comprehensive service details.

Practical example: An administrator could use this node to list all connected services, filter them by state, and then trigger alerts or updates based on service status changes.

Properties

Name Meaning
Options A collection of query parameters to customize the listing of services:
- Top ($top) Show only the first n items (pagination limit).
- Skip ($skip) Skip the first n items (pagination offset).
- Search ($search) Search items by search phrases; supports phrase searching with quotes automatically added if needed.
- Filter ($filter) Filter items by property values, e.g., State eq 'Connected'.
- Count ($count) Include count of total 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 to include additional linked data, e.g., RelatedEntity1.

Output

The node outputs JSON data representing the list of services retrieved from the 3CX API. The structure corresponds to the queried service entities, including any selected or expanded properties as specified in the input options.

If the $count option is enabled, the output will also include the total count of matching services.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be provided in the credentials configuration.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX server.
  • The node expects JSON responses and sets the Accept: application/json header.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in filter, orderby, or search fields may cause API errors. Validate these strings carefully.
  • Empty results: If no services are returned, check filter and search criteria or verify that services exist on the 3CX server.
  • Network issues: Verify connectivity to the 3CX server URL and that the server is reachable.
  • API version mismatch: The node targets version 1 of the API (/xapi/v1). Confirm compatibility with your 3CX server version.

Links and References

Discussion