3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing an operation to list available codecs. It allows users to retrieve codec information from the 3CX API with flexible query options such as filtering, searching, ordering, and pagination. This is useful in scenarios where you need to programmatically access or audit the codecs supported or configured in a 3CX environment.

Practical examples include:

  • Fetching a limited number of codecs for display in a dashboard.
  • Searching codecs by name or other properties.
  • Filtering codecs based on specific criteria like state or type.
  • Ordering codecs by creation date or name.

Properties

Name Meaning
Options A collection of optional query parameters to customize the list of codecs returned:
- Top ($top) Show only the first n items (pagination limit).
- Skip ($skip) Skip the first n items (pagination offset).
- Search ($search) Search items by search phrases; supports phrase quoting if spaces are present.
- Filter ($filter) Filter items by property values using expressions (e.g., State eq 'Connected').
- Count ($count) Include count of total items in the response (boolean).
- Orderby ($orderby) Order items by property values (e.g., Name desc, CreatedAt asc).
- Select ($select) Select specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expand related entities to include additional linked data (e.g., RelatedEntity1).

Output

The node outputs JSON data representing the list of codecs retrieved from the 3CX API. The structure typically includes an array of codec objects with their properties as specified or filtered by the input options.

If the $count option is enabled, the output may also include metadata about the total number of codecs available.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to a 3CX telephony system API endpoint.
  • Needs an API authentication token credential configured in n8n (OAuth2-based).
  • The base URL for the 3CX API must be provided in the credentials configuration.
  • The node sends requests with Accept: application/json header and expects JSON responses.

Troubleshooting

  • Authentication errors: Ensure that the API authentication token is valid and has sufficient permissions to access codec information.
  • Invalid query parameters: Incorrect filter, search, or orderby syntax can cause API errors. Validate expressions against 3CX API documentation.
  • Empty results: If no codecs are returned, verify that the 3CX system has codecs configured and that filters/search terms are correct.
  • Connection issues: Confirm the server URL is correct and reachable from the n8n instance.

Links and References

Discussion