v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Call Center/Callqueues

Update Call Queue in Domain

put/domains/{domain}/callqueues/{callqueue}

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
callqueuestring required

When used in path the callqueue value will link to a extension id for a preconfigured callqueue. If using agent actions like "login" you can use "all" to change action for all of the queues the agent is in currently, it can not be used for agent update requests.

Example:2000

Request body

descriptionstring

This is a simple description of the callqueue which can be used to better explain the use or purpose of this call queue.

callqueue-dispatch-type'Round-robin' | 'Tiered Round-robin' | 'Ring All' | 'Linear Cascade' | 'Linear Hunt' | 'Call Park'

This is the main dispatch type for hunting agents. The options are described below. #Round-robin #Tiered Round-robin #Ring All #Linear Cascade #Linear Hunt #Call Park

callqueue-calculate-statistics'yes' | 'no'
active-queued-calls-total-currentinteger

This is the current calls waiting in the call queue waiting to be dispatched.

callqueue-agent-dispatch-timeout-secondsinteger

This is the timeout in seconds the call queue will attempt an agent before timing out and retrying additional resources.

callqueue-count-agents-availableinteger

This is the current number of agents logged in and available for work.

callqueue-count-agents-totalinteger

This is the current number of agents configured for this callqueue.

callqueue-debug'yes' | 'no'
callqueue-force-full-intro-playback'yes' | 'no'
callqueue-max-callback-queueing-hoursinteger

This setting will allow callback's in the callqueue allowing callers to press a buton and opt for a callback instead of waiting. 0 the default is off, any other positive number will enable callback and allow callback up to that many hours after the callback is requested.

callqueue-max-current-callers-to-accept-new-callersinteger

This setting is the maximum number of callers allowed in the queue before forward busy answer rules will be followed. 0 is unlimited

callqueue-max-current-wait-to-accept-new-callers-secondsinteger

This setting is the maximum expected wait time allowed in the queue before forward busy answer rules will be followed. 0 is unlimited

callqueue-max-wait-timeout-minutesinteger

This is the max wait time in minutes that it would allow a call to wait before being forced out of the queue. 0 is unlimited

callqueue-require-available-agents-to-accept-new-callers'yes' | 'no'
callqueue-source-matchstring nullable

This is a optional setting that will control the source match for the forward dispatch leg of calls allowing if needed different matches to connecting devices when calls come through the queue.

callqueue-sms-enable'yes' | 'no'
recording-configuration'yes' | 'yes-with-transcription' | 'yes-with-transcription-and-sentiment' | 'no'

Option whether to record calls or not. Available options are "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", or "no"

callqueue-sms-phrase-initiate-chatstring nullable

This is the keyword that will be the trigger for a new SMS queueing session

callqueue-sms-phrase-initiate-successstring nullable

The message to auto reply to a inbound SMS message once the trigger keyword is detected

callqueue-sms-phrase-initiation-fail string nullable

The message that will be auto replied when a message wihtout the keywork is detected.

callqueue-sms-phrase-no-agents-availablestring nullable

The message that will be auto replied when there are no agents available and the system is unable to setup a sms chat session at this time.

callqueue-sms-phrase-terminate-chatstring nullable

This is the keyword that will be the trigger to end a active SMS session.

callqueue-sms-phrase-terminate-successstring nullable

The message that will be played after a successfully termination of a session via a keyword.

callqueue-agent-auto-logout-after-missed'yes' | 'no'
callqueue-sim-ring-1st-roundinteger

When using a callqueue-dispatch-type value that allows for mutlple agents to be run on at a time this setting controls the amount of agents that are dispatched in the first round.

callqueue-sim-ring-incrementinteger

When using a callqueue-dispatch-type value that allows for mutlple agents to be run on at a time this setting controls the amount of agents that will be added to the group activly ringing at each agent timeout level.

Response

codeinteger required
messagestring required