3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically allowing users to retrieve a tenant property by its key (Name). It is useful in scenarios where you need to dynamically fetch configuration or metadata stored as tenant properties within the 3CX system. For example, you might want to get a specific setting or parameter that controls call routing or user preferences.

Properties

Name Meaning
Name The key of the tenant property to retrieve. Supports expressions, e.g., {{$json.Name}}.
Options Additional query options:
- Select: Specify which properties of the entity to return (e.g., "Id,Name").
- Expand: Expand related entities to include additional linked data (e.g., "RelatedEntity1,RelatedEntity2").

Output

The node outputs JSON data representing the tenant property identified by the provided Name key. The structure depends on the selected options but generally includes the requested property fields and any expanded related entities if specified.

If binary data were involved, it would be summarized here, but this node deals only with JSON 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 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing an invalid or non-existent property Name will result in no data or an error response.
    • Improperly formatted $select or $expand options may lead to unexpected results or API errors.

  • Error messages:

    • Authentication errors typically indicate invalid or expired credentials; reconfigure the API key.
    • "Property not found" or similar indicates the specified Name does not exist; verify the key.
    • Query parameter errors suggest malformed $select or $expand values; ensure correct syntax.

Links and References

Discussion