3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system to list greetings associated with a specific user. It is useful in scenarios where you want to retrieve and manage voice greetings configured for users within the 3CX system, such as fetching voicemail greetings or custom announcements.

For example, a user might want to automate the retrieval of all greetings for a particular user ID to display them in a dashboard or to process them further (e.g., update or delete).

Properties

Name Meaning
Id The unique identifier of the user entity whose greetings are to be listed.
Options A collection of optional query parameters to refine the listing:
- Top: Show only the first n items.
- Skip: Skip the first n items.
- Search: Search items by search phrases (supports phrase quoting).
- 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 greetings retrieved for the specified user. Each item in the output corresponds to a greeting entity with its properties as returned by the 3CX API.

If the API supports it, the output may include metadata such as total count when requested via options.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • 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 to the /xapi/v1 endpoint of the 3CX server.

Troubleshooting

  • Invalid User ID: If the provided user ID does not exist, the API will likely return an error or empty results. Verify the ID is correct.
  • Authentication Errors: Ensure that the API authentication token is valid and has sufficient permissions to access user greetings.
  • Query Parameter Issues: Incorrectly formatted filter, search, or other query options may cause the API to reject the request. Use proper syntax as per OData query conventions.
  • Network Connectivity: Confirm that the n8n instance can reach the 3CX server URL configured in credentials.

Links and References

Discussion