3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing functionality to list managers of a given queue. It is useful in scenarios where you need to retrieve and manage information about users who have managerial roles over specific call queues within the 3CX system. For example, a contact center supervisor might use this node to fetch all managers assigned to a particular queue to audit or update their permissions.

Properties

Name Meaning
Id The unique identifier of the queue entity for which to list managers. Can be set dynamically via expressions.
Options A collection of optional query parameters to refine the listing:
- Top ($top) Limits the number of returned items to the first n entries.
- Skip ($skip) Skips the first n items in the result set.
- Search ($search) Searches items by phrases; automatically adds quotes if the phrase contains spaces and is not already quoted.
- Filter ($filter) Filters items based on property values (e.g., "State eq 'Connected'").
- Count ($count) Includes the count of items in the response when true.
- Orderby ($orderby) Orders items by specified property values (e.g., "Name desc, CreatedAt asc").
- Select ($select) Selects specific properties to be returned (e.g., "Id,Name").
- Expand ($expand) Expands related entities to include additional data (e.g., "RelatedEntity1,RelatedEntity2").

Output

The node outputs JSON data representing the list of managers associated with the specified queue. Each item in the output typically includes manager details such as identifiers and relevant properties as requested via the $select option. The structure corresponds to the 3CX API response for queue managers.

If binary data were involved, it would be summarized here, but this node deals only with JSON data.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid Queue Id: If the provided queue Id does not exist or is incorrect, the API may return an error or empty results. Verify the Id value.
  • Authentication Errors: Ensure that the API key credential is valid and has sufficient permissions to access queue manager data.
  • Query Parameter Issues: Incorrectly formatted filter, search, or orderby strings can cause API errors. Use correct OData syntax and verify expressions.
  • Empty Results: If no managers are returned, confirm that the queue actually has managers assigned and that filters/search terms are not overly restrictive.

Links and References

Discussion