3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to list members of a Ring Group. It retrieves detailed information about the members belonging to a specified Ring Group entity by its ID. This is useful in scenarios where you want to automate or monitor call group configurations, manage telephony workflows, or integrate call routing data into other systems.

For example, you might use this node to:

  • Fetch all members of a particular Ring Group to display or process their statuses.
  • Automate updates or notifications based on the composition of Ring Groups.
  • Integrate Ring Group member data into CRM or helpdesk tools for enhanced call handling.

Properties

Name Meaning
Id The unique identifier of the Ring Group entity whose members you want to list.
Options A collection of optional query parameters to refine the results:
- 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 items by phrases; supports quoted phrases for exact matches.
- Filter ($filter) Filter items by property values using expressions (e.g., State eq 'Connected').
- Count ($count) Include the count of total items matching the query.
- Orderby ($orderby) Order items by specified property values (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 (e.g., RelatedEntity1).

Output

The node outputs JSON data representing the list of Ring Group members retrieved from the 3CX API. Each item in the output array corresponds to a member entity with properties as requested or defaulted by the $select option.

If binary data were involved (not indicated here), it would typically represent media files or attachments related to the members, but this node focuses on JSON data only.

Dependencies

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

Troubleshooting

  • Invalid or missing Id: Ensure the Id property is provided and corresponds to an existing Ring Group entity.
  • Authentication errors: Verify that the API key or OAuth2 token is valid and has sufficient permissions.
  • Query parameter issues: Incorrect syntax in filter, search, or orderby options can cause API errors. Use correct OData-like syntax.
  • Empty results: Could indicate no members exist for the given Ring Group or filters are too restrictive.
  • Network or server errors: Check connectivity to the 3CX server and ensure the base URL is correctly configured.

Links and References

Discussion