Create Call Queue in Domain

POST

/domains/{domain}/callqueues

Last modified:2023-12-21 20:51:58

OperationId:CreateCallqueue

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

domain

string

required

Example:

Body Params application/json

synchronous

enum<string>

write-onlyrequired

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.

Allowed values:

yesno

Default:

callqueue

string

required

This is the main call queue extension which is the identifier for this call quieue.

description

string

optional

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

enum<string>

optional

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

Allowed values:

Round-robinTiered Round-robinRing AllLinear CascadeLinear HuntCall Park

callqueue-calculate-statistics

enum<string>

optional

Enabled will allow stats to be calculated.

Allowed values:

yesno

callqueue-agent-dispatch-timeout-seconds

integer

optional

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

callqueue-count-agents-total

integer

optional

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

callqueue-debug

enum<string>

optional

Enable debug only when wanting more detailed trace to troublehsoot dispatching issues with agent. Will enable per agent status logging at the time of dispatch showing in more detail why agents were and were not selected.

Allowed values:

yesno

callqueue-force-full-intro-playback

enum<string>

optional

Enable to force the first MOH file to be played completly before attempting to dispatch the caller. This allows for a message to be played in full if needed.

Allowed values:

yesno

callqueue-max-callback-queueing-hours

integer

optional

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.

>= 0<= 6

Default:

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

integer

optional

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

>= 0

Default:

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

integer

optional

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

>= 0

Default:

callqueue-max-wait-timeout-minutes

integer

optional

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

>= 0

Default:

callqueue-require-available-agents-to-accept-new-callers

enum<string>

optional

When enabled this setting will require at least 1 agent to be in a logged in status in order to start queuing the call, if no agents are logged in then the call will be forwarded to answer rules.

Allowed values:

yesno

Default:

callqueue-source-match

string | null

optional

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

enum<string>

optional

When enabled this setting will open up SMS queue options for the queue including support for the features/fields below.

Allowed values:

yesno

Default:

recording-configuration

enum<string>

optional

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

Allowed values:

yesyes-with-transcriptionyes-with-transcription-and-sentimentno

Default:

callqueue-sms-phrase-initiate-chat

string | null

optional

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

callqueue-sms-phrase-initiate-success

string | null

optional

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

callqueue-sms-phrase-initiation-fail

string | null

optional

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

callqueue-sms-phrase-no-agents-available

string | null

optional

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-chat

string | null

optional

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

callqueue-sms-phrase-terminate-success

string | null

optional

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

callqueue-agent-auto-logout-after-missed

enum<string>

optional

When enabled this setting will trigger the core switch to logout the agent from the queue if they miss a call dispatched to them.

Allowed values:

yesno

Default:

callqueue-sim-ring-1st-round

integer

optional

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.

>= 0<= 99

Default:

callqueue-sim-ring-increment

integer

optional

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.

>= 0<= 99

Default:

Example

{
  "callqueue": "2032",
  "description": "Sales Queue",
  "callqueue-dispatch-type": "RingAll",
  "callqueue-debug": "yes",
  "callqueue-calculate-statistics": "yes",
  "callqueue-source-match": "<Queue>",
  "callqueue-force-full-intro-playback": "yes",
  "callqueue-max-callback-queueing-hours": "2"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/{{domain}}/callqueues' \
--header 'Content-Type: application/json' \
--data-raw '{
    "callqueue": "2032",
    "description": "Sales Queue",
    "callqueue-dispatch-type": "RingAll",
    "callqueue-debug": "yes",
    "callqueue-calculate-statistics": "yes",
    "callqueue-source-match": "<Queue>",
    "callqueue-force-full-intro-playback": "yes",
    "callqueue-max-callback-queueing-hours": "2"
}'

Responses

🟢202Accepted

text/html

Body

array of:

callqueue

string

required

This is the main call queue extension which is the identifier for this call quieue.

domain

string

required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

<= 64 characters

Examples:

example.commyDomaintest.12123

Match pattern:

^[A-Za-z0-9._-]+|\*

description

string

optional

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

enum<string>

optional

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

Allowed values:

Round-robinTiered Round-robinRing AllLinear CascadeLinear HuntCall Park

callqueue-calculate-statistics

enum<string>

optional

Enabled will allow stats to be calculated.

Allowed values:

yesno

active-queued-calls-total-current

integer

read-onlyoptional

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

callqueue-agent-dispatch-timeout-seconds

integer

optional

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

callqueue-count-agents-available

integer

read-onlyoptional

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

callqueue-count-agents-total

integer

optional

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

callqueue-debug

enum<string>

optional

Allowed values:

yesno

callqueue-force-full-intro-playback

enum<string>

optional

Enable to force the first MOH file to be played completly before attempting to dispatch the caller. This allows for a message to be played in full if needed.

Allowed values:

yesno

callqueue-max-callback-queueing-hours

integer

optional

>= 0<= 6

Default:

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

integer

optional

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

>= 0

Default:

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

integer

optional

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

>= 0

Default:

callqueue-max-wait-timeout-minutes

integer

optional

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

>= 0

Default:

callqueue-require-available-agents-to-accept-new-callers

enum<string>

optional

When enabled this setting will require at least 1 agent to be in a logged in status in order to start queuing the call, if no agents are logged in then the call will be forwarded to answer rules.

Allowed values:

yesno

Default:

callqueue-source-match

string | null

optional

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

enum<string>

optional

When enabled this setting will open up SMS queue options for the queue including support for the features/fields below.

Allowed values:

yesno

Default:

recording-configuration

enum<string>

optional

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

Allowed values:

yesyes-with-transcriptionyes-with-transcription-and-sentimentno

Default:

callqueue-sms-phrase-initiate-chat

string | null

optional

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

callqueue-sms-phrase-initiate-success

string | null

optional

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

callqueue-sms-phrase-initiation-fail

string | null

optional

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

callqueue-sms-phrase-no-agents-available

string | null

optional

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-chat

string | null

optional

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

callqueue-sms-phrase-terminate-success

string | null

optional

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

callqueue-agent-auto-logout-after-missed

enum<string>

optional

When enabled this setting will trigger the core switch to logout the agent from the queue if they miss a call dispatched to them.

Allowed values:

yesno

Default:

callqueue-sim-ring-1st-round

integer

optional

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.

>= 0<= 99

Default:

callqueue-sim-ring-increment

integer

optional

>= 0<= 99

Default:

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Modified at 2023-12-21 20:51:58

Read Call Queues in Domain

Update Call Queue in Domain