Sign in
Messaging

Changed on
post/api/v2/messages

Request

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

Request body

fqcnstring required

Channel Name

initiatingMessageIdstring

Initiating message id

initiatingTransactionIdstring

Initiating transaction id

topicNamestring required

Topic name

topicVersionstring required

Topic Version

topicOwnerstring required

Topic Owner

transactionIdstring required

Transaction Id used to check Idempotency

payloadstring required

Payload to be sent to message

anonymousRecipientstring[] required

List of anonymous keys which will serve as recipients of the message.

Example request

{
  "fqcn": "channel.name",
  "initiatingMessageId": "507f1f77bcf86cd799439011",
  "initiatingTransactionId": "8ac55aa7-7d6d-438a-98bd-376079903c7b",
  "topicVersion": "1.0.0",
  "topicOwner": "aemo.edge",
  "payload": "{ data: 49 }"
}

Response

Message sent successfully

clientGatewayMessageIdstring required

client Gateway Message Id

didstring required

did

Example response

{
  "clientGatewayMessageId": "0b271eb8-1e21-4817-95af-7951649360ed",
  "did": "did: ethr: volta: 0x09Df5d33f1242E1b8aA5E0E0F6BfA687E6846993",
  "recipients": {
    "total": 3,
    "sent": 2,
    "failed": 1
  },
  "status": [
    {
      "details": [
        {
          "did": "did:ethr:volta:0x09Df5d33f1242E1b8aA5E0E0F6BfA687E6846993",
          "messageId": "623c875beaa0422bfc19b1ce",
          "statusCode": 200
        }
      ],
      "name": "SENT or FAILED"
    }
  ]
}

Changes

  • b95cdf53c2c5Revision changes
    • info

      api operation id MessageControlller_create removed and replaced with MessageController_create

  • fa8e74fc2211Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property