3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, allowing users to interact programmatically with its API. Specifically, the "Tenant Properties" resource with the "Create Property" operation enables users to create custom properties for a tenant within the 3CX system. This can be useful for managing tenant-specific configurations or metadata dynamically.

Practical examples include:

  • Adding descriptive metadata to tenants for easier identification or categorization.
  • Storing configuration values that affect tenant behavior in the 3CX system.
  • Automating tenant setup by programmatically assigning properties during onboarding.

Properties

Name Meaning
Description A textual description of the tenant property being created.
Name The name/key identifier for the tenant property.
Value The value assigned to the tenant property.

Output

The node outputs JSON data representing the response from the 3CX API after creating the tenant property. This typically includes details about the newly created property such as its ID, name, value, and description.

If the node supports binary data output (not indicated here), it would represent any file or media content returned by the API, but this operation primarily deals with JSON data.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate requests against the 3CX API.
  • The base URL for the 3CX server must be provided in the credentials.
  • The node sends HTTP requests with JSON payloads to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is valid and has sufficient permissions to create tenant properties.
  • Invalid input data: Verify that the "Name", "Value", and "Description" fields are correctly filled and conform to expected formats.
  • Network issues: Confirm that the 3CX server URL is reachable from the n8n instance.
  • API errors: Check the response message for specific error codes or messages returned by the 3CX API to adjust request parameters accordingly.

Links and References

Discussion