3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing functionality to list phone logos associated with the system. It allows users to retrieve a filtered, sorted, and paginated list of phone logo items from the 3CX API. This is useful in scenarios where you want to programmatically access or manage phone logo resources, for example, to display available logos in a custom interface or to automate updates based on certain criteria.

Properties

Name Meaning
Options A collection of optional query parameters to customize the list request:
$top Show only the first n items (limit the number of results returned).
$skip Skip the first n items (offset for pagination).
$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 using OData filter syntax (e.g., State eq 'Connected').
$count Include count of items in the response (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).

Output

The node outputs JSON data representing the list of phone logos retrieved from the 3CX API. The structure typically includes an array of phone logo objects, each containing properties as requested via $select or default properties if none specified. If $count is true, the output may also include a total count of matching items.

If the node supports binary data output (not indicated here), it would represent phone logo images or related binary content, but this is not evident from the provided code and properties.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • Uses the 3CX REST API endpoint /xapi/v1 for requests.
  • The node expects the 3CX OAuth2 authentication method to be set up in n8n credentials.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials can cause authentication failures.
    • Invalid query parameters (e.g., malformed $filter or $orderby) may result in API errors.
    • Network connectivity problems to the 3CX server will prevent successful requests.
  • Error messages:
    • Authentication errors usually indicate invalid or expired tokens; re-authenticate or update credentials.
    • API validation errors suggest incorrect query syntax; verify OData query formats.
    • Timeout or connection errors require checking network access and server availability.

Links and References

Discussion