Numbers and call routing

Call queues and agents

Call queues hold callers until an agent is free. Agents are users who log in to a queue. These endpoints manage the queues, their agents and agent status.

In the Key Admin this is the Call queues and agents switch. Read lets a key call the GET endpoints below. Write lets it call the ones that change data.

List call queues

GET/domains/~/callqueues

Returns the call queues on the account.

Read Key Admin switch: Call queues and agents, Read. Read only keys also work.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "callqueue": "string",
    "domain": "string",
    "description": "string",
    "callqueue-dispatch-type": "Round-robin",
    "callqueue-calculate-statistics": "yes",
    "active-queued-calls-total-current": 1,
    "callqueue-agent-dispatch-timeout-seconds": 1,
    "callqueue-count-agents-available": 1,
    "...": "20 more fields"
  }
]

Response fields (28)

Field	Type	Notes
`callqueue`	string	The call queue's ID.
`domain`	string	The account the item belongs to. Max length 64
`description`	string	A note about the item.
`callqueue-dispatch-type`	string	One of: `Round-robin`, `Tiered Round-robin`, `Ring All`, `Linear Cascade`, `Linear Hunt`, `Call Park`
`callqueue-calculate-statistics`	string	One of: `yes`, `no`
`active-queued-calls-total-current`	integer
`callqueue-agent-dispatch-timeout-seconds`	integer	Callqueue agent dispatch timeout, in seconds.
`callqueue-count-agents-available`	integer
`callqueue-count-agents-total`	integer
`callqueue-debug`	string	One of: `yes`, `no`
`callqueue-force-full-intro-playback`	string	One of: `yes`, `no`
`callqueue-max-callback-queueing-hours`	integer	Default `0` Min 0 Max 6
`callqueue-max-current-callers-to-accept-new-callers`	integer	Default `0` Min 0
`callqueue-max-current-wait-to-accept-new-callers-seconds`	integer	Callqueue max current wait to accept new callers, in seconds. Default `0` Min 0
`callqueue-max-wait-timeout-minutes`	integer	Callqueue max wait timeout, in minutes. Default `0` Min 0
`callqueue-require-available-agents-to-accept-new-callers`	string	One of: `yes`, `no` Default `no`
`callqueue-source-match`	string
`callqueue-sms-enable`	string	One of: `yes`, `no` Default `no`
`callqueue-sms-phrase-initiate-chat`	string
`callqueue-sms-phrase-initiate-success`	string
`callqueue-sms-phrase-initiation-fail`	string
`callqueue-sms-phrase-no-agents-available`	string
`callqueue-sms-phrase-terminate-chat`	string
`callqueue-sms-phrase-terminate-success`	string
`callqueue-agent-auto-logout-after-missed`	string	One of: `yes`, `no` Default `no`
`callqueue-sim-ring-1st-round`	integer	Default `0` Min 0 Max 99
`callqueue-sim-ring-increment`	integer	Default `1` Min 0 Max 99
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

Other responses: 400, 401, 404. See errors.

List call queues (short form)

GET/domains/~/callqueues/list

Returns just the key fields for each call queue on the account.

Read Key Admin switch: Call queues and agents, Read. Read only keys also work.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/list" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/list", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/list",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "callqueue": "string",
    "domain": "string",
    "description": "string",
    "callqueue-dispatch-type": "Round-robin",
    "callqueue-calculate-statistics": "yes",
    "active-queued-calls-total-current": 1,
    "callqueue-agent-dispatch-timeout-seconds": 1,
    "callqueue-count-agents-available": 1,
    "...": "20 more fields"
  }
]

Response fields (28)

