3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically enabling the creation of Service Principals within that system. A Service Principal typically represents an application or service identity used for authentication and authorization in enterprise environments. This node is useful when automating the management of service identities, such as provisioning new service principals with specific permissions and settings in 3CX.

Practical scenarios include:

  • Automating the onboarding of new applications or services that need to interact with the 3CX system.
  • Managing telephony-related permissions and configurations programmatically.
  • Integrating 3CX service principal creation into broader IT workflows or CI/CD pipelines.

Properties

Name Meaning
Call Control Enabled Boolean flag indicating if call control features are enabled for the service principal.
Groups JSON array defining groups associated with the service principal, including rights and tags.
Id Numeric identifier for the service principal.
Last Used String representing the last usage timestamp or status of the service principal.
Number String representing a phone number or identifier linked to the service principal.
Peers JSON array describing peer relationships, including membership and tags related to the service principal.
Transcription Mode Option to set transcription behavior; possible values: Nothing, Voicemail, Recordings, Both, Inherit.
XAPI Enabled Boolean flag indicating if the XAPI (3CX API) is enabled for this service principal.

Output

The node outputs JSON data representing the created service principal object as returned by the 3CX API. This includes all properties sent during creation along with any additional metadata or identifiers assigned by the system.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects a base URL for the 3CX server configured in credentials.
  • The node uses the 3CX REST API endpoint /xapi/v1 for requests.

Troubleshooting

  • Invalid Credentials: If authentication fails, verify the API key or OAuth2 token and ensure the 3CX server URL is correct.
  • Malformed JSON in Groups or Peers: Since these fields expect JSON input, invalid JSON syntax will cause errors. Validate JSON formatting before submission.
  • Unsupported Transcription Mode: Ensure the transcription mode value matches one of the allowed options.
  • Missing Required Fields: Some fields like Id or Number might be required by the API; omitting them could result in errors.
  • Network Issues: Connectivity problems to the 3CX server will prevent successful requests.

Links and References

Discussion