---
title: "Create Call Queue in Domain"
method: POST
path: "/domains/{domain}/callqueues"
tags: ["Call Center/Callqueues"]
---

# Create Call Queue in Domain

`POST /domains/{domain}/callqueues`

## Path parameters

- `domain` string, 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.

## Request body

- object
  - `synchronous` 'yes' | 'no', required — 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.
  - `callqueue` string, required — This is the main call queue extension which is the identifier for this call quieue.
  - `description` string — 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-current` integer — This is the current calls waiting in the call queue waiting to be dispatched.
  - `callqueue-agent-dispatch-timeout-seconds` integer — 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 — This is the current number of agents logged in and available for work.
  - `callqueue-count-agents-total` integer — 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-hours` integer — 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-callers` integer — 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-seconds` integer — 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-minutes` integer — 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-match` string, 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-chat` string, nullable — This is the keyword that will be the trigger for a new SMS queueing session
  - `callqueue-sms-phrase-initiate-success` string, 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-available` string, 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-chat` string, nullable — This is the keyword that will be the trigger to end a active SMS session.
  - `callqueue-sms-phrase-terminate-success` string, 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-round` integer — 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-increment` integer — 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 `202`

## Other responses

- `400`
- `401`
- `404`

---

[API](https://skmtc.net/ns-api/apis/netsapiens-api-v2.md) · [All operations](https://skmtc.net/ns-api/apis/netsapiens-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ns-api/netsapiens-api-v2/versions/d37f65b5b886/schema)