v1
latestOpenAPI 3.1.02026-07-24317911.4 MBCreate Call Queue in Domain
Path parameters
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.
Request body
When synchronous is requested with "yes" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 "Accepted" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response.
This is the main call queue extension which is the identifier for this call quieue.
This is a simple description of the callqueue which can be used to better explain the use or purpose of this call queue.
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
This is the current calls waiting in the call queue waiting to be dispatched.
This is the timeout in seconds the call queue will attempt an agent before timing out and retrying additional resources.
This is the current number of agents logged in and available for work.
This is the current number of agents configured for this callqueue.
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.
This setting is the maximum number of callers allowed in the queue before forward busy answer rules will be followed. 0 is unlimited
This setting is the maximum expected wait time allowed in the queue before forward busy answer rules will be followed. 0 is unlimited
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
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.
Option whether to record calls or not. Available options are "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", or "no"
This is the keyword that will be the trigger for a new SMS queueing session
The message to auto reply to a inbound SMS message once the trigger keyword is detected
The message that will be auto replied when a message wihtout the keywork is detected.
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.
This is the keyword that will be the trigger to end a active SMS session.
The message that will be played after a successfully termination of a session via a keyword.
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.
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.