Field	Type	Notes
`callqueue`	string	The call queue's ID.
`domain`	string	The account the item belongs to. Max length 64
`description`	string	A note about the item.
`callqueue-dispatch-type`	string	One of: `Round-robin`, `Tiered Round-robin`, `Ring All`, `Linear Cascade`, `Linear Hunt`, `Call Park`
`callqueue-calculate-statistics`	string	One of: `yes`, `no`
`active-queued-calls-total-current`	integer
`callqueue-agent-dispatch-timeout-seconds`	integer	Callqueue agent dispatch timeout, in seconds.
`callqueue-count-agents-available`	integer
`callqueue-count-agents-total`	integer
`callqueue-debug`	string	One of: `yes`, `no`
`callqueue-force-full-intro-playback`	string	One of: `yes`, `no`
`callqueue-max-callback-queueing-hours`	integer	Default `0` Min 0 Max 6
`callqueue-max-current-callers-to-accept-new-callers`	integer	Default `0` Min 0
`callqueue-max-current-wait-to-accept-new-callers-seconds`	integer	Callqueue max current wait to accept new callers, in seconds. Default `0` Min 0
`callqueue-max-wait-timeout-minutes`	integer	Callqueue max wait timeout, in minutes. Default `0` Min 0
`callqueue-require-available-agents-to-accept-new-callers`	string	One of: `yes`, `no` Default `no`
`callqueue-source-match`	string
`callqueue-sms-enable`	string	One of: `yes`, `no` Default `no`
`callqueue-sms-phrase-initiate-chat`	string
`callqueue-sms-phrase-initiate-success`	string
`callqueue-sms-phrase-initiation-fail`	string
`callqueue-sms-phrase-no-agents-available`	string
`callqueue-sms-phrase-terminate-chat`	string
`callqueue-sms-phrase-terminate-success`	string
`callqueue-agent-auto-logout-after-missed`	string	One of: `yes`, `no` Default `no`
`callqueue-sim-ring-1st-round`	integer	Default `0` Min 0 Max 99
`callqueue-sim-ring-increment`	integer	Default `1` Min 0 Max 99
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

Other responses: 400, 401, 404. See errors.

Get a call queue

GET/domains/~/callqueues/{callqueue}

Returns one call queue by its ID.

Read Key Admin switch: Call queues and agents, Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

{
  "callqueue": "string",
  "domain": "string",
  "description": "string",
  "callqueue-dispatch-type": "Round-robin",
  "callqueue-calculate-statistics": "yes",
  "active-queued-calls-total-current": 1,
  "callqueue-agent-dispatch-timeout-seconds": 1,
  "callqueue-count-agents-available": 1,
  "...": "20 more fields"
}

Response fields (28)

Field	Type	Notes
`callqueue`	string	The call queue's ID.
`domain`	string	The account the item belongs to. Max length 64
`description`	string	A note about the item.
`callqueue-dispatch-type`	string	One of: `Round-robin`, `Tiered Round-robin`, `Ring All`, `Linear Cascade`, `Linear Hunt`, `Call Park`
`callqueue-calculate-statistics`	string	One of: `yes`, `no`
`active-queued-calls-total-current`	integer
`callqueue-agent-dispatch-timeout-seconds`	integer	Callqueue agent dispatch timeout, in seconds.
`callqueue-count-agents-available`	integer
`callqueue-count-agents-total`	integer
`callqueue-debug`	string	One of: `yes`, `no`
`callqueue-force-full-intro-playback`	string	One of: `yes`, `no`
`callqueue-max-callback-queueing-hours`	integer	Default `0` Min 0 Max 6
`callqueue-max-current-callers-to-accept-new-callers`	integer	Default `0` Min 0
`callqueue-max-current-wait-to-accept-new-callers-seconds`	integer	Callqueue max current wait to accept new callers, in seconds. Default `0` Min 0
`callqueue-max-wait-timeout-minutes`	integer	Callqueue max wait timeout, in minutes. Default `0` Min 0
`callqueue-require-available-agents-to-accept-new-callers`	string	One of: `yes`, `no` Default `no`
`callqueue-source-match`	string
`callqueue-sms-enable`	string	One of: `yes`, `no` Default `no`
`callqueue-sms-phrase-initiate-chat`	string
`callqueue-sms-phrase-initiate-success`	string
`callqueue-sms-phrase-initiation-fail`	string
`callqueue-sms-phrase-no-agents-available`	string
`callqueue-sms-phrase-terminate-chat`	string
`callqueue-sms-phrase-terminate-success`	string
`callqueue-agent-auto-logout-after-missed`	string	One of: `yes`, `no` Default `no`
`callqueue-sim-ring-1st-round`	integer	Default `0` Min 0 Max 99
`callqueue-sim-ring-increment`	integer	Default `1` Min 0 Max 99
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

List agents in a call queue

GET/domains/~/callqueues/{callqueue}/agents

Returns the agents in one call queue.

Read Key Admin switch: Call queues and agents, Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "callqueue-agent-id": "string",
    "callqueue": "string",
    "domain": "string",
    "callqueue-agent-availability-type": "automatic",
    "callqueue-agent-wrap-up-allowance-seconds": 0,
    "auto-answer-enabled": "yes",
    "callqueue-agent-dispatch-order-ordinal": 1,
    "callqueue-agent-dispatch-queue-priority-ordinal": 1,
    "...": "17 more fields"
  }
]

