Sign in
Messaging

Changed on
get/api/v2/messages/received

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

fqcnstring required

channel name

fromstring

date from which messages to be fetched

amountnumber

Latest amount of messages to be fetched

topicNamestring

topic name

topicOwnerstring

application namespace

clientIdstring

cursor for pointing to messages

initiatingMessageIdstring

Initiating message id

initiatingTransactionIdstring

Initiating transaction id

transactionIdstring

Initiating transaction id

messageIdstring

Message id

messageIdsstring

Message id array as comma separated string

Response

Message received successfully

idstring required

message id

topicIdstring required

topic id

replyMessagesCountnumber required

Reply messages count

topicNamestring required

topic Name

topicOwnerstring required

application namespace

topicVersionstring required

Topic Version

topicSchemaType'JSD7' | 'XML' | 'XSD6' | 'CSV' | 'TSV' required

schema type of the topic

payloadstring required

Payload sent to message

signaturestring required

signature sent to message

senderstring required

message sender did

senderAliasstring required

message sender alias if set

timestampNanosnumber required

timestamp in nano seconds

timestampISOstring required

timestamp formatted in ISO

transactionIdstring required

transactionId sent to message for idempotency

signatureValid'FAILED' | 'NOT_PERFORMED' | 'NOT_REQUIRED' | 'REQUIRED_NOT_PERFORMED' | 'SUCCESS' required

Signature validation status for a message

relatedMessagesCountnumber

Related messages count. Only appears for channels with message forms.

isReadboolean required

Acknowledgement status of the message

Example response

[
  {
    "id": "110",
    "topicId": "111",
    "replyMessagesCount": 2,
    "topicName": "getOperatingEnvelope",
    "topicOwner": "torta.apps.eggplant.vege.iam.ewc",
    "topicVersion": "1.0.0",
    "topicSchemaType": "JSD7",
    "payload": "{\"fileId\":\"624bfd4f4c6cf04abfc20041\"}",
    "signature": "0x0abc6026b01856a756de47ec6f44d9c14fe69009bbf3b9b6cf522d8d783a1c654425848381affca5dab9284d8715fa2f9e34155374bafd923d75c219496cbe161c",
    "sender": "did:ethr:volta:0x03830466Ce257f9B798B0f27359D7639dFB6457D",
    "senderAlias": "John Doe",
    "timestampNanos": 1649147198388,
    "timestampISO": "2023-11-19T16:00:00.000Z",
    "transactionId": "1649147198388",
    "signatureValid": "SUCCESS",
    "relatedMessagesCount": 5
  }
]

Changes