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 templates. It is useful in scenarios where users need to retrieve and manage phone template data from their 3CX system within an automated workflow. For example, a user might want to fetch all available phone templates to display them in a dashboard or to synchronize them with another system.

Properties

Name Meaning
Options A collection of query parameters to customize the listing of phone templates:
$top Show only the first n items
$skip Skip the first n items
$search Search items by search phrases. If the search phrase contains spaces and is not quoted, it will be automatically quoted.
$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")

Output

The node outputs JSON data representing the list of phone templates retrieved from the 3CX system. The structure corresponds to the queried phone template objects, potentially including expanded related entities if requested. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials can cause authentication failures.
    • Invalid query parameters (e.g., malformed filter or orderby strings) may result in API errors.
    • Network connectivity problems can prevent communication with the 3CX server.

  • Error messages:

    • Authentication errors typically indicate invalid or expired credentials; verify and update the API key.
    • Query parameter errors suggest syntax issues; review the filter, search, and orderby expressions.
    • Timeout or connection errors imply network issues; check server availability and firewall settings.

Links and References

Discussion