Response fields (25)

Field	Type	Notes
`callqueue-agent-id`	string	The agent's ID in the queue.
`callqueue`	string	The call queue's ID.
`domain`	string	The account the item belongs to. Max length 64
`callqueue-agent-availability-type`	string	One of: `automatic`, `manual`, `disabled`, `offnet-automatic`
`callqueue-agent-wrap-up-allowance-seconds`	integer	Callqueue agent wrap up allowance, in seconds. Default `0`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-dispatch-order-ordinal`	integer
`callqueue-agent-dispatch-queue-priority-ordinal`	integer
`limits-max-active-calls-total`	integer
`callqueue-agent-answer-confirmation-enabled`	string	Turns callqueue agent answer confirmation on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-has-registered-devices`	string	One of: `yes`, `no`, `push-enabled`, `offnet`
`callqueue-agent-availability-for-dispatch`	string
`active-calls-total-current`	integer
`last-modified-datetime`	string (date-time)	Last modified (date and time).
`callqueue-agent-max-concurrent-sms-conversations`	integer
`last-callqueue-dispatch-datetime`	string (date-time)	Last callqueue dispatch (date and time).
`callqueue-agent-entry-type`	string	One of: `device`, `user`, `offnet`
`login-username`	string
`name-full-name`	string	Full name.
`agent-name-first-name`	string	Name of the agent name first.
`agent-name-last-name`	string	Name of the agent name last.
`agent-department`	string
`agent-site`	string
`agent-user-scope`	string
`agent-status-message`	string

Count agents in a call queue

GET/domains/~/callqueues/{callqueue}/agents/count

Returns how many agents there are in one call queue, as {"total": n}.

Read Key Admin switch: Call queues and agents, Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/count" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/count", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/count",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

{
  "total": 1
}

Response fields (1)

Field	Type	Notes
`total`	integer	How many items matched.

Other responses: 400, 401, 403, 404. See errors.

Get an agent

GET/domains/~/callqueues/{callqueue}/agents/{callqueue-agent-id}

Returns one agent by its ID.

Read Key Admin switch: Call queues and agents, Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.
`callqueue-agent-id` required	path	string	The agent's ID in the queue: their extension, an @ and your account ID, like `1001@yourfirm.noodlevoice`.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

{
  "callqueue-agent-id": "string",
  "callqueue": "string",
  "domain": "string",
  "callqueue-agent-availability-type": "automatic",
  "callqueue-agent-wrap-up-allowance-seconds": 0,
  "auto-answer-enabled": "yes",
  "callqueue-agent-dispatch-order-ordinal": 1,
  "callqueue-agent-dispatch-queue-priority-ordinal": 1,
  "...": "17 more fields"
}

Response fields (25)

Field	Type	Notes
`callqueue-agent-id`	string	The agent's ID in the queue.
`callqueue`	string	The call queue's ID.
`domain`	string	The account the item belongs to. Max length 64
`callqueue-agent-availability-type`	string	One of: `automatic`, `manual`, `disabled`, `offnet-automatic`
`callqueue-agent-wrap-up-allowance-seconds`	integer	Callqueue agent wrap up allowance, in seconds. Default `0`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-dispatch-order-ordinal`	integer
`callqueue-agent-dispatch-queue-priority-ordinal`	integer
`limits-max-active-calls-total`	integer
`callqueue-agent-answer-confirmation-enabled`	string	Turns callqueue agent answer confirmation on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-has-registered-devices`	string	One of: `yes`, `no`, `push-enabled`, `offnet`
`callqueue-agent-availability-for-dispatch`	string
`active-calls-total-current`	integer
`last-modified-datetime`	string (date-time)	Last modified (date and time).
`callqueue-agent-max-concurrent-sms-conversations`	integer
`last-callqueue-dispatch-datetime`	string (date-time)	Last callqueue dispatch (date and time).
`callqueue-agent-entry-type`	string	One of: `device`, `user`, `offnet`
`login-username`	string
`name-full-name`	string	Full name.
`agent-name-first-name`	string	Name of the agent name first.
`agent-name-last-name`	string	Name of the agent name last.
`agent-department`	string
`agent-site`	string
`agent-user-scope`	string
`agent-status-message`	string

List calls waiting in a queue

