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 receptionist entities within that system. It is useful for automating updates to receptionist configurations such as call routing, forwarding rules, IVR settings, and other telephony-related parameters. Practical scenarios include dynamically changing receptionist behavior based on business hours, updating forwarding numbers during holidays, or modifying IVR prompts without manual intervention in the 3CX management console.

Properties

Name Meaning
Id The unique identifier of the receptionist entity to update. Can be set via expression like {{$json.Id}}.
Break Route JSON object defining the call routing behavior during breaks, including tags for routing logic.
Forwards JSON array specifying forwarding rules for calls received by the receptionist.
Forward Sms To Phone number or identifier to which SMS messages should be forwarded.
Groups JSON array defining group memberships and associated rights and tags for the receptionist.
Holidays Route JSON object defining call routing behavior during holidays, including tags.
Invalid Key Forward DN String specifying the destination number when an invalid key is pressed.
Is Registered Boolean indicating whether the receptionist is currently registered/active.
IVR Type Option selecting the type of IVR used: Default, Code Based, Script Based, or Wakeup.
Name The name assigned to the receptionist entity.
Number The phone number associated with the receptionist.
Out Of Office Route JSON object defining call routing behavior when out of office, including tags.
Prompt Filename Filename of the audio prompt used by the receptionist.
Prompt Set Identifier for the set of prompts used.
Timeout Numeric value specifying timeout duration (likely in seconds) before forwarding or other action.
Timeout Forward DN Destination number to forward calls to after timeout expires.
Timeout Forward Peer Type Option specifying the type of peer to forward to after timeout: None, Extension, Queue, Ring Group, IVR, Fax, Conference, Special Menu, Parking, External Line, Group, Route Point.
Timeout Forward Type Option specifying the forwarding action after timeout: End Call, Extension, Ring Group, Queue, IVR, Voice Mail, Call By Name, Repeat Prompt, Custom Input.
Transcription Mode Option controlling transcription behavior: Nothing, Voicemail, Recordings, Both, Inherit.
Use MS Exchange Boolean indicating whether to integrate/use Microsoft Exchange services.

Output

The node outputs JSON data representing the updated receptionist entity as returned by the 3CX API. This typically includes confirmation of the updated fields and possibly the full current state of the receptionist configuration. There is no indication of binary data output.

Dependencies

  • Requires an API authentication token credential for 3CX OAuth2.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate headers.
  • No other external dependencies are indicated.

Troubleshooting

  • Common issues:

    • Incorrect or missing receptionist Id will cause update failures.
    • Malformed JSON input for properties like Break Route, Forwards, Groups, etc., may cause parsing errors.
    • Invalid or expired API credentials will result in authentication errors.
    • Providing unsupported values for options like IVR Type or Timeout Forward Type may cause API rejections.

  • Error messages:

    • Authentication errors: Check API credentials and ensure they have not expired.
    • Validation errors from 3CX API: Verify all required fields are provided and JSON structures are valid.
    • Network errors: Confirm connectivity to the 3CX server URL and correct base path.

Links and References

Discussion