Sign in
Messaging

Changed on
get/api/v2/messages/sent

Request

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

Query parameters

limitnumber

Limit per request

fqcnstring required

channel name

initiatingMessageIdstring

Initiating message id

initiatingTransactionIdstring

Initiating transaction id

transactionIdstring

Transaction id

messageIdstring

Message id

clientGatewayMessageIdstring

Client Gateway Message id

topicNamestring

topic name

topicOwnerstring

application namespace

pagenumber

Current page

Response

Message received successfully

clientGatewayMessageIdstring required

Client gateway generated message id

initiatingMessageIdstring

Initating message id

initiatingTransactionIdstring

Initating transaction id

topicIdstring required

Topic ID

topicNamestring

topic name

topicOwnerstring

application namespace

topicVersionstring required

Topic version

transactionIdstring required

Transaction ID

signaturestring required

Generated signature

payloadEncryptionboolean required

Was payload encrypted

payloadstring required

Sent payload

timestampNanosnumber required

timestamp in nano seconds

timestampISOstring required

timestamp formatted in ISO

senderDidstring required

Sender DID

fqcnstring required

Channel name

relatedMessagesCountnumber required

Related messages count

isFileboolean required

Is file

totalRecipientsnumber required

Total amount of recipients

totalSentnumber required

Total sent messages

totalFailednumber required

Total failed messages

createdDatestring required

When application got stored in cache

updatedDatestring required

When application got stored in cache

messagesIdsstring[]

Message id

Example response

[
  {
    "clientGatewayMessageId": "f923afb7-e334-419c-a72c-a60b293184ea",
    "initiatingMessageId": "507f191e810c19729de860ea",
    "initiatingTransactionId": "f923afb7-e334-419c-a72c-a60b293184ea",
    "topicId": "507f191e810c19729de860ea",
    "topicName": "getOperatingEnvelope",
    "topicOwner": "torta.apps.eggplant.vege.iam.ewc",
    "topicVersion": "0.0.1",
    "transactionId": "f923afb7-e334-419c-a72c-a60b293184ea",
    "timestampNanos": 1649147198388,
    "timestampISO": "2023-11-19T16:00:00.000Z",
    "senderDid": "did:ethr:volta:0x782aB0383Bfc807439d8EE29516937B47815d697",
    "fqcn": "channel.name",
    "relatedMessagesCount": 1,
    "totalRecipients": 1,
    "totalSent": 1,
    "totalFailed": 1,
    "createdDate": "2022-05-18T11:19:07.000Z",
    "updatedDate": "2022-05-18T11:19:07.000Z",
    "messagesIds": [
      "507f191e810c19729de860ea"
    ],
    "recipients": [
      {
        "did": "did:ethr:volta:0x782aB0383Bfc807439d8EE29516937B47815d697",
        "alias": "John Doe",
        "messageId": "507f191e810c19729de860ea"
      }
    ]
  }
]

Changes