GET/domains/~/queuedcall/{queue}

Returns the calls currently waiting in one call queue.

Read Key Admin switch: Call queues and agents, Read. Read only keys also work.

Parameters

Name	In	Type	Notes
`queue` required	path	string	The call queue's ID (its extension), like `2000`.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/queuedcall/2000" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/queuedcall/2000", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/queuedcall/2000",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.

Create a call queue

POST/domains/~/callqueues

Adds a new call queue on the account.

Write Key Admin switch: Call queues and agents, Write.

Request body application/json

Field	Type	Notes
`synchronous` required	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`callqueue` required	string	The call queue's ID.
`domain` required	string	The account the item belongs to. Max length 64
`description`	string	A note about the item.
`callqueue-dispatch-type`	string	One of: `Round-robin`, `Tiered Round-robin`, `Ring All`, `Linear Cascade`, `Linear Hunt`, `Call Park`
`callqueue-calculate-statistics`	string	One of: `yes`, `no`
`active-queued-calls-total-current`	integer
`callqueue-agent-dispatch-timeout-seconds`	integer	Callqueue agent dispatch timeout, in seconds.
`callqueue-count-agents-available`	integer
`callqueue-count-agents-total`	integer
`callqueue-debug`	string	One of: `yes`, `no`
`callqueue-force-full-intro-playback`	string	One of: `yes`, `no`
`callqueue-max-callback-queueing-hours`	integer	Default `0` Min 0 Max 6
`callqueue-max-current-callers-to-accept-new-callers`	integer	Default `0` Min 0
`callqueue-max-current-wait-to-accept-new-callers-seconds`	integer	Callqueue max current wait to accept new callers, in seconds. Default `0` Min 0
`callqueue-max-wait-timeout-minutes`	integer	Callqueue max wait timeout, in minutes. Default `0` Min 0
`callqueue-require-available-agents-to-accept-new-callers`	string	One of: `yes`, `no` Default `no`
`callqueue-source-match`	string
`callqueue-sms-enable`	string	One of: `yes`, `no` Default `no`
`callqueue-sms-phrase-initiate-chat`	string
`callqueue-sms-phrase-initiate-success`	string
`callqueue-sms-phrase-initiation-fail`	string
`callqueue-sms-phrase-no-agents-available`	string
`callqueue-sms-phrase-terminate-chat`	string
`callqueue-sms-phrase-terminate-success`	string
`callqueue-agent-auto-logout-after-missed`	string	One of: `yes`, `no` Default `no`
`callqueue-sim-ring-1st-round`	integer	Default `0` Min 0 Max 99
`callqueue-sim-ring-increment`	integer	Default `1` Min 0 Max 99
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "synchronous": "yes",
    "callqueue": "string",
    "domain": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "synchronous": "yes",
    "callqueue": "string",
    "domain": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "synchronous": "yes",
        "callqueue": "string",
        "domain": "string"
    },
)
print(r.status_code, r.json())

Response 200

{
  "callqueue": "string",
  "domain": "string",
  "description": "string",
  "callqueue-dispatch-type": "Round-robin",
  "callqueue-calculate-statistics": "yes",
  "active-queued-calls-total-current": 1,
  "callqueue-agent-dispatch-timeout-seconds": 1,
  "callqueue-count-agents-available": 1,
  "...": "20 more fields"
}

Response fields (28)

Field	Type	Notes
`callqueue`	string	The call queue's ID.
`domain`	string	The account the item belongs to. Max length 64
`description`	string	A note about the item.
`callqueue-dispatch-type`	string	One of: `Round-robin`, `Tiered Round-robin`, `Ring All`, `Linear Cascade`, `Linear Hunt`, `Call Park`
`callqueue-calculate-statistics`	string	One of: `yes`, `no`
`active-queued-calls-total-current`	integer
`callqueue-agent-dispatch-timeout-seconds`	integer	Callqueue agent dispatch timeout, in seconds.
`callqueue-count-agents-available`	integer
`callqueue-count-agents-total`	integer
`callqueue-debug`	string	One of: `yes`, `no`
`callqueue-force-full-intro-playback`	string	One of: `yes`, `no`
`callqueue-max-callback-queueing-hours`	integer	Default `0` Min 0 Max 6
`callqueue-max-current-callers-to-accept-new-callers`	integer	Default `0` Min 0
`callqueue-max-current-wait-to-accept-new-callers-seconds`	integer	Callqueue max current wait to accept new callers, in seconds. Default `0` Min 0
`callqueue-max-wait-timeout-minutes`	integer	Callqueue max wait timeout, in minutes. Default `0` Min 0
`callqueue-require-available-agents-to-accept-new-callers`	string	One of: `yes`, `no` Default `no`
`callqueue-source-match`	string
`callqueue-sms-enable`	string	One of: `yes`, `no` Default `no`
`callqueue-sms-phrase-initiate-chat`	string
`callqueue-sms-phrase-initiate-success`	string
`callqueue-sms-phrase-initiation-fail`	string
`callqueue-sms-phrase-no-agents-available`	string
`callqueue-sms-phrase-terminate-chat`	string
`callqueue-sms-phrase-terminate-success`	string
`callqueue-agent-auto-logout-after-missed`	string	One of: `yes`, `no` Default `no`
`callqueue-sim-ring-1st-round`	integer	Default `0` Min 0 Max 99
`callqueue-sim-ring-increment`	integer	Default `1` Min 0 Max 99
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

