3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing functionality to list agents associated with a particular queue. This operation is useful in scenarios where you need to retrieve and manage information about agents assigned to queues, such as monitoring agent availability, managing call routing, or generating reports on agent activity.

Practical examples include:

  • Fetching all agents currently assigned to a specific queue to display their status.
  • Filtering agents based on certain criteria like connection state or name.
  • Paginating through large sets of agents using top and skip options.

Properties

Name Meaning
Id The unique identifier of the queue entity for which agents are to be listed. You can provide this as a static number or dynamically via an expression (e.g., {{$json.Id}}).
Options A collection of optional query parameters to refine the list of agents:
- Top: Show only the first n items.
- Skip: Skip the first n items.
- Search: Search items by search phrases.
- 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 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 agents associated with the specified queue. The structure typically includes an array of agent objects, each containing properties such as agent identifiers, names, states, and other relevant metadata depending on the selected fields.

If binary data were involved (not indicated here), it would represent attachments or media related to agents, but this node focuses on JSON data output.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters.

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 and agent data.
  • Query Parameter Issues: Incorrectly formatted filter, search, or orderby strings may cause API errors. Use correct OData syntax and verify expressions.
  • Empty Results: Could indicate no agents assigned to the queue or filters excluding all entries. Adjust options accordingly.

Links and References

Discussion