Read Datafeed 2

Reads the specified datafeed. The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the Real Time Events list.

Read the specified real time message / event stream ("datafeed").

Available on Agent 2.57.0 and above.

The datafeed provides messages and events from all conversations that the user is in. The types of events surfaced in the datafeed can be found in the Real Time Events list. (see definition on top of the file)

Read the specified datafeed.

The ackId sent as parameter can be empty for the first call. In the response an ackId will be sent back and it can be used for the next call: in this way you acknowledge that you have received the events that came with that ackId; datafeed will remove the events associated with that ackId from your queue

POSTyouragentURL.symphony.com/agent/v5/datafeeds/{datafeedId}/read

Path parameters

datafeedId*string

ID of the datafeed

Header parameters

Body

application/json

ackId received from last POST Base64 encoded.

ackIdstring

A unique id for events that can be deleted from a client's. Empty for the first read. If set to null or missing, it will be considered empty feed.

updatePresenceboolean

Set to false to avoid updating the user's presence when reading events. Default is true.

Response

200400401403500

Datafeed successfully read.

Body

application/json

eventsarray of V4Event (object)

ackIdstring

The ackId which acknowledges that the current batch of messages have been successfully received by the client

Request

JavaScriptCurl

const response = await fetch('youragentURL.symphony.com/agent/v5/datafeeds/{datafeedId}/read', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "events": [
    {
      "id": "text",
      "messageId": "text",
      "type": "text",
      "diagnostic": "text",
      "initiator": {
        "user": {
          "firstName": "text",
          "lastName": "text",
          "displayName": "text",
          "email": "text",
          "username": "text"
        }
      },
      "payload": {
        "messageSent": {
          "message": {
            "messageId": "text",
            "parentMessageId": "text",
            "message": "text",
            "data": "text",
            "attachments": [
              {
                "id": "text",
                "name": "text",
                "images": [
                  {
                    "id": "text",
                    "dimension": "text"
                  }
                ]
              }
            ],
            "user": {
              "firstName": "text",
              "lastName": "text",
              "displayName": "text",
              "email": "text",
              "username": "text"
            },
            "stream": {
              "streamId": "text",
              "streamType": "text",
              "roomName": "text",
              "members": [
                {
                  "firstName": "text",
                  "lastName": "text",
                  "displayName": "text",
                  "email": "text",
                  "username": "text"
                }
              ],
              "external": false,
              "crossPod": false
            },
            "externalRecipients": false,
            "diagnostic": "text",
            "userAgent": "text",
            "originalFormat": "text",
            "disclaimer": "text",
            "sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
            "replacing": "text",
            "replacedBy": "text",
            "initialMessageId": "text",
            "silent": false
          }
        },
        "sharedPost": {
          "message": {
            "messageId": "text",
            "parentMessageId": "text",
            "message": "text",
            "data": "text",
            "attachments": [
              {
                "id": "text",
                "name": "text",
                "images": [
                  {
                    "id": "text",
                    "dimension": "text"
                  }
                ]
              }
            ],
            "user": {
              "firstName": "text",
              "lastName": "text",
              "displayName": "text",
              "email": "text",
              "username": "text"
            },
            "stream": {
              "streamId": "text",
              "streamType": "text",
              "roomName": "text",
              "members": [
                {
                  "firstName": "text",
                  "lastName": "text",
                  "displayName": "text",
                  "email": "text",
                  "username": "text"
                }
              ],
              "external": false,
              "crossPod": false
            },
            "externalRecipients": false,
            "diagnostic": "text",
            "userAgent": "text",
            "originalFormat": "text",
            "disclaimer": "text",
            "sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
            "replacing": "text",
            "replacedBy": "text",
            "initialMessageId": "text",
            "silent": false
          },
          "sharedMessage": {
            "messageId": "text",
            "parentMessageId": "text",
            "message": "text",
            "data": "text",
            "attachments": [
              {
                "id": "text",
                "name": "text",
                "images": [
                  {
                    "id": "text",
                    "dimension": "text"
                  }
                ]
              }
            ],
            "user": {
              "firstName": "text",
              "lastName": "text",
              "displayName": "text",
              "email": "text",
              "username": "text"
            },
            "stream": {
              "streamId": "text",
              "streamType": "text",
              "roomName": "text",
              "members": [
                {
                  "firstName": "text",
                  "lastName": "text",
                  "displayName": "text",
                  "email": "text",
                  "username": "text"
                }
              ],
              "external": false,
              "crossPod": false
            },
            "externalRecipients": false,
            "diagnostic": "text",
            "userAgent": "text",
            "originalFormat": "text",
            "disclaimer": "text",
            "sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
            "replacing": "text",
            "replacedBy": "text",
            "initialMessageId": "text",
            "silent": false
          }
        },
        "instantMessageCreated": {
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          }
        },
        "roomCreated": {
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          },
          "roomProperties": {
            "name": "text",
            "description": "text",
            "creatorUser": {
              "firstName": "text",
              "lastName": "text",
              "displayName": "text",
              "email": "text",
              "username": "text"
            },
            "external": false,
            "crossPod": false,
            "public": false,
            "copyProtected": false,
            "readOnly": false,
            "discoverable": false,
            "membersCanInvite": false,
            "keywords": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "canViewHistory": false
          }
        },
        "roomUpdated": {
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          },
          "newRoomProperties": {
            "name": "text",
            "description": "text",
            "creatorUser": {
              "firstName": "text",
              "lastName": "text",
              "displayName": "text",
              "email": "text",
              "username": "text"
            },
            "external": false,
            "crossPod": false,
            "public": false,
            "copyProtected": false,
            "readOnly": false,
            "discoverable": false,
            "membersCanInvite": false,
            "keywords": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "canViewHistory": false
          }
        },
        "roomDeactivated": {
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          }
        },
        "roomReactivated": {
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          }
        },
        "userJoinedRoom": {
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          },
          "affectedUser": {
            "firstName": "text",
            "lastName": "text",
            "displayName": "text",
            "email": "text",
            "username": "text"
          }
        },
        "userLeftRoom": {
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          },
          "affectedUser": {
            "firstName": "text",
            "lastName": "text",
            "displayName": "text",
            "email": "text",
            "username": "text"
          }
        },
        "roomMemberPromotedToOwner": {
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          },
          "affectedUser": {
            "firstName": "text",
            "lastName": "text",
            "displayName": "text",
            "email": "text",
            "username": "text"
          }
        },
        "roomMemberDemotedFromOwner": {
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          },
          "affectedUser": {
            "firstName": "text",
            "lastName": "text",
            "displayName": "text",
            "email": "text",
            "username": "text"
          }
        },
        "connectionRequested": {
          "toUser": {
            "firstName": "text",
            "lastName": "text",
            "displayName": "text",
            "email": "text",
            "username": "text"
          }
        },
        "connectionAccepted": {
          "fromUser": {
            "firstName": "text",
            "lastName": "text",
            "displayName": "text",
            "email": "text",
            "username": "text"
          }
        },
        "messageSuppressed": {
          "messageId": "text",
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          }
        },
        "symphonyElementsAction": {
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          },
          "formMessageId": "text",
          "formId": "text"
        },
        "userRequestedToJoinRoom": {
          "stream": {
            "streamId": "text",
            "streamType": "text",
            "roomName": "text",
            "members": [
              {
                "firstName": "text",
                "lastName": "text",
                "displayName": "text",
                "email": "text",
                "username": "text"
              }
            ],
            "external": false,
            "crossPod": false
          },
          "affectedUsers": [
            {
              "firstName": "text",
              "lastName": "text",
              "displayName": "text",
              "email": "text",
              "username": "text"
            }
          ]
        }
      }
    }
  ],
  "ackId": "text"
}

📘 ackId

The ackId sent as a parameter can be empty in the first call. In the response, an ackId will be sent back and it can be used for the next call. This way, you acknowledge that you have received the events that came with that ackId and that the datafeed will remove the events associated with that ackId from your queue.