Other responses: 400, 401, 404. See errors.

Add an agent to a call queue

POST/domains/~/callqueues/{callqueue}/agents

Adds a user to a call queue as an agent.

Write Key Admin switch: Call queues and agents, Write.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.

Request body application/json

Field	Type	Notes
`synchronous`	string	Set to `yes` to wait until the change is finished before the response comes back. One of: `yes`, `no` Default `no`
`callqueue-agent-id` required	string	The agent's ID in the queue.
`callqueue`	string	The call queue's ID.
`domain`	string	The account the item belongs to. Max length 64
`callqueue-agent-availability-type`	string	One of: `automatic`, `manual`, `disabled`, `offnet-automatic`
`callqueue-agent-wrap-up-allowance-seconds`	integer	Callqueue agent wrap up allowance, in seconds. Default `0`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-dispatch-order-ordinal`	integer
`callqueue-agent-dispatch-queue-priority-ordinal`	integer
`limits-max-active-calls-total`	integer
`callqueue-agent-answer-confirmation-enabled`	string	Turns callqueue agent answer confirmation on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-has-registered-devices`	string	One of: `yes`, `no`, `push-enabled`, `offnet`
`callqueue-agent-availability-for-dispatch`	string
`active-calls-total-current`	integer
`last-modified-datetime`	string (date-time)	Last modified (date and time).
`callqueue-agent-max-concurrent-sms-conversations`	integer
`last-callqueue-dispatch-datetime`	string (date-time)	Last callqueue dispatch (date and time).
`callqueue-agent-entry-type`	string	One of: `device`, `user`, `offnet`
`login-username`	string
`name-full-name`	string	Full name.
`agent-name-first-name`	string	Name of the agent name first.
`agent-name-last-name`	string	Name of the agent name last.
`agent-department`	string
`agent-site`	string
`agent-user-scope`	string
`agent-status-message`	string

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "callqueue-agent-id": "string"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "callqueue-agent-id": "string"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "callqueue-agent-id": "string"
    },
)
print(r.status_code, r.json())

Response 200

{
  "callqueue-agent-id": "string",
  "callqueue": "string",
  "domain": "string",
  "callqueue-agent-availability-type": "automatic",
  "callqueue-agent-wrap-up-allowance-seconds": 0,
  "auto-answer-enabled": "yes",
  "callqueue-agent-dispatch-order-ordinal": 1,
  "callqueue-agent-dispatch-queue-priority-ordinal": 1,
  "...": "17 more fields"
}

Response fields (25)

Field	Type	Notes
`callqueue-agent-id`	string	The agent's ID in the queue.
`callqueue`	string	The call queue's ID.
`domain`	string	The account the item belongs to. Max length 64
`callqueue-agent-availability-type`	string	One of: `automatic`, `manual`, `disabled`, `offnet-automatic`
`callqueue-agent-wrap-up-allowance-seconds`	integer	Callqueue agent wrap up allowance, in seconds. Default `0`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-dispatch-order-ordinal`	integer
`callqueue-agent-dispatch-queue-priority-ordinal`	integer
`limits-max-active-calls-total`	integer
`callqueue-agent-answer-confirmation-enabled`	string	Turns callqueue agent answer confirmation on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-has-registered-devices`	string	One of: `yes`, `no`, `push-enabled`, `offnet`
`callqueue-agent-availability-for-dispatch`	string
`active-calls-total-current`	integer
`last-modified-datetime`	string (date-time)	Last modified (date and time).
`callqueue-agent-max-concurrent-sms-conversations`	integer
`last-callqueue-dispatch-datetime`	string (date-time)	Last callqueue dispatch (date and time).
`callqueue-agent-entry-type`	string	One of: `device`, `user`, `offnet`
`login-username`	string
`name-full-name`	string	Full name.
`agent-name-first-name`	string	Name of the agent name first.
`agent-name-last-name`	string	Name of the agent name last.
`agent-department`	string
`agent-site`	string
`agent-user-scope`	string
`agent-status-message`	string

