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

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/get-message-by-id
  • Auth: HTTP bearer

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

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Message details retrieved successfully.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success",
    "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": []
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.