Retrieve the status for a specific message using its ID

Request

Retrieves detailed status information for a message, including the channel, creation time, priority, type, payload, and processing statuses.

Note

To use this endpoint, you must have the MonitorSystemStatus privilege.

Security

OAuth2

Path

idinteger, (int64)required

The unique ID of the message, for example, 12345.

curl -i -X GET \
  'https://your-server/api/status/messages/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Body

idinteger, (int64)

ID of the message in the messaging system.

channelstring or null

Channel this message was published to.

created_onstring, (date-time)

Time the message was created.

priorityinteger, (int64)

Priority of the message. The higher the priority, the sooner the consumption on queues supporting the message prioritization.

reference_countinteger, (int64)

Number of references of this message in various queues located in the same location as this message. A message with a reference count equal to 0 will be automatically garbage collected after a period of time (depends on the configuration).

typestring or null

.NET type of the message content (payload).

payloadobject or null

The message content.

statusesArray of objects or null(MessageStatus)

Collection of message status information on various queues. The actual state of the message in all applicable queues is not part of these statuses.

selfobject(Link)

Represents a link to a resource.

Response

{
  "id": 0,
  "channel": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "priority": 0,
  "reference_count": 0,
  "type": "string",
  "payload": {},
  "statuses": [
    { … }
  ],
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  }
}