3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Get Office Hours" operation in the 3CX node allows users to retrieve office hours data from the 3CX telephony system. This is useful for scenarios where you want to programmatically access or monitor the configured office hours, such as integrating with scheduling systems, automating call routing based on office hours, or generating reports about business availability.

For example, a user might use this node to fetch the current office hours settings to display them on a company intranet or to adjust call handling rules dynamically depending on whether the office is open or closed.

Properties

Name Meaning
$top Show only the first n items (limit the number of results returned).
$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 wrapped in quotes automatically.
$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 to include additional linked data (comma-separated list).

These options allow fine-grained control over the query to the 3CX API, enabling filtering, sorting, paging, and shaping the returned data.

Output

The node outputs JSON data representing the office hours retrieved from the 3CX system. The structure corresponds to the 3CX API's response for office hours, typically including fields like office hour IDs, names, start/end times, and possibly related entities if expanded.

If binary data were involved (not indicated here), it would be summarized accordingly, but this operation deals purely with JSON data.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests to the 3CX API.
  • The base URL for the 3CX server must be set correctly in the credentials configuration.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 credentials are valid and have sufficient permissions to read office hours.
  • Invalid query parameters: Using incorrect OData syntax in $filter, $orderby, or other query options may cause API errors. Validate these strings carefully.
  • Empty responses: If no office hours are returned, verify that office hours are configured in the 3CX system and that filters/search terms are not overly restrictive.
  • Network issues: Confirm that the 3CX server URL is reachable from the n8n instance and that there are no firewall or connectivity problems.

Links and References

Discussion