Queue snapshot for all connected agents

GET

/queue/status

GET

/queue/status

$ curl https://api.messageblue.ai/queue/status \
>      -H "X-App-Id: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "ok": true,
3   "data": {
4     "connectedAgents": 3,
5     "pendingJobsInFlight": 5,
6     "totals": {
7       "pending": 7,
8       "processing": 3,
9       "totalActive": 10,
10       "byType": {
11         "outbound_msg": 6,
12         "read_receipt": 1,
13         "stop_typing": 1,
14         "typing_indicator": 2
15       }
16     },
17     "agents": [
18       {
19         "number": "+14155552671",
20         "ok": true,
21         "error": null,
22         "machineId": "macbook-pro-01",
23         "lastSeenMs": 1689001234567,
24         "queue": {
25           "agentNumber": "+14155552671",
26           "machineId": "macbook-pro-01",
27           "capturedAtMs": 1689001234567,
28           "limit": 200,
29           "truncated": false,
30           "summary": {
31             "total": 4,
32             "totalActive": 4,
33             "pending": 3,
34             "processing": 1,
35             "byType": {
36               "outbound_msg": 3,
37               "typing_indicator": 1
38             },
39             "busy": true,
40             "busyForMs": 12000
41           },
42           "jobs": [
43             {
44               "id": 101,
45               "jobId": "job-abc123",
46               "type": "outbound_msg",
47               "status": "pending",
48               "to": "+14155551234",
49               "chatIdentifier": "chat-xyz789",
50               "duration": null,
51               "textPreview": "Hey, are you available for a quick call?",
52               "enqueuedAtMs": 1689001200000,
53               "waitingForMs": 30000
54             }
55           ]
56         }
57       }
58     ]
59   },
60   "meta": {
61     "requestId": "550e8400-e29b-41d4-a716-446655440000",
62     "timestamp": "2026-07-10T06:00:00.000Z"
63   }
64 }

Fans out a queue_status request to every agent currently connected to this gateway instance and aggregates pending/processing job counts.

Authentication

X-App-Idstring

Your MessageBlue App ID, sent in clear on every request. It is paired with request signing: each request is also signed with your App Secret (see the Authentication tag). The App Secret itself is NEVER transmitted — it is only the HMAC signing key.

Query parameters

limitintegerOptional<=1000Defaults to 200

Max jobs returned per agent snapshot.

includeTextbooleanOptionalDefaults to true

textPreviewLenintegerOptionalDefaults to 200

timeoutMsintegerOptional500-30000Defaults to 5000

Per-agent WebSocket timeout in milliseconds.

Response

Aggregated queue status

okboolean

dataobject

Endpoint-specific payload wrapped in a standard success envelope.

metaobject

Errors

401

Unauthorized Error

500

Internal Server Error