Other responses: 400, 401, 404. See errors.

Update a call queue

PUT/domains/~/callqueues/{callqueue}

Changes an existing call queue. Send the fields you want to set in the body.

Write Key Admin switch: Call queues and agents, Write.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.

Request body application/json

Field	Type	Notes
`description`	string	A note about the item.
`callqueue-dispatch-type`	string	One of: `Round-robin`, `Tiered Round-robin`, `Ring All`, `Linear Cascade`, `Linear Hunt`, `Call Park`
`callqueue-calculate-statistics`	string	One of: `yes`, `no`
`active-queued-calls-total-current`	integer
`callqueue-agent-dispatch-timeout-seconds`	integer	Callqueue agent dispatch timeout, in seconds.
`callqueue-count-agents-available`	integer
`callqueue-count-agents-total`	integer
`callqueue-debug`	string	One of: `yes`, `no`
`callqueue-force-full-intro-playback`	string	One of: `yes`, `no`
`callqueue-max-callback-queueing-hours`	integer	Default `0` Min 0 Max 6
`callqueue-max-current-callers-to-accept-new-callers`	integer	Default `0` Min 0
`callqueue-max-current-wait-to-accept-new-callers-seconds`	integer	Callqueue max current wait to accept new callers, in seconds. Default `0` Min 0
`callqueue-max-wait-timeout-minutes`	integer	Callqueue max wait timeout, in minutes. Default `0` Min 0
`callqueue-require-available-agents-to-accept-new-callers`	string	One of: `yes`, `no` Default `no`
`callqueue-source-match`	string
`callqueue-sms-enable`	string	One of: `yes`, `no` Default `no`
`callqueue-sms-phrase-initiate-chat`	string
`callqueue-sms-phrase-initiate-success`	string
`callqueue-sms-phrase-initiation-fail`	string
`callqueue-sms-phrase-no-agents-available`	string
`callqueue-sms-phrase-terminate-chat`	string
`callqueue-sms-phrase-terminate-success`	string
`callqueue-agent-auto-logout-after-missed`	string	One of: `yes`, `no` Default `no`
`callqueue-sim-ring-1st-round`	integer	Default `0` Min 0 Max 99
`callqueue-sim-ring-increment`	integer	Default `1` Min 0 Max 99
`recording-configuration`	string	One of: `yes`, `yes-with-transcription`, `yes-with-transcription-and-sentiment`, `no` Default `no`

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "callqueue-dispatch-type": "Round-robin",
    "callqueue-calculate-statistics": "yes",
    "active-queued-calls-total-current": 1,
    "callqueue-agent-dispatch-timeout-seconds": 1
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "description": "string",
    "callqueue-dispatch-type": "Round-robin",
    "callqueue-calculate-statistics": "yes",
    "active-queued-calls-total-current": 1,
    "callqueue-agent-dispatch-timeout-seconds": 1
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "description": "string",
        "callqueue-dispatch-type": "Round-robin",
        "callqueue-calculate-statistics": "yes",
        "active-queued-calls-total-current": 1,
        "callqueue-agent-dispatch-timeout-seconds": 1
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Update an agent

PUT/domains/~/callqueues/{callqueue}/agents/{callqueue-agent-id}

Changes an existing agent. Send the fields you want to set in the body.

Write Key Admin switch: Call queues and agents, Write.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.
`callqueue-agent-id` required	path	string	The agent's ID in the queue: their extension, an @ and your account ID, like `1001@yourfirm.noodlevoice`.

Request body application/json

