Add agent to call queue

Adds a user or a device to a call queue as an agent.

Requires Call Center Supervisor, Office Manager, Route Manager, Reseller, or Super User. Site Manager can add users of its own site to queues at its own site. Call Center Agent, Basic User, Advanced User, Simple User, Office Manager Read-Only, and Super User Read Only get 403.

callqueue-agent-id is required: 1001@example.com adds the user, so every device of the user rings; sip:1001wp@example.com adds one device. A bare 1001 is stored as 1001@<domain>. The id must belong to the path's domain and fit user@domain or sip:device@domain in 127 characters. The agent starts logged in (automatic) unless you send callqueue-agent-availability-type. 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 entry back with 200. The agent is notified that they were added. An agent already on the queue returns 409.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//callqueues//agents' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "callqueue-agent-id": "1001@example.com", "callqueue-agent-availability-type": "automatic", "callqueue-agent-wrap-up-allowance-seconds": 10, "callqueue-agent-dispatch-order-ordinal": 1, "limits-max-active-calls-total": 1, "auto-answer-enabled": "no", "synchronous": "yes" }'

{ "callqueue": "4000", "domain": "example.com", "callqueue-agent-id": "1001@example.com", "name-full-name": "Front Desk", "callqueue-agent-availability-type": "automatic", "callqueue-agent-availability-for-dispatch": "available", "auto-answer-enabled": "no", "callqueue-agent-wrap-up-allowance-seconds": 10, "callqueue-agent-has-registered-devices": "yes", "callqueue-agent-dispatch-order-ordinal": 1, "callqueue-agent-dispatch-queue-priority-ordinal": 1, "limits-max-active-calls-total": 1, "callqueue-agent-answer-confirmation-enabled": "no", "active-calls-total-current": 0, "callqueue-agent-max-concurrent-sms-conversations": 0, "last-callqueue-dispatch-datetime": "2026-09-01T14:30:00+00:00", "last-modified-datetime": "2026-09-01T14:32:10+00:00", "callqueue-agent-entry-type": "user", "login-username": "1001@example.com", "name-first-name": "Front", "name-last-name": "Desk", "agent-department": "Sales", "site": "Main Office", "user-scope": "Call Center Agent", "status-message": "" }

Request

Responses