3CX icon

3CX

Interact with 3CX telephony system

Actions462

Peers → Retreive Peers By Numbers

AI-generated

Overview

This node interacts with the 3CX telephony system, specifically allowing users to retrieve information about peers by their numbers. It is useful in scenarios where you need to query details of specific telephony peers (extensions or devices) within a 3CX system based on their direct number identifiers. For example, a user might want to fetch status or configuration details of certain extensions programmatically.

Properties

Name Meaning
Peers Request JSON object containing an array DnNumbers with the list of direct numbers to retrieve peers for. Example: { "DnNumbers": [1234, 5678] }

Output

The node outputs JSON data representing the peers corresponding to the requested direct numbers. The exact structure depends on the 3CX API response but typically includes peer details such as extension number, status, and other relevant telephony information.

If the node supports binary data output, it would be related to any media or files associated with peers, but this is not indicated in the provided code.

Dependencies

  • Requires an API key credential for authenticating with the 3CX system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.
  • The request headers specify Accept: application/json.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect or unreachable 3CX server URL will result in connection errors.
    • Malformed JSON in the Peers Request property can cause request parsing errors.
    • Requesting non-existent direct numbers may return empty results or errors from the API.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Network errors suggest checking the server URL and network connectivity.
    • JSON parsing errors require validating the input JSON format in the Peers Request field.

Links and References

Discussion