3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to retrieve properties associated with a given DN (Directory Number). The "Get Properties By Dn" operation allows users to fetch detailed information about a specific DN number, which is useful in scenarios such as managing telephony configurations, monitoring call routing, or integrating telephony data into workflows.

Practical examples include:

  • Fetching configuration details for a particular extension number.
  • Retrieving status or metadata related to a DN for reporting or automation.
  • Filtering and searching DN properties based on various criteria to manage large telephony deployments.

Properties

Name Meaning
Dn Number The directory number (DN) to query. Usage format: dnNumber={dnNumber}. Required input.
Options Additional query options to refine the request results:
- Top Show only the first n items.
- Skip Skip the first n items.
- Search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be auto-quoted.
- Filter Filter items by property values, e.g., State eq 'Connected'.
- Count Include count of items (boolean).
- Select Select specific properties to be returned, e.g., Id,Name.
- Orderby Order items by property values, e.g., Name desc, CreatedAt asc.
- Expand Expand related entities, e.g., RelatedEntity1,RelatedEntity2.

Output

The node outputs JSON data containing the properties of the specified DN number. The structure typically includes an array of property objects matching the query parameters. Each object represents a property with its associated values as returned by the 3CX API.

If binary data were involved, it would be summarized here; however, this node focuses on JSON property data.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the credentials.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX server.
  • Proper network access to the 3CX server is necessary.

Troubleshooting

  • Invalid DN Number: If the DN number does not exist or is malformed, the API may return an error or empty result. Verify the DN number format.
  • Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions.
  • Network Issues: Confirm connectivity to the 3CX server URL.
  • Query Parameter Errors: Incorrect filter, search, or other query options might cause API errors. Validate syntax according to OData query standards.
  • Empty Results: May indicate no matching properties found; try adjusting filters or search terms.

Links and References

Discussion