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 greetings associated with the current user ("My User"). It is useful for scenarios where you want to retrieve and manage personalized greeting messages configured in 3CX for your user account. For example, a contact center agent or administrator might use this node to fetch all their voicemail or call greeting messages to display them in a dashboard or to automate updates.

Properties

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

Output

The node outputs JSON data representing the list of greetings for the current user. The structure typically includes an array of greeting objects, each containing properties such as ID, name, state, creation date, and any other selected or expanded fields based on the input options.

If the API supports binary data for greetings (e.g., audio files), the node would handle that accordingly, but from the provided code and properties, the output focuses on JSON metadata about greetings.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in the credentials.
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.
  • No additional external dependencies are indicated.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query parameters (e.g., malformed $filter or $orderby) may result in API errors.
    • Network connectivity problems to the 3CX server can cause request timeouts or failures.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Query syntax errors should be checked against 3CX API documentation for correct OData filter/orderby syntax.
    • If no greetings are returned, verify that the user has greetings configured and that filters/search terms are correct.

Links and References

Discussion