3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to retrieve codec settings information. The "Get Codecs Settings" operation fetches details about available codecs configured in the 3CX system. This can be useful for administrators or integrators who want to programmatically access codec configurations for monitoring, reporting, or automation purposes.

Practical examples include:

  • Automatically retrieving and displaying codec settings in a dashboard.
  • Integrating codec information into a larger telephony management workflow.
  • Auditing codec configurations across multiple 3CX instances.

Properties

Name Meaning
Options A collection of query parameters to customize the request:
$top Show only the first n items (limit results).
$skip Skip the first n items (offset results).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be quoted automatically.
$filter Filter items by property values (e.g., State eq 'Connected').
$count Include count of items (boolean).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$select Select specific properties to be returned (e.g., Id,Name).
$expand Expand related entities (e.g., RelatedEntity1,RelatedEntity2).

These options allow fine-grained control over the data retrieved from the 3CX API.

Output

The node outputs JSON data representing the codec settings retrieved from the 3CX system. The structure corresponds to the 3CX API response for codec settings, typically including codec identifiers, names, statuses, and other relevant properties.

If binary data were involved (not indicated here), it would represent files or media content related to codecs, but this node focuses on JSON metadata.

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.
  • The node sends HTTP requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is valid and has sufficient permissions.
  • Connection issues: Verify the server URL is correct and accessible from the n8n instance.
  • Invalid query parameters: Incorrect filter, search, or orderby syntax may cause API errors; validate these against 3CX API documentation.
  • Empty responses: Could indicate no matching codec settings found; try adjusting filters or removing restrictive options.

Links and References

Discussion