fetch filtered messages for the customer

fetch filtered messages for the customer

Path Parameters

departmentUUID string required
userUUID string required
customerUUID string required

application/json

Request Body required

filtersToBeSearchedUpon object
property name* object
maximumNoOfResultsToBeReturned int32
messageUuidsReceivedAtSameTime string[]
lastMessageReceivedOn date-time

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

messagesMap object
property name* object[]
Array [
id int64
uuid string
messageType string
protocol string
fromName string
fromNumber string
toName string
toNumber string
messageSize int32
sentOn date-time
receivedOn date-time
tags string
emailMessageId string
communicationUid string
messagePurpose string
deliveryStatus string
dealerDepartmentUuid string
twilioDeliveryFailureMessage string
numberofMessageAttachments int32
isManual boolean
customerUuid string
customerName string
dealerUuid string
dealerAssociateUuid string
isRead boolean
isArchive boolean
messageExtnDTO object
messageUuid string
messageBody string
subject string
draftMessageMetaDataDTO object
messageUuid string
status string
scheduledOn date-time
reasonForLastFailure string
addSignature boolean
messageMetaDataDTO object
messageUuid string
metaData string
docFiles object[]
Array [
docFileName string
fileExtension string
mimeType string
originalFileName string
docSize string
thumbnailFileName string
mediaPreviewURL string
messageUuid string
]
messagePredictionDTOSet object[]
Array [
messageUuid string
predictionFeature object
id int64
predictionFeature string
prediction string
metadata string
messagePredictionFeedback object[]
Array [
messagePredictionID int64
userFeedback string
feedbackReason string
userUUID string
departmentUUID string
]
]
messageTags object
tagTypes object[]
Array [
uuid string
dealerUuid string
name string
displayName string
description string
dataType string
Possible values: [BOOLEAN, STRING, NUMBER]
iconResourceId string
rank string
parentTagTypeUuids string[]
apiPaths object
searchTags string
getTagDetails string
uiFilteringAllowed boolean
uiStyle string
]
tags object[]
Array [
tagTypeUuid string
referenceIdentifier string
value object
primaryAttribute object
value string
secondaryAttributes object[]
Array [
value string
]
parentTags object[]
Array [
tagTypeUuid string
referenceIdentifier string
]
]
]
requestUuid string
errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "messagesMap": {},
  "requestUuid": "string",
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

POST /departments/:departmentUUID/users/:userUUID/customers/:customerUUID/messages/filter

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/communications

Username

Password

departmentUUID — path required

userUUID — path required

customerUUID — path required

Body required

{
  "filtersToBeSearchedUpon": {},
  "maximumNoOfResultsToBeReturned": 0,
  "messageUuidsReceivedAtSameTime": [
    "string"
  ],
  "lastMessageReceivedOn": "2025-03-28T11:34:43.228Z"
}

curl / cURL

curl -L -X POST '/communications/departments/:departmentUUID/users/:userUUID/customers/:customerUUID/messages/filter' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "filtersToBeSearchedUpon": {},
  "maximumNoOfResultsToBeReturned": 0,
  "messageUuidsReceivedAtSameTime": [
    "string"
  ],
  "lastMessageReceivedOn": "2025-03-28T11:34:43.228Z"
}'

python / requests

curl -L -X POST '/communications/departments/:departmentUUID/users/:userUUID/customers/:customerUUID/messages/filter' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "filtersToBeSearchedUpon": {},
  "maximumNoOfResultsToBeReturned": 0,
  "messageUuidsReceivedAtSameTime": [
    "string"
  ],
  "lastMessageReceivedOn": "2025-03-28T11:34:43.228Z"
}'

go / native

curl -L -X POST '/communications/departments/:departmentUUID/users/:userUUID/customers/:customerUUID/messages/filter' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "filtersToBeSearchedUpon": {},
  "maximumNoOfResultsToBeReturned": 0,
  "messageUuidsReceivedAtSameTime": [
    "string"
  ],
  "lastMessageReceivedOn": "2025-03-28T11:34:43.228Z"
}'

nodejs / axios

curl -L -X POST '/communications/departments/:departmentUUID/users/:userUUID/customers/:customerUUID/messages/filter' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "filtersToBeSearchedUpon": {},
  "maximumNoOfResultsToBeReturned": 0,
  "messageUuidsReceivedAtSameTime": [
    "string"
  ],
  "lastMessageReceivedOn": "2025-03-28T11:34:43.228Z"
}'

ruby / Net::HTTP

curl -L -X POST '/communications/departments/:departmentUUID/users/:userUUID/customers/:customerUUID/messages/filter' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "filtersToBeSearchedUpon": {},
  "maximumNoOfResultsToBeReturned": 0,
  "messageUuidsReceivedAtSameTime": [
    "string"
  ],
  "lastMessageReceivedOn": "2025-03-28T11:34:43.228Z"
}'

csharp / RestSharp

curl -L -X POST '/communications/departments/:departmentUUID/users/:userUUID/customers/:customerUUID/messages/filter' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "filtersToBeSearchedUpon": {},
  "maximumNoOfResultsToBeReturned": 0,
  "messageUuidsReceivedAtSameTime": [
    "string"
  ],
  "lastMessageReceivedOn": "2025-03-28T11:34:43.228Z"
}'

php / cURL

curl -L -X POST '/communications/departments/:departmentUUID/users/:userUUID/customers/:customerUUID/messages/filter' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "filtersToBeSearchedUpon": {},
  "maximumNoOfResultsToBeReturned": 0,
  "messageUuidsReceivedAtSameTime": [
    "string"
  ],
  "lastMessageReceivedOn": "2025-03-28T11:34:43.228Z"
}'

java / OkHttp

curl -L -X POST '/communications/departments/:departmentUUID/users/:userUUID/customers/:customerUUID/messages/filter' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "filtersToBeSearchedUpon": {},
  "maximumNoOfResultsToBeReturned": 0,
  "messageUuidsReceivedAtSameTime": [
    "string"
  ],
  "lastMessageReceivedOn": "2025-03-28T11:34:43.228Z"
}'

powershell / RestMethod

curl -L -X POST '/communications/departments/:departmentUUID/users/:userUUID/customers/:customerUUID/messages/filter' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "filtersToBeSearchedUpon": {},
  "maximumNoOfResultsToBeReturned": 0,
  "messageUuidsReceivedAtSameTime": [
    "string"
  ],
  "lastMessageReceivedOn": "2025-03-28T11:34:43.228Z"
}'