3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Get Voicemail Settings" operation in this node allows users to retrieve voicemail configuration data from the 3CX telephony system. This is useful for scenarios where you want to programmatically access voicemail settings, such as auditing voicemail configurations, integrating voicemail data into other systems, or automating management tasks related to voicemail.

For example, a user might want to fetch all voicemail settings with specific filters applied, or only retrieve certain properties of voicemail settings to display in a custom dashboard.

Properties

Name Meaning
Options A collection of optional query parameters to customize the retrieval of voicemail settings:
$top Show only the first n items (limit the number of results).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not already quoted, it will be automatically quoted.
$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 (comma-separated list, e.g., Id,Name).
$expand Expand related entities (comma-separated list, e.g., RelatedEntity1,RelatedEntity2).

These options allow fine-grained control over which voicemail settings are retrieved and how they are presented.

Output

The node outputs JSON data representing the voicemail settings retrieved from the 3CX API. The structure of the JSON depends on the selected properties and expansions specified in the input options.

If binary data were involved (e.g., audio files), it would be indicated here, but this operation focuses on retrieving voicemail settings metadata, so no binary output is expected.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Requires an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be provided in the credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters based on the input options.

Troubleshooting

  • Authentication errors: Ensure that the API authentication token is valid and has sufficient permissions to read voicemail settings.
  • Invalid query parameters: Incorrectly formatted $filter, $orderby, or other OData query options may cause API errors. Validate the syntax according to 3CX API documentation.
  • Empty responses: If no voicemail settings are returned, verify that the 3CX system actually has voicemail settings configured and that any filters/searches are not too restrictive.
  • Network issues: Confirm that the server URL is correct and reachable from the n8n instance.

Links and References

Discussion