3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically allowing users to update a Service Principal entity within 3CX. A Service Principal typically represents an application or service identity that can be granted permissions and configured for call control, transcription, and other telephony-related features.

Common scenarios include:

  • Modifying the settings of a service principal to enable or disable call control.
  • Updating group memberships and rights associated with a service principal.
  • Configuring transcription modes for calls handled by the service principal.
  • Adjusting peer relationships and tags for organizational or permission purposes.

Practical example:
A user wants to update a service principal to enable call control and set transcription mode to record both voicemails and recordings, while also updating its group rights and peers.

Properties

Name Meaning
Id The unique identifier of the Service Principal to update. Can be provided via expression.
Call Control Enabled Boolean flag to enable or disable call control functionality for the service principal.
Groups JSON array defining groups associated with the service principal, including group rights, rights, and tags.
Last Used String representing the last usage timestamp or related metadata for the service principal.
Number String representing a phone number or identifier linked to the service principal.
Peers JSON array describing peer entities related to the service principal, including membership and tags.
Transcription Mode Option to set transcription behavior; possible values are: Nothing, Voicemail, Recordings, Both, Inherit.
XAPI Enabled Boolean flag to enable or disable XAPI (likely an API or protocol feature) for the service principal.

Output

The node outputs JSON data representing the updated state or response from the 3CX API after modifying the specified Service Principal. This typically includes confirmation of changes or the updated entity details.

If binary data is returned by the API (not indicated in the source), it would represent files or media related to the service principal, but this is not evident here.

Dependencies

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

Troubleshooting

  • Invalid or missing Id: Ensure the Id property is correctly set and corresponds to an existing Service Principal.
  • Authentication errors: Verify that the OAuth2 credentials are valid and have sufficient permissions.
  • Malformed JSON in Groups or Peers: When providing JSON arrays for these properties, ensure they are well-formed and parseable.
  • Unsupported transcription mode: Use only the predefined options for transcription mode.
  • Network or server errors: Check connectivity to the 3CX server and confirm the base URL is correct without trailing slashes.

Links and References

Discussion