3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically allowing users to list SIP devices configured in their 3CX environment. It is useful for scenarios where you need to retrieve and manage information about SIP devices such as phones or softphones registered in the system. For example, an administrator might use this node to fetch a list of all active SIP devices to audit device usage or to synchronize device data with another system.

Properties

Name Meaning
Options A collection of query parameters to customize the listing of SIP devices:
- Top ($top) Limits the number of items returned to the first n entries.
- Skip ($skip) Skips the first n items in the result set, useful for pagination.
- Search ($search) Searches items by phrases; supports quoted phrases for exact matches.
- Filter ($filter) Filters items based on property values using OData syntax (e.g., State eq 'Connected').
- Count ($count) Includes the count of total items matching the query if set to true.
- Orderby ($orderby) Orders items by specified properties, e.g., Name desc, CreatedAt asc.
- Select ($select) Selects specific properties to be returned, e.g., Id,Name.
- Expand ($expand) Expands related entities to include additional linked data.

Output

The node outputs JSON data representing the list of SIP devices retrieved from the 3CX system. Each item in the output array corresponds to a SIP device with properties depending on the selected fields ($select) or default response. The output does not explicitly handle binary data.

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 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 search strings) may result in API errors.
    • Network connectivity problems can prevent communication with the 3CX server.
  • Error messages:
    • Authentication errors typically indicate invalid or expired API tokens; reconfigure credentials.
    • Query parameter errors suggest checking the syntax of filters, search phrases, and other options.
    • Timeout or connection errors require verifying network access and the correctness of the server URL.

Links and References

Discussion