3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

The node provides integration with the 3CX telephony system, specifically allowing users to update parking entities within 3CX. This operation is useful for managing parking lot configurations programmatically, such as changing parking numbers, updating group permissions, or modifying transcription modes related to parked calls.

Common scenarios include:

  • Automating updates to parking lot settings in a call center environment.
  • Synchronizing parking configurations from an external database or CRM.
  • Adjusting transcription preferences for parked calls based on business rules.

For example, a user might update the parking number and assign specific group rights to control who can access that parking slot, or change the transcription mode to enable voicemail transcriptions.

Properties

Name Meaning
Id The unique identifier of the parking entity to update. Can be set dynamically using expressions.
Groups JSON object defining group rights, individual rights, and tags associated with the parking.
Number The parking number (string) to assign or update.
Transcription Mode Defines how call transcriptions are handled for this parking. Options: Nothing, Voicemail, Recordings, Both, Inherit.

Output

The node outputs JSON data representing the updated parking entity as returned by the 3CX API. This typically includes the parking's current configuration after the update, such as its ID, number, groups, and transcription mode.

If the node supports binary data output, it would relate to any media or recordings associated with the parking, but based on the provided code and properties, the output is purely JSON.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials for 3CX.
  • The base URL for the 3CX server must be specified in the node credentials.
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Invalid Id: If the provided parking Id does not exist, the API will likely return an error. Ensure the Id is correct and accessible.
  • Malformed Groups JSON: The Groups property expects valid JSON. Invalid JSON syntax will cause request failures.
  • Authentication Errors: Missing or invalid API credentials will prevent successful communication with 3CX.
  • Transcription Mode Value: Using an unsupported transcription mode value may result in errors; use one of the predefined options.
  • Server URL Issues: Ensure the server URL in credentials is correctly formatted without trailing slashes to avoid malformed requests.

Links and References

Discussion