3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Get My Group" operation in the "My Group" resource is designed to retrieve information about groups associated with the authenticated user from the 3CX telephony system. This node is useful when you want to programmatically access group details such as group members, settings, or statuses within your telephony environment.

Common scenarios include:

  • Fetching a list of user groups for display or processing.
  • Filtering groups based on specific criteria like name or status.
  • Retrieving detailed information about related entities linked to groups.

For example, you might use this node to get all groups where the current user is a member and then perform actions like sending notifications or generating reports based on group data.

Properties

Name Meaning
Options A collection of optional query parameters to customize the request:
$top Show only the first n items (limit the number of results).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be wrapped in quotes automatically.
$filter Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
$count Include count of items in the response (boolean).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$select Select specific properties to be returned (comma-separated list, e.g., Id,Name).
$expand Expand related entities to include additional linked data (comma-separated list).

These options allow fine-grained control over the data retrieved, enabling efficient queries tailored to your needs.

Output

The node outputs JSON data representing the group(s) information retrieved from the 3CX API. The structure typically includes an array of group objects with properties depending on the $select and $expand options used.

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

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 requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is valid and has sufficient permissions to access group data.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other OData parameters can cause API errors. Validate these strings carefully.
  • Empty responses: If no groups are returned, verify that the authenticated user belongs to any groups and that filters/search terms are correct.
  • Network issues: Confirm that the 3CX server URL is reachable and correctly set in the credentials.

Links and References

Discussion