Create call queue - NetSapiens API v2

Creates a call queue and everything it needs to take calls: the queue, its dispatch settings, a system user for the extension, an answering rule that sends calls into the queue, a queue_<callqueue> dial rule, and, when you send one, the queue's phone number and forwards.

Requires Office Manager, Call Center Supervisor, Route Manager, Reseller, or Super User. Site Manager can create a queue at its own site: a create without site is assigned to the Site Manager's own site, and another site returns 403. Other scopes get 403, including Office Manager Read-Only and Super User Read Only.

callqueue and description are required. callqueue takes letters, digits, ., -, and _, and list, count, and all are reserved; anything else returns 400. callqueue-dispatch-type defaults to Call Park when left out, so send it for a queue that dispatches to agents. 202 means the change was published over the service bus (SBUS), not yet applied. Send synchronous=yes to wait up to 2 seconds and get the created queue back with 200. A queue that already exists returns 409. A phone-number that is not in the domain's number inventory, or belongs to another domain, returns 422 before anything is created. A value too long for its field returns 400.

Add agents with POST /domains/{domain}/callqueues/{callqueue}/agents.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200OK

application/json

With synchronous=yes: the created queue, once its rows are written. recording-configuration is left out; read the queue to confirm it.

Bodyapplication/json

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠422Unprocessable Entity

🔴503Service Unavailable

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//callqueues' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "callqueue": "4000", "description": "Sales Queue", "callqueue-dispatch-type": "Round-robin", "callqueue-agent-dispatch-timeout-seconds": 20, "callqueue-max-wait-timeout-minutes": 10, "callqueue-calculate-statistics": "yes", "department": "Sales", "site": "Main Office", "voicemail-enabled": "yes", "phone-number": "15555550100", "forward-no-answer": "vmail_4000", "synchronous": "yes" }'

{ "callqueue": "4000", "domain": "example.com", "description": "Sales Queue", "callqueue-dispatch-type": "Round-robin", "callqueue-agent-dispatch-timeout-seconds": 20, "callqueue-calculate-statistics": "yes", "callqueue-sim-ring-1st-round": 0, "callqueue-sim-ring-increment": 1, "callqueue-agent-auto-logout-after-missed": "no", "callqueue-max-wait-timeout-minutes": 10, "callqueue-max-current-wait-to-accept-new-callers-seconds": 0, "callqueue-max-current-callers-to-accept-new-callers": 0, "callqueue-require-available-agents-to-accept-new-callers": "no", "callqueue-max-callback-queueing-hours": 0, "callqueue-debug": "no", "callqueue-local-only": "no", "callqueue-force-full-intro-playback": "no", "callqueue-source-match": null, "callqueue-sms-enable": "no", "active-queued-calls-total-current": 0, "callqueue-count-agents-total": 0, "callqueue-count-agents-available": 0, "department": "Sales", "site": "Main Office", "voicemail-enabled": "yes", "callqueue-ring-timeout-seconds": "60", "phone-number": "15555550100", "forward-on-busy": "", "forward-when-unregistered": "", "forward-no-answer": "vmail_4000", "callqueue-hold-audio-type": "moh" }