DIDComm Basic Messages

Changed on

Retrieve basic messages by connection id

get/didcomm/basic-messages

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /didcomm/basic-messages
  • Auth
    none declared

Query parameters

connectionIdstring
Example:821f9b26-ad04-4f56-89b6-e2ef9c72b36e

Connection identifier

role'sender' | 'receiver'
threadIdstring
Example:ea4e5e69-fc04-465a-90d2-9f8ff78aa71d
parentThreadIdstring
Example:ea4e5e69-fc04-465a-90d2-9f8ff78aa71d

Headers

x-tenant-idstring

Optional header to set the context to a specific tenant. Only needed when the --multi-tenant feature is enabled. Default value is 'default'

Response

BasicMessageRecord[]

idstring required
createdAtstring date-time required
updatedAtstring date-time
typestring required
connectionIdstring required
role'sender' | 'receiver' required
contentstring required
sentTimestring required
threadIdstring
parentThreadIdstring

Example response

[
  {
    "id": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e",
    "connectionId": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e",
    "threadId": "ea4e5e69-fc04-465a-90d2-9f8ff78aa71d",
    "parentThreadId": "ea4e5e69-fc04-465a-90d2-9f8ff78aa71d"
  }
]

Changes

  • 33596742b733Revision changes
    • info

      the endpoint scheme security tenants was removed from the API

    • info

      added the new optional header request parameter x-tenant-id

  • a7641432a6c1Revision changes
    • warning

      deleted the header request parameter x-tenant-id

    • info

      the endpoint scheme security tenants was added to the API