Field	Type	Notes
`callqueue-agent-availability-type`	string	One of: `automatic`, `manual`, `disabled`, `offnet-automatic`
`callqueue-agent-wrap-up-allowance-seconds`	integer	Callqueue agent wrap up allowance, in seconds. Default `0`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-dispatch-order-ordinal`	integer
`callqueue-agent-dispatch-queue-priority-ordinal`	integer
`limits-max-active-calls-total`	integer
`callqueue-agent-answer-confirmation-enabled`	string	Turns callqueue agent answer confirmation on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-has-registered-devices`	string	One of: `yes`, `no`, `push-enabled`, `offnet`
`callqueue-agent-availability-for-dispatch`	string
`active-calls-total-current`	integer
`last-modified-datetime`	string (date-time)	Last modified (date and time).
`callqueue-agent-max-concurrent-sms-conversations`	integer
`last-callqueue-dispatch-datetime`	string (date-time)	Last callqueue dispatch (date and time).
`callqueue-agent-entry-type`	string	One of: `device`, `user`, `offnet`
`login-username`	string
`name-full-name`	string	Full name.
`agent-name-first-name`	string	Name of the agent name first.
`agent-name-last-name`	string	Name of the agent name last.
`agent-department`	string
`agent-site`	string
`agent-user-scope`	string
`agent-status-message`	string

Example request

curl -X PUT "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "callqueue-agent-availability-type": "automatic",
    "callqueue-agent-wrap-up-allowance-seconds": 0,
    "auto-answer-enabled": "yes",
    "callqueue-agent-dispatch-order-ordinal": 1,
    "callqueue-agent-dispatch-queue-priority-ordinal": 1
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice", {
  method: "PUT",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "callqueue-agent-availability-type": "automatic",
    "callqueue-agent-wrap-up-allowance-seconds": 0,
    "auto-answer-enabled": "yes",
    "callqueue-agent-dispatch-order-ordinal": 1,
    "callqueue-agent-dispatch-queue-priority-ordinal": 1
  }),
});
const data = await res.json();

import os, requests

r = requests.put(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "callqueue-agent-availability-type": "automatic",
        "callqueue-agent-wrap-up-allowance-seconds": 0,
        "auto-answer-enabled": "yes",
        "callqueue-agent-dispatch-order-ordinal": 1,
        "callqueue-agent-dispatch-queue-priority-ordinal": 1
    },
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Set an agent's status in every queue

PATCH/domains/~/callqueues/all/agents/{callqueue-agent-id}/{status}

Logs an agent in or out of all of their call queues at once.

Write Key Admin switch: Call queues and agents, Write.

Parameters

Name	In	Type	Notes
`callqueue-agent-id` required	path	string	The agent's ID in the queue: their extension, an @ and your account ID, like `1001@yourfirm.noodlevoice`.
`status` required	path	string	The status to set, for example `login` or `logout`.

Example request

curl -X PATCH "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/all/agents/1001@yourfirm.noodlevoice/login" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/all/agents/1001@yourfirm.noodlevoice/login", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.patch(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/all/agents/1001@yourfirm.noodlevoice/login",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Log an agent in to a queue

PATCH/domains/~/callqueues/{callqueue}/agents/{callqueue-agent-id}/login

Makes the agent available to take calls from this call queue.

Write Key Admin switch: Call queues and agents, Write.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.
`callqueue-agent-id` required	path	string	The agent's ID in the queue: their extension, an @ and your account ID, like `1001@yourfirm.noodlevoice`.

Example request

curl -X PATCH "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice/login" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice/login", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.patch(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice/login",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Log an agent out of a queue

PATCH/domains/~/callqueues/{callqueue}/agents/{callqueue-agent-id}/logout

Stops this call queue from sending calls to the agent.

Write Key Admin switch: Call queues and agents, Write.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.
`callqueue-agent-id` required	path	string	The agent's ID in the queue: their extension, an @ and your account ID, like `1001@yourfirm.noodlevoice`.

Example request

curl -X PATCH "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice/logout" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice/logout", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.patch(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice/logout",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Give an agent one more call

PATCH/domains/~/callqueues/{callqueue}/agents/{callqueue-agent-id}/onecall

Lets a logged out agent take a single call from this queue, then logs them out again.

Write Key Admin switch: Call queues and agents, Write.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.
`callqueue-agent-id` required	path	string	The agent's ID in the queue: their extension, an @ and your account ID, like `1001@yourfirm.noodlevoice`.

Example request

curl -X PATCH "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice/onecall" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice/onecall", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.patch(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice/onecall",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Delete a call queue

DELETE/domains/~/callqueues/{callqueue}

Removes a call queue. This can't be undone.

Write Key Admin switch: Call queues and agents, Write.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

