Skip to main content

ReadMessage

Reads a message from a transaction, with optional decryption using secret phrase or shared key.

Request

GET /nxt?requestType=readMessage

All endpoints use port 22024 by default.

Parameters

NameTypeDescriptionRequired
transactionFullHashstringTransaction full hashYes
secretPhrasestringSender's secret passphrase for decryptionNo
sharedKeystringShared key for AES decryptionNo
retrievebooleanRetrieve pruned data (default false)No

Response

{
"message": "Hello World",
"messageIsPrunable": false,
"encryptedMessage": "...",
"encryptedMessageIsPrunable": false,
"decryptedMessage": "Decrypted content",
"errorCode": 0,
"errorDescription": ""
}

Example

curl "http://localhost:22024/nxt?requestType=readMessage&transactionFullHash=abc123..."