Read Datafeed 1

(Deprecated - Datafeed v1 will be fully replaced by the datafeed 2 service in the future. Please consider migrating over to datafeed 2 APIs /agent/v5/datafeeds/{id}/read. For more information on the timeline as well as on the benefits of datafeed 2, please reach out to your Technical Account Manager or to our developer documentation https://docs.developers.symphony.com/building-bots-on-symphony/datafeed) Read a given datafeed.

Read messages from the given datafeed. If no more messages are available then this method will block. It is intended that the client should re-call this method as soon as it has processed the messages received in the previous call. If the client is able to consume messages more quickly than they become available then each call will initially block, there is no need to delay before re-calling this method.

A datafeed will expire if its unread capacity is reached. A datafeed can only be consumed by one client thread at a time. E.g. polling the datafeed by two threads may lead to messages being delivered out of order.

GETyouragentURL.symphony.com/agent/v4/datafeed/{id}/read

Path parameters

id*string

Datafeed ID

Query parameters

Header parameters

Response

List of messages that have occurred since last time this URL was polled. If the list is empty, it means the request has reached its timeout, and the client should poll again.

Headers

Body

idstring

Event ID

messageIdstring

Message ID

timestampinteger (int64)

Timestamp of event

typestring

Event type, possible events are:

MESSAGESENT
SHAREDPOST
INSTANTMESSAGECREATED
ROOMCREATED
ROOMUPDATED
ROOMDEACTIVATED
ROOMREACTIVATED
USERJOINEDROOM
USERLEFTROOM
ROOMMEMBERPROMOTEDTOOWNER
ROOMMEMBERDEMOTEDFROMOWNER
CONNECTIONREQUESTED
CONNECTIONACCEPTED
MESSAGESUPPRESSED
SYMPHONYELEMENTSACTION
USERREQUESTEDTOJOINROOM

diagnosticstring

Details if event failed to parse for any reason. The contents of this field may not be useful, depending on the nature of the error. Only present when error occurs.

initiatorV4Initiator (object)

payloadV4Payload (object)

Request

Response

Last updated 12 months ago

(Deprecated - Datafeed v1 will be fully replaced by the datafeed 2 service in the future. Please consider migrating over to datafeed 2 APIs /agent/v5/datafeeds/{id}/read. For more information on the timeline as well as on the benefits of datafeed 2, please reach out to your Technical Account Manager or to our developer documentation https://docs.developers.symphony.com/building-bots-on-symphony/datafeed) Read a given datafeed.

GETyouragentURL.symphony.com/agent/v4/datafeed/{id}/read

[ { "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" } ] } } } ]