Queue snapshot for a single agent

View as Markdown

Requests a live snapshot of the specified agent’s SQLite job queue (typing, stop typing, read receipt jobs).

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.

Path parameters

phoneNumberstringRequired

Agent iMessage number (E.164).

Query parameters

limitintegerOptional<=1000Defaults to 200
includeTextbooleanOptionalDefaults to true
textPreviewLenintegerOptionalDefaults to 200
timeoutMsintegerOptional500-30000Defaults to 5000

Response

Queue snapshot
okboolean
dataobject

Endpoint-specific payload wrapped in a standard success envelope.

metaobject

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error
504
Gateway Timeout Error