3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, allowing users to interact programmatically with its API. Specifically, the "Get Directory Info" operation under the "Directories" resource fetches detailed information about a directory within the 3CX system. This can be useful for scenarios such as retrieving contact lists, organizational structures, or user details stored in 3CX directories.

Practical examples include:

  • Automatically syncing 3CX directory contacts with other CRM or communication tools.
  • Fetching directory data to display or process in workflows that manage call routing or user notifications.
  • Auditing or reporting on directory contents within automated business processes.

Properties

Name Meaning
Parameters A JSON object containing parameters to customize the request for directory information.

The "Parameters" property expects a JSON input that is parsed and sent as the body of the API request. Users can specify any valid parameters supported by the 3CX API for fetching directory info.

Output

The node outputs JSON data representing the directory information retrieved from the 3CX system. The structure of this JSON depends on the 3CX API response but typically includes details such as directory entries, user information, and metadata related to the directory.

If the node supports binary data output (not evident from the provided code), it would represent files or media associated with directory entries, but no such indication is present here.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials to access the 3CX API.
  • Needs the base URL of the 3CX server, which must be set in the node's credentials configuration.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid JSON in the "Parameters" field may lead to parsing errors or malformed requests.
    • Network connectivity problems or incorrect server URL configurations can prevent successful API calls.

  • Error messages:

    • Authentication errors typically indicate invalid or expired tokens; re-authenticate or update credentials.
    • JSON parsing errors suggest malformed input in the "Parameters" property; ensure valid JSON syntax.
    • HTTP errors from the API (e.g., 404, 500) may indicate incorrect endpoints or server-side issues; verify the server URL and API availability.

Links and References

Discussion