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 details about a blacklisted phone number by its unique identifier. It is useful in scenarios where you need to check if a particular number is blacklisted or to fetch detailed information about that blacklist entry. For example, a user might want to verify if an incoming call's number is on the blacklist before deciding how to handle the call.

Properties

Name Meaning
Id The unique identifier of the blacklisted number entity to retrieve. Supports expressions like {{$json.Id}}. This property is required.
Options A collection of optional query parameters:
- Select ($select) Specify which properties of the blacklisted number entity should be returned (e.g., Id,Name).
- Expand ($expand) Specify related entities to expand and include in the response (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the blacklisted number entity corresponding to the provided Id. The structure of this JSON depends on the selected properties and expanded related entities specified in the options. 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 node credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Missing or invalid Id: The node requires a valid Id to fetch the blacklisted number. Ensure the Id is correctly provided and matches an existing entity.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • API endpoint issues: Confirm that the base URL for the 3CX API is correct and accessible from your environment.
  • Invalid $select or $expand values: Using incorrect property names in these options may result in incomplete or error responses. Check the 3CX API documentation for valid fields.

Links and References

Discussion