3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing operations related to managing Website Links within 3CX. The "List Weblink" operation retrieves a list of website links configured in the 3CX system. This can be useful for scenarios where you want to automate the retrieval and processing of web links associated with your telephony setup, such as displaying them in dashboards, syncing with other systems, or auditing link configurations.

Practical examples include:

  • Fetching all website links to display in a custom reporting tool.
  • Filtering website links based on certain criteria (e.g., only active links).
  • Paginating through large sets of website links using top and skip options.

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 returned links).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be wrapped in quotes automatically.
$filter Filter items by property values (e.g., State eq 'Connected').
$count Include count of items (boolean to indicate if total count should be returned).
$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 website links retrieved from the 3CX system. Each item in the output corresponds to a website link entity with its properties as returned by the API, potentially filtered or shaped according to the input options.

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

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects a base URL for the 3CX server, which must be provided in the credentials configuration.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Invalid query parameters: Incorrect filter, orderby, or select syntax may cause API errors. Verify the syntax matches the 3CX API requirements.
  • Empty results: Check if the filters or search terms are too restrictive.
  • Pagination issues: When using $top and $skip, ensure values are numeric strings and within valid ranges.
  • Network errors: Confirm the 3CX server URL is reachable and correct.

Links and References

  • 3CX API documentation (refer to official 3CX developer resources for detailed API usage)
  • n8n documentation on creating and using HTTP Request nodes and authentication mechanisms

Discussion