3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically allowing users to retrieve detailed information about a particular queue within the system. It is useful in scenarios where you need to programmatically access queue data for monitoring, reporting, or integration purposes. For example, you might use this node to fetch the current status or configuration of a call queue to display in a dashboard or to trigger workflows based on queue metrics.

Properties

Name Meaning
Id The unique identifier of the queue entity to retrieve. You can provide a static number or use an expression to dynamically specify the ID.
Options Additional query options to customize the returned data:
- $select Comma-separated list of specific properties of the queue to return (e.g., "Id,Name").
- $expand Comma-separated list of related entities to expand and include in the response.

Output

The node outputs JSON data representing the requested queue entity. The structure of the JSON corresponds to the properties of the queue as defined by the 3CX API. If $select is used, only those selected properties will be included. If $expand is specified, related entities will be embedded in the output JSON.

No binary data output is indicated.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials.
  • The base URL for the 3CX API must be set in the node credentials (serverUrl).
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Invalid or missing Queue Id: Ensure that the Id property is correctly set and corresponds to an existing queue in the 3CX system.
  • Authentication errors: Verify that the OAuth2 credentials are valid and have not expired.
  • API endpoint issues: Confirm that the serverUrl credential is correctly configured and reachable.
  • Incorrect $select or $expand syntax: Use comma-separated values without spaces; invalid property names may cause errors or empty responses.

Links and References

Discussion