List Message Receipts

Fetches receipts details from a specific message.

Fetch receipts details from a specific message.

GETyourpodURL.symphony.com/pod/v1/admin/messages/{messageId}/receipts

Path parameters

messageId*string

The message ID

Query parameters

Header parameters

Response

200400401403404500

OK

Body

application/json

creatorMessageUser (object)

onBehalfOfUserMessageUser (object)

streamMessageStream (object)

creationDateinteger (int64)

deliveryReceiptCountinteger

readReceiptCountinteger

emailNotificationCountinteger

downloadReceiptCountsarray of MessageDownloadReceiptCount (object)

MessageReceiptDetailarray of MessageReceiptDetail (object)

paginationPagination (object)

Request

JavaScriptCurl

const response = await fetch('yourpodURL.symphony.com/pod/v1/admin/messages/{messageId}/receipts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "creator": {
    "id": 7215545058329,
    "name": "User Test"
  },
  "onBehalfOfUser": {
    "id": 7215545058329,
    "name": "User Test"
  },
  "stream": {
    "id": "lFpyw0ATFmji+Cc/cSzbk3///pZkWpe1dA==",
    "name": "Test Room",
    "streamType": "ROOM"
  },
  "creationDate": 1552999333141,
  "deliveryReceiptCount": 1,
  "readReceiptCount": 1,
  "emailNotificationCount": 1,
  "downloadReceiptCounts": [
    {
      "fileName": "internal_70781",
      "count": 1
    }
  ],
  "MessageReceiptDetail": [
    {
      "user": {
        "id": 7215545058329,
        "username": "dpayet",
        "firstName": "Dimitri",
        "lastName": "Payet",
        "emailAddress": "[email protected]"
      },
      "deliveryReceiptTimestamp": 1552999333784,
      "readReceiptTimestamp": 1552999335114,
      "emailNotificationTimestamp": 1552999335114,
      "downloadReceiptCounts": [
        {
          "fileName": "Untitled Document.txt",
          "timestamp": 1552999335740
        }
      ]
    }
  ],
  "pagination": {
    "cursors": {
      "before": "MTAxNTExOTQ1MjAwNzI5NDE=",
      "after": "NDMyNzQyODI3OTQw"
    },
    "previous": "https://tenantapi.d.isym.io/v1/tenantinfo?limit=25&before=MTAxNTExOTQ1MjAwNzI5NDE=",
    "next": "https://tenantapi.d.isym.io/v1/tenantinfo?limit=25&after=NDMyNzQyODI3OTQw"
  }
}

🚧 Required roles

Calling this endpoint requires the Content Management role with the VIEW_MANAGE_MESSAGES entitlement. See Bot Permissions for a list of roles and associated privileges.