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.
get
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.
Path parameters
idstringRequired
Datafeed ID
Query parameters
limitintegerOptional
Max No. of messages to return.
Header parameters
sessionTokenstringRequired
Session authentication token.
keyManagerTokenstringRequired
Key Manager authentication token.
Responses
200
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.
application/json
204
No Messages.
400
Client error, see response body for further details.
application/json
401
Unauthorized: Session tokens invalid.
application/json
403
Forbidden: Caller lacks necessary entitlement.
application/json
500
Server error, see response body for further details.
application/json
get
GET /agent/v4/datafeed/{id}/read HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
keyManagerToken: text
Accept: */*
[
{
"id": "text",
"messageId": "text",
"timestamp": 1,
"type": "text",
"diagnostic": "text",
"initiator": {
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
},
"payload": {
"messageSent": {
"message": {
"messageId": "text",
"parentMessageId": "text",
"timestamp": 1,
"message": "text",
"sharedMessage": {
"messageId": "text",
"parentMessageId": "text",
"timestamp": 1,
"message": "text",
"sharedMessage": "[Circular Reference]",
"data": "text",
"attachments": [
{
"id": "text",
"name": "text",
"size": 1,
"images": [
{
"id": "text",
"dimension": "text"
}
]
}
],
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"externalRecipients": true,
"diagnostic": "text",
"userAgent": "text",
"originalFormat": "text",
"disclaimer": "text",
"sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
"replacing": "text",
"replacedBy": "text",
"initialTimestamp": 1,
"initialMessageId": "text",
"silent": true
},
"data": "text",
"attachments": [
{
"id": "text",
"name": "text",
"size": 1,
"images": [
{
"id": "text",
"dimension": "text"
}
]
}
],
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"externalRecipients": true,
"diagnostic": "text",
"userAgent": "text",
"originalFormat": "text",
"disclaimer": "text",
"sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
"replacing": "text",
"replacedBy": "text",
"initialTimestamp": 1,
"initialMessageId": "text",
"silent": true
}
},
"sharedPost": {
"message": {
"messageId": "text",
"parentMessageId": "text",
"timestamp": 1,
"message": "text",
"sharedMessage": {
"messageId": "text",
"parentMessageId": "text",
"timestamp": 1,
"message": "text",
"sharedMessage": "[Circular Reference]",
"data": "text",
"attachments": [
{
"id": "text",
"name": "text",
"size": 1,
"images": [
{
"id": "text",
"dimension": "text"
}
]
}
],
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"externalRecipients": true,
"diagnostic": "text",
"userAgent": "text",
"originalFormat": "text",
"disclaimer": "text",
"sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
"replacing": "text",
"replacedBy": "text",
"initialTimestamp": 1,
"initialMessageId": "text",
"silent": true
},
"data": "text",
"attachments": [
{
"id": "text",
"name": "text",
"size": 1,
"images": [
{
"id": "text",
"dimension": "text"
}
]
}
],
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"externalRecipients": true,
"diagnostic": "text",
"userAgent": "text",
"originalFormat": "text",
"disclaimer": "text",
"sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
"replacing": "text",
"replacedBy": "text",
"initialTimestamp": 1,
"initialMessageId": "text",
"silent": true
},
"sharedMessage": {
"messageId": "text",
"parentMessageId": "text",
"timestamp": 1,
"message": "text",
"sharedMessage": {
"messageId": "text",
"parentMessageId": "text",
"timestamp": 1,
"message": "text",
"sharedMessage": "[Circular Reference]",
"data": "text",
"attachments": [
{
"id": "text",
"name": "text",
"size": 1,
"images": [
{
"id": "text",
"dimension": "text"
}
]
}
],
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"externalRecipients": true,
"diagnostic": "text",
"userAgent": "text",
"originalFormat": "text",
"disclaimer": "text",
"sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
"replacing": "text",
"replacedBy": "text",
"initialTimestamp": 1,
"initialMessageId": "text",
"silent": true
},
"data": "text",
"attachments": [
{
"id": "text",
"name": "text",
"size": 1,
"images": [
{
"id": "text",
"dimension": "text"
}
]
}
],
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"externalRecipients": true,
"diagnostic": "text",
"userAgent": "text",
"originalFormat": "text",
"disclaimer": "text",
"sid": "fa691cd3-484a-4109-aeb2-57c05b78c95b",
"replacing": "text",
"replacedBy": "text",
"initialTimestamp": 1,
"initialMessageId": "text",
"silent": true
}
},
"instantMessageCreated": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
}
},
"roomCreated": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"roomProperties": {
"name": "text",
"description": "text",
"creatorUser": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"createdDate": 1,
"external": true,
"crossPod": true,
"public": true,
"copyProtected": true,
"readOnly": true,
"discoverable": true,
"membersCanInvite": true,
"keywords": [
{
"key": "text",
"value": "text"
}
],
"canViewHistory": true
}
},
"roomUpdated": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"newRoomProperties": {
"name": "text",
"description": "text",
"creatorUser": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"createdDate": 1,
"external": true,
"crossPod": true,
"public": true,
"copyProtected": true,
"readOnly": true,
"discoverable": true,
"membersCanInvite": true,
"keywords": [
{
"key": "text",
"value": "text"
}
],
"canViewHistory": true
}
},
"roomDeactivated": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
}
},
"roomReactivated": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
}
},
"userJoinedRoom": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"affectedUser": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
},
"userLeftRoom": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"affectedUser": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
},
"roomMemberPromotedToOwner": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"affectedUser": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
},
"roomMemberDemotedFromOwner": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"affectedUser": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
},
"connectionRequested": {
"toUser": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
},
"connectionAccepted": {
"fromUser": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
},
"messageSuppressed": {
"messageId": "text",
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
}
},
"symphonyElementsAction": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"formMessageId": "text",
"formId": "text",
"formValues": {}
},
"userRequestedToJoinRoom": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
],
"external": true,
"crossPod": true
},
"affectedUsers": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
}
}
}
]Last updated
Was this helpful?