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 list members of a group. It is useful in scenarios where you need to retrieve and manage group membership information within 3CX, such as for call routing, monitoring team availability, or automating communication workflows.

For example, you might use this node to:

  • Fetch all members of a specific group to display their status.
  • Filter or search group members based on certain criteria.
  • Paginate through large groups by skipping or limiting results.

Properties

Name Meaning
Id The unique identifier of the group whose members you want to list. Can be set via expression.
Options Collection of optional query parameters to refine the list:
- Top ($top) Limit the number of returned items to the first n entries.
- Skip ($skip) Skip the first n items in the result set (useful for pagination).
- Search ($search) Search group members by phrases; supports quoted phrases for exact matches.
- Filter ($filter) Filter members by property values, e.g., "State eq 'Connected'".
- Count ($count) Include the total count of items in the response (boolean).
- Orderby ($orderby) Order the results by specified properties, e.g., "Name desc, CreatedAt asc".
- Select ($select) Select specific properties to be returned, e.g., "Id,Name".
- Expand ($expand) Expand related entities to include additional linked data.

Output

The node outputs JSON data containing the list of group members retrieved from the 3CX API. The structure typically includes member details such as identifiers, names, states, and any other selected or expanded properties based on the options used.

If binary data were involved (e.g., audio recordings), it would be included in a separate binary output field, but this operation focuses on JSON data only.

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 provided in the node's credential settings.

Troubleshooting

  • Invalid Group Id: If the provided group Id does not exist or is incorrect, the API will return an error. Verify the Id value and ensure it corresponds to an existing group.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the OAuth2 credentials are correctly set up and authorized.
  • Query Parameter Issues: Incorrectly formatted filter, search, or orderby strings may lead to API errors. Validate syntax according to OData query standards.
  • Empty Results: If no members are returned, check if the group actually has members or if filters/search terms are too restrictive.

Links and References

Discussion