3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

This node integrates with the 3CX telephony system, allowing users to interact programmatically with various aspects of their 3CX environment. Specifically, the "Get My Group Partner Info" operation under the "My Group" resource retrieves information about a partner associated with a reseller group. This can be useful for administrators or partners managing multiple reseller accounts who need to fetch detailed partner data quickly.

Practical examples include:

  • Fetching partner details for reporting or auditing purposes.
  • Automating workflows that require partner information based on reseller IDs.
  • Integrating 3CX partner data into CRM or other business systems.

Properties

Name Meaning
Reseller Id The unique identifier of the reseller whose partner info you want to retrieve. Usage format: resellerId={resellerId}

Output

The node outputs JSON data containing the partner information related to the specified reseller ID. The exact structure depends on the 3CX API response but typically includes fields such as partner name, contact details, status, and other relevant metadata.

If the node supports binary data output (not indicated in the provided code), it would represent any files or media returned by the API, but this is not evident here.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials to connect securely to the 3CX server.
  • The base URL for the 3CX API must be set in the node credentials configuration.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX server.

Troubleshooting

  • Missing or invalid Reseller Id: Ensure the Reseller Id property is provided and correctly formatted; otherwise, the API call will fail.
  • Authentication errors: Verify that the OAuth2 credentials are valid and have sufficient permissions to access partner information.
  • Network or server issues: Check connectivity to the 3CX server URL and ensure the server is reachable.
  • Unexpected API responses: If the output JSON does not contain expected fields, confirm that the reseller ID exists and that the user has rights to access its partner info.

Links and References

Discussion