3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically allowing retrieval of phone template details by their unique identifier. This operation is useful when you need to fetch configuration or metadata about a specific phone template within the 3CX system, for example, to automate provisioning, auditing, or integration workflows that depend on phone template data.

A practical example would be an automation that, given a phone template ID from a previous step, retrieves detailed information about that template to decide how to configure a new device or user profile.

Properties

Name Meaning
Id The unique identifier of the phone template to retrieve. Can be set using expressions.
Options Additional query options:
- $select Comma-separated list of properties to return (e.g., "Id,Name").
- $expand Comma-separated list of related entities to expand and include in the response.

Output

The output JSON contains the phone template data retrieved from the 3CX API. It includes all requested fields and any expanded related entities as specified in the options. The structure corresponds directly to the 3CX phone template entity schema.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be provided in the credentials configuration.

Troubleshooting

  • Missing or invalid Id: If the Id property is empty or incorrect, the API will fail to find the phone template. Ensure the Id is correctly set and valid.
  • Authentication errors: If the API key or OAuth2 token is missing or expired, requests will fail. Verify credentials are properly configured and valid.
  • Invalid $select or $expand values: Providing incorrect property names in these options may cause the API to reject the request or return incomplete data. Use valid property names as per 3CX API documentation.
  • Network issues: Connectivity problems to the 3CX server will prevent data retrieval. Check network access and server availability.

Links and References

Discussion