3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system to manage blocklist addresses. Specifically, the "Create Blocklist Addr" operation allows users to add an IP address or IP address mask to the blocklist or allowlist within 3CX. This is useful for controlling access and filtering unwanted or trusted IPs in a telephony environment.

Common scenarios include:

  • Automatically blocking suspicious IP addresses detected by security systems.
  • Manually adding IPs to a whitelist or blacklist based on administrative decisions.
  • Temporarily allowing or blocking IPs with expiration times.
  • Adding descriptive metadata to blocklist entries for audit or tracking purposes.

Example use case: A company wants to block all calls from a range of IP addresses known for spam calls. Using this node, they can create a blocklist entry specifying the IP address mask and set it to expire after a certain date.

Properties

Name Meaning
Added By Specifies who added the blocklist entry. Options: Manual, Mcu, Webmeeting, Auto Blacklist, Whitelist
Block Type Defines whether the IP should be blocked or allowed. Options: Block, Allow
Description Optional text describing the reason or context for the blocklist entry
Expires At Expiration date/time for the blocklist entry (string format)
Id Numeric identifier for the blocklist entry
IP Addr Mask The IP address or IP address mask to be blocked or allowed

Output

The node outputs JSON data representing the result of the blocklist creation request. This typically includes confirmation details such as the created blocklist entry's ID, status, and any relevant metadata returned by the 3CX API.

No binary data output is involved.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials.
  • The base URL of the 3CX server must be provided in the node credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid Credentials: If the API key or OAuth2 token is incorrect or expired, the node will fail to authenticate. Ensure valid credentials are configured.
  • Incorrect IP Address Format: Providing an invalid IP address or mask may cause the API to reject the request. Validate IP formats before sending.
  • Missing Required Fields: Omitting mandatory properties like IP Addr Mask or Block Type can lead to errors. Make sure all required inputs are set.
  • API Endpoint Unreachable: Network issues or incorrect server URL configuration can prevent communication with 3CX. Verify connectivity and URL correctness.
  • Expiration Date Format: The Expires At field should be in a proper string format accepted by the API; otherwise, the request might fail.

Links and References

Discussion