Read Datafeed 1
Last updated
Was this helpful?
Last updated
Was this helpful?
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.
/v4/datafeed/{id}/read
Datafeed ID
Max No. of messages to return.
Session authentication token.
Key Manager authentication token.
curl -L \
--url 'youragentURL.symphony.com/agent/v4/datafeed/{id}/read' \
--header 'sessionToken: text' \
--header 'keyManagerToken: text'[
{
"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",
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"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,
"attachments": []
},
"data": "text",
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"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,
"attachments": []
}
},
"sharedPost": {
"message": {
"messageId": "text",
"parentMessageId": "text",
"timestamp": 1,
"message": "text",
"sharedMessage": {
"messageId": "text",
"parentMessageId": "text",
"timestamp": 1,
"message": "text",
"sharedMessage": "[Circular Reference]",
"data": "text",
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"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,
"attachments": []
},
"data": "text",
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"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,
"attachments": []
},
"sharedMessage": {
"messageId": "text",
"parentMessageId": "text",
"timestamp": 1,
"message": "text",
"sharedMessage": {
"messageId": "text",
"parentMessageId": "text",
"timestamp": 1,
"message": "text",
"sharedMessage": "[Circular Reference]",
"data": "text",
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"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,
"attachments": []
},
"data": "text",
"user": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
},
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"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,
"attachments": []
}
},
"instantMessageCreated": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
}
},
"roomCreated": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"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,
"canViewHistory": true,
"keywords": []
}
},
"roomUpdated": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"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,
"canViewHistory": true,
"keywords": []
}
},
"roomDeactivated": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
}
},
"roomReactivated": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
}
},
"userJoinedRoom": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"affectedUser": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
},
"userLeftRoom": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"affectedUser": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
},
"roomMemberPromotedToOwner": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"affectedUser": {
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
},
"roomMemberDemotedFromOwner": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"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",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
}
},
"symphonyElementsAction": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"formMessageId": "text",
"formId": "text",
"formValues": {}
},
"userRequestedToJoinRoom": {
"stream": {
"streamId": "text",
"streamType": "text",
"roomName": "text",
"external": true,
"crossPod": true,
"members": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
},
"affectedUsers": [
{
"userId": 1,
"firstName": "text",
"lastName": "text",
"displayName": "text",
"email": "text",
"username": "text"
}
]
}
}
}
]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.