Call Queues API — ACD Queue Management REST Endpoints

Call queues (ACD queues) hold inbound callers in a waiting pool and distribute them to available agents according to a configurable strategy. Each queue has a queue_number that callers dial or that DIDs route to, a timeout controlling the maximum hold time in seconds, and a status flag controlling whether the queue is active. All endpoints require an active admin session. The list endpoint supports an optional search parameter that matches against name, queue_number, and strategy. List and show responses include the parent tenant and the assigned agents relations.

GET /api/queues

Returns all call queues ordered by creation date descending, with tenant and agents relations included. Query parameters

string

Optional. Filters queues whose name, queue_number, or strategy contains the given string (case-insensitive).

string

Value is "Queues fetched successfully.".

array

Array of queue objects.

Show queue object fields

integer

Auto-incremented primary key.

integer

ID of the tenant this queue belongs to.

string

Human-readable name for the queue, e.g. "Support Queue".

string

The dialable number or extension used to reach this queue, e.g. "5000".

string

Call distribution strategy, e.g. roundrobin, leastrecent, or ringall.

integer

Maximum time in seconds a caller waits in the queue before overflow. Minimum: 1.

string

Lifecycle status, e.g. active or inactive.

object

The parent tenant object.

array

Array of queue agent objects (extension-based members of this queue).

string

ISO 8601 creation timestamp.

string

ISO 8601 last-updated timestamp.

curl https://your-instance.laracopilot.com/api/queues \
  -H "Accept: application/json" \
  -b cookies.txt

curl "https://your-instance.laracopilot.com/api/queues?search=support" \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "Queues fetched successfully.",
  "data": [
    {
      "id": 1,
      "tenant_id": 1,
      "name": "Support Queue",
      "queue_number": "5000",
      "strategy": "roundrobin",
      "timeout": 60,
      "status": "active",
      "tenant": { "id": 1, "name": "Acme Corp" },
      "agents": [],
      "created_at": "2025-03-01T09:00:00.000000Z",
      "updated_at": "2025-03-01T09:00:00.000000Z"
    }
  ]
}

POST /api/queues

Creates a new call queue and returns 201 Created with the record.

integer

required

ID of the tenant to assign this queue to. Must reference an existing tenant.

string

required

Human-readable queue name. Maximum 255 characters.

string

required

Dialable number or short code for the queue, e.g. "5001". Maximum 20 characters.

string

required

Agent selection strategy, e.g. roundrobin, leastrecent, ringall. Maximum 100 characters.

integer

required

Maximum caller wait time in seconds. Minimum value: 1.

string

required

Lifecycle status, e.g. active or inactive. Maximum 50 characters.

string

Value is "Queue created successfully.".

object

The newly created queue record.

curl -X POST https://your-instance.laracopilot.com/api/queues \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -b cookies.txt \
  -d '{
    "tenant_id": 1,
    "name": "Sales Queue",
    "queue_number": "5001",
    "strategy": "leastrecent",
    "timeout": 120,
    "status": "active"
  }'

{
  "message": "Queue created successfully.",
  "data": {
    "id": 2,
    "tenant_id": 1,
    "name": "Sales Queue",
    "queue_number": "5001",
    "strategy": "leastrecent",
    "timeout": 120,
    "status": "active",
    "created_at": "2025-04-22T10:45:00.000000Z",
    "updated_at": "2025-04-22T10:45:00.000000Z"
  }
}

GET /api/queues/

Fetches a single call queue by its ID. Includes the parent tenant and agents relations. Path parameters

integer

required

The numeric ID of the queue to retrieve.

string

Value is "Queue loaded successfully.".

object

The queue record with tenant and agents included.

curl https://your-instance.laracopilot.com/api/queues/2 \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "Queue loaded successfully.",
  "data": {
    "id": 2,
    "tenant_id": 1,
    "name": "Sales Queue",
    "queue_number": "5001",
    "strategy": "leastrecent",
    "timeout": 120,
    "status": "active",
    "tenant": { "id": 1, "name": "Acme Corp" },
    "agents": [],
    "created_at": "2025-04-22T10:45:00.000000Z",
    "updated_at": "2025-04-22T10:45:00.000000Z"
  }
}

PUT /api/queues/

Replaces all fields on an existing call queue. PATCH /api/queues/{queue} is also accepted and uses the same handler. Path parameters

integer

required

The numeric ID of the queue to update.

integer

required

Must reference an existing tenant.

string

required

Maximum 255 characters.

string

required

Maximum 20 characters.

string

required

Maximum 100 characters.

integer

required

Minimum value: 1.

string

required

Maximum 50 characters.

string

Value is "Queue updated successfully.".

object

The updated queue record.

curl -X PUT https://your-instance.laracopilot.com/api/queues/2 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -b cookies.txt \
  -d '{
    "tenant_id": 1,
    "name": "Sales Queue",
    "queue_number": "5001",
    "strategy": "ringall",
    "timeout": 90,
    "status": "active"
  }'

{
  "message": "Queue updated successfully.",
  "data": {
    "id": 2,
    "tenant_id": 1,
    "name": "Sales Queue",
    "queue_number": "5001",
    "strategy": "ringall",
    "timeout": 90,
    "status": "active",
    "created_at": "2025-04-22T10:45:00.000000Z",
    "updated_at": "2025-04-22T11:30:00.000000Z"
  }
}

DELETE /api/queues/

Permanently deletes the specified call queue. Path parameters

integer

required

The numeric ID of the queue to delete.

string

Value is "Queue deleted successfully.".

curl -X DELETE https://your-instance.laracopilot.com/api/queues/2 \
  -H "Accept: application/json" \
  -b cookies.txt

{
  "message": "Queue deleted successfully."
}

Authentication

Resources

Messaging

Call Queues API — ACD Queue Management REST Endpoints

GET /api/queues

POST /api/queues

GET /api/queues/

PUT /api/queues/

DELETE /api/queues/

​GET /api/queues

​POST /api/queues

​GET /api/queues/

​PUT /api/queues/

​DELETE /api/queues/

GET /api/queues

POST /api/queues

GET /api/queues/

PUT /api/queues/

DELETE /api/queues/