3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing an operation to retrieve the phone registrar information for a user identified by their MAC address. It is useful in scenarios where you need to query the registration status or details of a specific phone device within the 3CX system, such as during troubleshooting, monitoring, or inventory management of telephony devices.

For example, a user can input the MAC address of a phone to get its current registrar details, which helps administrators verify if the device is properly registered and functioning within the telephony environment.

Properties

Name Meaning
Mac The MAC address of the phone device to query. Usage format: mac={mac}. This is a required string input that identifies the target phone for which the registrar information will be retrieved.

Output

The node outputs JSON data containing the phone registrar information associated with the provided MAC address. This typically includes details about the registration status, registrar server, and possibly other metadata related to the phone's connection within the 3CX system.

If the node supports binary data output (not indicated in the provided code), it would represent any binary content returned by the API, but based on the static analysis, the output is primarily JSON structured data.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials to authorize requests.
  • The base URL for the 3CX API must be set in the node credentials configuration.
  • The node sends HTTP requests with JSON headers to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Invalid or missing MAC address input will cause the request to fail or return no data.
    • Incorrect or expired API authentication token will result in authorization errors.
    • Misconfigured base URL or network connectivity issues may prevent successful communication with the 3CX server.

  • Error messages:

    • Authorization errors typically indicate problems with the OAuth2 credential setup; re-authenticate or update credentials.
    • "Not Found" or empty responses may mean the MAC address does not correspond to any registered phone.
    • Network timeouts or connection refused errors suggest checking the server URL and network access.

Links and References

Discussion