Remove an agent from a call queue

DELETE/domains/~/callqueues/{callqueue}/agents/{callqueue-agent-id}

Removes an agent. This can't be undone.

Write Key Admin switch: Call queues and agents, Write.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.
`callqueue-agent-id` required	path	string	The agent's ID in the queue: their extension, an @ and your account ID, like `1001@yourfirm.noodlevoice`.

Example request

curl -X DELETE "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.delete(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/callqueues/2000/agents/1001@yourfirm.noodlevoice",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 202

{
  "code": 1,
  "message": "Hello from NoodleVoice"
}

Response fields (2)

Field	Type	Notes
`code`	integer	HTTP status code.
`message`	string	What happened, in words.

List all queue agents

GET/domains/~/agents

Returns every agent across every call queue on the account, with their status.

Full access No feature switch covers this endpoint. It needs a Full access key.

Example request

curl -X GET "https://api.noodlevoice.com/ns-api/v2/domains/~/agents" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY"

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/agents", {
  method: "GET",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/agents",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
)
print(r.status_code, r.json())

Response 200

[
  {
    "callqueue-agent-id": "string",
    "callqueue": "string",
    "domain": "string",
    "callqueue-agent-availability-type": "automatic",
    "callqueue-agent-wrap-up-allowance-seconds": 0,
    "auto-answer-enabled": "yes",
    "callqueue-agent-dispatch-order-ordinal": 1,
    "callqueue-agent-dispatch-queue-priority-ordinal": 1,
    "...": "17 more fields"
  }
]

Response fields (25)

Field	Type	Notes
`callqueue-agent-id`	string	The agent's ID in the queue.
`callqueue`	string	The call queue's ID.
`domain`	string	The account the item belongs to. Max length 64
`callqueue-agent-availability-type`	string	One of: `automatic`, `manual`, `disabled`, `offnet-automatic`
`callqueue-agent-wrap-up-allowance-seconds`	integer	Callqueue agent wrap up allowance, in seconds. Default `0`
`auto-answer-enabled`	string	Turns auto answer on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-dispatch-order-ordinal`	integer
`callqueue-agent-dispatch-queue-priority-ordinal`	integer
`limits-max-active-calls-total`	integer
`callqueue-agent-answer-confirmation-enabled`	string	Turns callqueue agent answer confirmation on or off (`yes` or `no`). One of: `yes`, `no` Default `no`
`callqueue-agent-has-registered-devices`	string	One of: `yes`, `no`, `push-enabled`, `offnet`
`callqueue-agent-availability-for-dispatch`	string
`active-calls-total-current`	integer
`last-modified-datetime`	string (date-time)	Last modified (date and time).
`callqueue-agent-max-concurrent-sms-conversations`	integer
`last-callqueue-dispatch-datetime`	string (date-time)	Last callqueue dispatch (date and time).
`callqueue-agent-entry-type`	string	One of: `device`, `user`, `offnet`
`login-username`	string
`name-full-name`	string	Full name.
`agent-name-first-name`	string	Name of the agent name first.
`agent-name-last-name`	string	Name of the agent name last.
`agent-department`	string
`agent-site`	string
`agent-user-scope`	string
`agent-status-message`	string

Send a waiting call to a destination

POST/domains/~/queuedcall/{callqueue}

Takes a call that is waiting in a queue and sends it to the destination you give.

Full access No feature switch covers this endpoint. It needs a Full access key.

Parameters

Name	In	Type	Notes
`callqueue` required	path	string	The call queue's ID (its extension), like `2000`.

Request body application/json

Field	Type	Notes
`destination` required	string	Where to send it: a number, extension or address.

Example request

curl -X POST "https://api.noodlevoice.com/ns-api/v2/domains/~/queuedcall/2000" \
  -H "Authorization: Bearer $NOODLEVOICE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "destination": "15555550123"
  }'

const res = await fetch("https://api.noodlevoice.com/ns-api/v2/domains/~/queuedcall/2000", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.NOODLEVOICE_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "destination": "15555550123"
  }),
});
const data = await res.json();

import os, requests

r = requests.post(
    "https://api.noodlevoice.com/ns-api/v2/domains/~/queuedcall/2000",
    headers={"Authorization": "Bearer " + os.environ["NOODLEVOICE_KEY"]},
    json={
        "destination": "15555550123"
    },
)
print(r.status_code, r.json())

Response 200

Returns a status code with a short JSON message.