3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system to create a new receptionist configuration. It allows users to define detailed routing and forwarding rules, IVR types, prompts, and other settings for a receptionist within the 3CX environment. This is useful in scenarios where businesses want to automate call handling by setting up virtual receptionists that manage incoming calls based on specific rules.

Practical examples include:

  • Setting up a receptionist that forwards calls to different groups or extensions depending on time of day or holidays.
  • Configuring voicemail transcription modes and custom prompts for callers.
  • Defining fallback routes when calls are not answered or invalid keys are pressed during IVR interactions.

Properties

Name Meaning
Break Route JSON object defining the routing behavior when a break occurs; includes tags to specify routing conditions.
Forwards JSON array specifying forwarding rules for calls handled by the receptionist.
Forward Sms To Phone number string to which SMS messages should be forwarded.
Groups JSON array defining groups associated with the receptionist, including group rights, individual rights, and tags.
Holidays Route JSON object defining routing rules to apply during holidays; includes tags for routing conditions.
Id Numeric identifier for the receptionist.
Invalid Key Forward DN String phone number to forward calls to if an invalid key is pressed during IVR interaction.
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 String name of the receptionist.
Number String representing the receptionist's phone number or extension.
Out Of Office Route JSON object defining routing rules to apply when out of office; includes tags for routing conditions.
Prompt Filename String filename of the audio prompt to play to callers.
Prompt Set String identifier for a set of prompts to use.
Timeout Number specifying the timeout duration (likely in seconds) before forwarding or other action occurs.
Timeout Forward DN String phone number to forward calls to after timeout expires.
Timeout Forward Peer Type Option specifying the type of entity to forward to after timeout: None, Extension, Queue, Ring Group, IVR, Fax, Conference, Special Menu, Parking, External Line, Group, or 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, or Custom Input.
Transcription Mode Option controlling transcription behavior: Nothing, Voicemail, Recordings, Both, or Inherit from system defaults.
Use MS Exchange Boolean indicating whether to integrate/use Microsoft Exchange services (e.g., for calendar or voicemail integration).

Output

The node outputs JSON data representing the created receptionist object as returned by the 3CX API. This typically includes all configured properties such as routing rules, forwarding settings, IVR type, prompts, and identifiers confirming successful creation.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential to connect securely to the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node sends HTTP requests with JSON payloads to the 3CX API endpoints.

Troubleshooting

  • Invalid JSON input: Many properties expect JSON strings that are parsed before sending. Malformed JSON will cause errors. Ensure JSON inputs are valid.
  • Authentication errors: If the API key or OAuth2 token is missing or invalid, the node will fail to authenticate. Verify credentials are correctly set.
  • Incorrect routing or forwarding values: Providing unsupported or incomplete routing objects may result in API errors. Consult 3CX API documentation for correct structure.
  • Timeout or network issues: Network connectivity problems to the 3CX server can cause request failures. Check server URL and network access.
  • Missing required fields: Some fields like Name or Number might be mandatory. Omitting them could cause errors.

Links and References

Discussion