v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB

message

get message by ID

Retrieve a specific message using its unique identifier. Optionally includes the media content if requested.

post/instances/{id}/client/action/get-message-by-id

Path parameters

idinteger required

Instance ID

Request body

messageIdstring required

Serialized message ID in format: <fromMe><chatId><messageHash>

includeMediaboolean

When true, includes base64 encoded media content in the response

Example request

{
  "messageId": "false_12345678901@c.us_ABCDEF1234567890"
}

Response

Message details retrieved successfully

status'success' | 'error'

instanceIdstring

Example response

{
  "status": "success",
  "instanceId": "1",
  "data": {
    "message": {
      "id": {
        "remote": "12345678901@c.us",
        "id": "ABCDEF1234567890",
        "_serialized": "false_12345678901@c.us_ABCDEF1234567890"
      },
      "body": "hey",
      "type": "chat",
      "timestamp": 1735567580,
      "from": "12345678901@c.us",
      "to": "10987654321@c.us",
      "deviceType": "ios",
      "vCards": [],
      "mentionedIds": [],
      "groupMentions": [],
      "links": []
    }
  }
}