Для загрузки или отражения истории сообщений из Sherlock Platform во внешнюю систему может быть необходимо получить сообщения диалога.
Для загрузки сообщений через API Sherlock Platform сначала надо авторизоваться.
Далее необходимо вызвать метод GET контроллера Message https://<sherlock_url>/API/V2/Message/{requestId}?<Параметры> . Полученный ранее токен надо передать в заголовке как Bearer Token.
В качестве параметров в метод передаются различные условия:
pageSize - количество возвращаемых записей
skip - номер записи с которой надо загружать сообщения. 0 - для загрузки с первой записи
messageViewTypeId - режим просмотра сообщений. 0 - все типы сообщений, 1 - только переписка без статусных сообщений.
userProfileId - id канала для фильтрации сообщений. Необходимо, если для клиента есть переписка в нескольких каналах
isIncludeAllForClient - true если включать все сообщения клиента, false - только для текущего диалога
Метод возвращает список сообщений диалога, включая:
[
{
"id": "4c599bd4-0ddc-4a36-8480-a8de9e44d6ba",
"requestId": "385172fe-92c8-4bcc-97c1-719560d31f1d",
"userId": "8675d1af-24e2-4a53-9129-c8a57ca3a4a7",
"clientId": "fba0bbc1-bf04-45a2-97a8-908be4327ba5",
"messageStatusId": 3,
"text": "Оператор подключился к диалогу.",
"messageDirectionId": 2,
"messageCategoryId": 1,
"plannedDate": null,
"sendDate": "2020-06-05T12:55:54.893",
"socialNetworkMessengerId": "e0e90585-2001-46e2-912e-4bbf41a3eb0f",
"externalMessageId": "2179",
"externalAuthorId": "160281458",
"externalRecipientId": "5448685",
"previousMessageDelay": 625805,
"isImportant": false,
"messageUserCategoryId": null,
"actualSendDate": "2020-06-05T12:55:54.893",
"previousMessageDelayType": 4,
"replyToSenderId": null,
"replyToMessageId": null,
"buttonsText": "",
"displayText": null,
"errorCount": 0,
"errorMessage": null,
"parentId": null,
"childMessageCount": 0,
"authorName": "2.2. При передаче оператору",
"processedText": "Оператор подключился к диалогу.",
"userProfileId": "adf68af7-6532-4a06-ae42-5916202407d5",
"messageUserCategoryColor": null,
"photoUrl": "",
"authorInitials": "2П",
"authorBackgroundColor": "#ecd074",
"fileLinks": [{
"id": "a5b0a0a0-2040-4b91-9b05-2a9b396cf783",
"fileId": "fc6aa8f1-eb05-4d9a-a48c-f1bccfd87e57",
"objectId": "4c599bd4-0ddc-4a36-8480-a8de9e44d6ba",
"systemDictionaryId": "35df8dfe-d88a-4992-a4d4-54040166ca25",
"fileName": "face.png",
"physicalName": "9ec73c6b-58bc-472d-926e-c881371f5274.png",
"extension": ".png",
"url": "https://sherlockcrm.ru/API/SherlockTest/v2/Files/a5b0a0a0-2040-4b91-9b05-2a9b396cf783/face.png/Attachment",
"attachmentTypeId": 1
}],
"isBotMessage": false
}
]
Описание данных полей приведено ниже:
id - уникальный ключ сообщения
requestId - уникальный ключ диалога/обращения
userId - автор сообщения (пользователь платформы или бот)
clientId - идентификатор внешнего клиента, который пишет вам в чате или мессенджере
messageStatusId - статус сообщения
1 - Запланирован
2 - Не прочитано
3 - Прочитано
4 - В очереди
5 - Ошибка
6 - Удален
7 - Доставлено
text - текст сообщения
messageDirectionId - направление сообщения
1 - входящее
2 - исходящее
messageCategoryId - категория сообщения
1 - Личное сообщение
2 - Комментарий. Не отражается клиенту
3 - Кнопки
4 - Статус диалога
5 - Сообщение рассылки
6 - Сервисное сообщение
7 - Слайдер
plannedDate - плановая дата сообщения для отложенных сообщений
sendDate - дата постановки в очередь на отправку
socialNetworkMessengerId - идентификатор типа канала. Реальный идентификатор клиента получается через ClientId
externalMessageId - идентификатор сообщения в мессенджере
externalAuthorId - Id автора сообщения в мессенджере. Зависит от направления сообщения. Id клиента для входящего сообщения
externalRecipientId - Id получателя сообщения в мессенджере. Зависит от направления сообщения. Id клиента для исходящего сообщения
isImportant - отметка сообщения в интерфейсе как требующего внимания. Можно фильтрами выбрать все диалоги с такими сообщениями
messageUserCategoryId - назначение идентично предыдущему пункту, но настраиваемый список
actualSendDate - дата когда фактически сообщение принято мессенджером. Может отличаться от SendDate в случае сбоев
previousMessageDelay - используется для статистики. Длительность паузы между текущим и предыдущим сообщениями
previousMessageDelayType - указывает тип предыдущего сообщения от которого считалась задержка
-
1 - первое сообщение
-
2 - ответ клиенту оператором
-
3 - ответ клиента
-
4 - пауза между сообщениями клиента или пользователя
5 - ответ клиенту основным ботом
6 - ответ клиенту другим ботом
-
replyToSenderId - используется при обработке сообщение, отправленных в ответ на другое сообщение
replyToMessageId - используется при обработке сообщение, отправленных в ответ на другое сообщение
buttonsText - может содержать Json с описанием кнопок
displayText - обработанный текст для вывода в браузере. В частности кнопки форматируются для вывода
errorCount - не нулевое в случае, если сообщение не принимается мессенджером. Например, клиент заблокировал получение сообщение
errorMessage - причина ошибки, полученная от мессенджера
parentId - используется в обработке комментариев. Например, комментариев Инстаграм
childMessageCount - используется в обработке комментариев. Например, комментариев Инстаграм
authorName - имя автора сообщения (пользователя или клиента в зависимости от направления
processedText - текст с включенными HTML тегами для отражения в браузере
userProfileId - идентификатор канала в Sherlock
messageUserCategoryColor - RGB цвет для выделения сообщения в диалоге
photoUrl - фото клиента или пользователя/бота в зависимости от направления
authorInitials - инициалы автора для вывода в списке сообщение
authorBackgroundColor - RGB цвет для выделения автора
fileLinks - коллекция ссылок на вложения, включая ссылку для скачивания
isBotMessage - true, если для сообщения бота