Datahose - Read Events

Creates and reads a real time feed of messages & events. The datahose API provides messages and events from all conversations in the pod, even the ones the service user is not part of. The types of events surfaced can be found in the list.

Add-on: The Datahose API is an add-on to the Symphony Services, and is subject to additional charges. Prior to using Datahose in your Symphony environment(s), you will need to enter into a specific contract. Please reach out to to discuss the offering, its pricing or for any further information.

Requirements

The Agent v22.6 (release date: June 2022) is required.

Entitlements

The service account needs to have both the Can read from datahose feeds and Can create datahose feeds entitlements enabled to call this endpoint.

Please contact your Technical Account Manager or Symphony representative to get your chat Bot entitled.

Configuration

The credentials of the Content Export service need to be setup in the Agent configuration for datahose to work.

The value of users.ceservice.status should be "UP", see example below.

{
    "services": {
        "datafeed": {
            "status": "UP",
            "version": "2.11.2"
        },
        "key_manager": {
            "status": "UP",
            "version": "20.16.3"
        },
        "pod": {
            "status": "UP",
            "version": "20.16.74-216-100b3be"
        }
    },
    "status": "UP",
    "users": {
        "agentservice": {
            "authType": "RSA",
            "status": "UP"
        },
        "ceservice": {
            "authType": "RSA",
           
        }
    },
    "version": "23.11.1-716"
}

Using ackId

The ackId must be null or empty for the first call. Then, for subsequent requests, the ackId from the previous payload should be reused to confirm the reading of previous events already retrieved by the bot. Please note that you can very easily access this API via our BDKs in Java and Python.

If a batch of messages is not confirmed by sending the ackId, the messages that are there will be returned in the subsequent readings and may blend into the newer messages.

Fair use policy

Datahose API is subject to a fair use policy of 5 active feeds.

If your integration or workflow requires more than 5 feeds active at the same time, please contact Symphony.

Last updated 1 year ago

Was this helpful?

{ "services": { "datafeed": { "status": "UP", "version": "2.11.2" }, "key_manager": { "status": "UP", "version": "20.16.3" }, "pod": { "status": "UP", "version": "20.16.74-216-100b3be" } }, "status": "UP", "users": { "agentservice": { "authType": "RSA", "status": "UP" }, "ceservice": { "authType": "RSA", } }, "version": "23.11.1-716" }

POST /agent/v5/events/read HTTP/1.1 Host: youragentURL.symphony.com sessionToken: text keyManagerToken: text Content-Type: application/json Accept: */* Content-Length: 94 { "type": "datahose", "tag": "mybotusername", "eventTypes": [ "MESSAGE_SENT" ], "updatePresence": false }

{ "events": [ { "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": "[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, "recipientTenantIds": [ 1 ] }, "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": "[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, "recipientTenantIds": [ 1 ] }, "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": "[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, "recipientTenantIds": [ 1 ] }, "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, "recipientTenantIds": [ 1 ] } }, "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, "recipientTenantIds": [ 1 ] }, "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, "recipientTenantIds": [ 1 ] }, "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, "recipientTenantIds": [ 1 ] } }, "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, "recipientTenantIds": [ 1 ] } }, "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, "recipientTenantIds": [ 1 ] }, "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, "recipientTenantIds": [ 1 ] }, "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, "recipientTenantIds": [ 1 ] }, "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, "recipientTenantIds": [ 1 ] }, "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, "recipientTenantIds": [ 1 ] } }, "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, "recipientTenantIds": [ 1 ] }, "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, "recipientTenantIds": [ 1 ] }, "affectedUsers": [ { "userId": 1, "firstName": "text", "lastName": "text", "displayName": "text", "email": "text", "username": "text" } ] } } } ], "ackId": "text" }

Requirements

Entitlements

Configuration

Using ackId

Fair use policy

Requirements

Entitlements

Configuration

Using ackId

Fair use policy

Creates and Reads a real time feed of messages and events of your pod (Datahose)