V3 Message Violations
Gets violations as a result of policy enforcement on messages. The message part of this violation is the same as documented in Create Message v4
Retrieves DLP v3 message related violations for a given time range
Query parameters
startTimeinteger · int64Required
Timestamp of the first required violation. This is a long integer value representing milliseconds since Jan 1 1970
endTimeinteger · int64Optional
Timestamp of the last required violation. This is a long integer value representing milliseconds since Jan 1 1970 If unspecified, it will default to current time of the request.
nextstringOptional
Offset of the next chunk of violations. Value is null for the first request.
limitintegerOptional
Max No. of violations to return. If no value is provided, 50 is the default. The maximum supported value is 500.
Header parameters
sessionTokenstringRequired
Session authentication token.
keyManagerTokenstringRequired
Key Manager authentication token.
Responses
application/json
objectOptional
application/json
application/json
application/json
application/json
get
GET /agent/v3/dlp/violations/message?startTime=1 HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
keyManagerToken: text
Accept: */*
{
"violations": [
{
"violation": {
"enforcementEventID": "text",
"entityID": "text",
"createTime": 1,
"lastModified": 1,
"requesterId": 1,
"details": [
{}
],
"action": "text",
"outcome": {
"type": "text"
},
"version": "text",
"ignoreDLPwarning": true
},
"message": {
"messageId": "text",
"parentMessageId": "text",
"timestamp": 1,
"message": "text",
"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
},
"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": {
"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
},
"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
},
"diagnostic": "text"
}
],
"nextOffset": "text"
}
📘 sharedMessageNote that the
sharedMessageattribute is only returned when the message represented by this class is a wall post sharing another message. Please note the payload example withsharedMessageobject included.
🚧 Required PermissionsCalling this endpoint requires the Expression Filter Policy Management role. See Bot Permissions for a list of roles and associated privileges.
Last updated
Was this helpful?