3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Create Queue" operation in the Queues resource allows users to create a new call queue within the 3CX telephony system. This node is useful for setting up and managing call distribution groups where incoming calls are routed to agents based on various strategies and configurations. It supports detailed customization of queue behavior, including agent availability, routing rules, announcements, call handling options, and more.

Typical use cases include:

  • Setting up customer support queues with specific agent groups.
  • Configuring call routing during holidays or out-of-office hours.
  • Managing call recording and transcription settings per queue.
  • Defining how callers are announced their position in the queue.
  • Controlling chat and callback features associated with the queue.

Properties

Name Meaning
Agent Availability Mode Boolean flag to enable or disable agent availability mode.
Agents JSON array defining the agents assigned to the queue.
Announcement Interval Number specifying the interval (in seconds) between announcement prompts to callers in the queue.
Announce Queue Position Boolean indicating whether to announce the caller's position in the queue.
Break Route JSON object defining routing rules when an agent is on break.
Callback Enable Time Number representing the time (in seconds) after which callbacks are enabled.
Callback Prefix String prefix used for callback numbers.
Call Us Enable Chat Boolean to enable chat functionality for the queue.
Call Us Enable Phone Boolean to enable phone call functionality for the queue.
Call Us Enable Video Boolean to enable video call functionality for the queue.
Call Us Requirement Option to specify required caller information: Both name and email, only name, only email, or none. Options: Both, Name, Email, None.
Click To Call Id String identifier for click-to-call feature.
Enable Intro Boolean to enable introductory message playback.
Forward No Answer JSON object defining routing rules if no answer is received.
Greeting File String specifying the file path or identifier for the greeting audio file.
Groups JSON array defining groups with rights and tags associated with the queue.
Holidays Route JSON object defining routing rules during holidays.
Id Numeric identifier for the queue.
Intro File String specifying the file path or identifier for the intro audio file.
Is Registered Boolean indicating if the queue is registered.
Managers JSON array defining managers assigned to the queue.
Master Timeout Number specifying the master timeout duration (seconds).
Max Callers In Queue Number defining the maximum number of callers allowed in the queue.
Name String name of the queue.
Notify Codes JSON array of notification codes related to the queue.
Number String representing the queue's phone number.
On Hold File String specifying the file path or identifier for the on-hold audio file.
Out Of Office Route JSON object defining routing rules when out of office.
Play Full Prompt Boolean indicating whether to play the full prompt to callers.
Polling Strategy Option defining the strategy to distribute calls among agents. Options include Hunt, Ring All, Hunt Random Start, Next Agent, Longest Waiting, Least Talk Time, Fewest Answered, Hunt By 3 S, First 3 Available, Skill Based Routing variants.
Priority Queue Boolean indicating if the queue is a priority queue.
Prompt Set String specifying the prompt set to use.
Recording Option for call recording settings: Disabled, Allow To Opt Out, Ask To Opt In.
Reset Queue Statistics Schedule JSON object defining schedule for resetting queue statistics.
Reset Statistics Schedule Enabled Boolean to enable or disable resetting statistics schedule.
Ring Timeout Number specifying the ring timeout duration (seconds).
SLA Time Number defining the Service Level Agreement time (seconds).
Transcription Mode Option for transcription settings: Nothing, Voicemail, Recordings, Both, Inherit.
Type Of Chat Ownership Type Option defining chat ownership type: Take Manually or Auto Assign.
Wrap Up Time Number specifying wrap-up time duration (seconds) after a call ends.

Output

The node outputs JSON data representing the response from the 3CX API after creating the queue. This typically includes details about the newly created queue such as its ID, configuration, status, and any metadata returned by the API.

If the node supports binary data output (not explicitly shown here), it would relate to files such as audio greetings or recordings associated with the queue.

Dependencies

  • Requires an active connection to a 3CX telephony system via an API endpoint.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests.
  • The base URL for the 3CX server must be provided in the credentials.
  • The node sends HTTP requests with JSON payloads to the 3CX API.

Troubleshooting

  • Invalid JSON in properties like Agents, Groups, or Routes: Ensure that JSON inputs are correctly formatted; invalid JSON will cause request failures.
  • Authentication errors: Verify that the API key or OAuth2 credentials are valid and have sufficient permissions.
  • Missing required fields: Some properties like Name or Number might be mandatory; omitting them could result in errors.
  • API endpoint unreachable: Check network connectivity and correct server URL configuration.
  • Unsupported polling strategy or option values: Use only the predefined options listed in the properties.
  • Error messages from 3CX API: Review the error details returned in the node output to identify misconfigurations or permission issues.

Links and References

Discussion