3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically allowing users to update codec settings. This operation is useful for administrators or integrators who need to configure or modify the codec preferences used by the 3CX system, which can affect call quality and compatibility with different devices or networks.

Practical examples include:

  • Updating the list of external codecs to prioritize certain audio formats for calls going outside the local network.
  • Adjusting the local codec list to optimize internal call quality or bandwidth usage.

Properties

Name Meaning
External Codec List A JSON array specifying the list of external codecs to be used or updated in the system.
Local Codec List A JSON array specifying the list of local codecs to be used or updated in the system.

Both properties expect JSON input representing codec configurations. The node parses these JSON strings into objects before sending them in the request body.

Output

The node outputs data in JSON format reflecting the response from the 3CX API after updating the codec settings. This typically includes confirmation of the update or details about the current codec configuration.

No binary data output is indicated.

Dependencies

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

Troubleshooting

  • Invalid JSON Input: If the JSON provided for codec lists is malformed, the node will fail to parse it. Ensure valid JSON syntax.
  • Authentication Errors: Incorrect or missing API credentials will cause authentication failures. Verify that the API key and server URL are correctly set.
  • API Endpoint Issues: If the server URL is incorrect or unreachable, the node cannot update settings. Confirm network connectivity and correct URL.
  • Empty Codec Lists: Providing empty or null codec lists might result in unexpected behavior or errors from the API. Always provide valid codec arrays.

Links and References

Discussion