3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing access to system status information related to system extensions. It allows users to query and retrieve details about the extensions configured in the 3CX system. This can be useful for monitoring extension states, managing telephony resources, or integrating extension data into workflows.

Common scenarios include:

  • Fetching a list of active or connected extensions.
  • Filtering extensions based on specific criteria such as state or name.
  • Paginating through large sets of extension data.
  • Searching extensions by keywords.

For example, a user might want to retrieve only the first 10 connected extensions or search for extensions matching a particular pattern.

Properties

Name Meaning
Options A collection of optional query parameters to refine the request:
- Top: Show only the first n items (pagination limit).
- Skip: Skip the first n items (pagination offset).
- Search: Search items by search phrases; supports phrase quoting automatically.
- Filter: Filter items by property values using OData-like syntax (e.g., State eq 'Connected').
- Count: Include count of total items in the response (boolean).

Output

The node outputs JSON data representing the queried system extensions from the 3CX telephony system. The structure typically includes an array of extension objects, each containing properties describing individual extensions such as their state, identifier, and other metadata.

If the "Count" option is enabled, the output will also include the total number of matching extensions.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX 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.

Troubleshooting

  • Authentication errors: Ensure that the API key credential and server URL are correctly configured and valid.
  • Empty results: Check filter and search parameters for correctness; improper syntax may lead to no matches.
  • Pagination issues: When using Top and Skip, verify that values are numeric strings and within valid ranges.
  • API connectivity: Confirm network access to the 3CX server and that the API endpoint is reachable.
  • Invalid query parameters: Use correct OData-like syntax for filters; invalid expressions may cause errors.

Links and References

Discussion