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 the rights associated with a particular group entity. It is useful in scenarios where you need to retrieve and manage permissions or access rights assigned to groups within the 3CX system. For example, an administrator might use this node to audit group permissions or dynamically adjust workflows based on group rights.

Properties

Name Meaning
Id The unique identifier of the group entity whose rights are to be listed. Can be set via expression.
Options A collection of optional query parameters to refine the listing:
- Top ($top) Limits the number of items returned to the first n entries.
- Skip ($skip) Skips the first n items in the result set.
- Search ($search) Searches items by phrases; supports quoted phrases for exact matches.
- Filter ($filter) Filters items by property values using OData syntax (e.g., State eq 'Connected').
- Count ($count) Includes the count of items in the response when set to 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 inline in the response (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the list of rights associated with the specified group. The structure typically includes an array of rights objects, each describing a particular permission or access right granted to the group. If the $count option is enabled, the output will also include the total count of matching rights.

No binary data output is expected from this operation.

Dependencies

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

Troubleshooting

  • Missing or invalid group Id: Ensure that the Id property is provided and correctly references an existing group entity.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Invalid query options: When using filter, search, or orderby options, ensure the syntax follows OData conventions supported by the 3CX API.
  • Empty results: Confirm that the group has rights assigned or adjust query options like filters and search terms.
  • Network issues: Check connectivity to the 3CX server URL configured in credentials.

Links and References

Discussion