...
Параметр | Обязательно | Значение по умолчанию | Описание |
|---|---|---|---|
withoutCount | Нет | False | Если True, то в ответе не будет общего количества элементов |
withoutItems | Нет | False | Если True, то в ответе не будет подробностей по элементам |
limit | Нет | 10 | Количество элементов в ответе (максимум 1000) |
page | Нет | 0 | Номер "страницы" с элементами (начиная с 0). Например, если в limit указано 1000, а всего элементов 1500, то первая 1000 будет в ответе при page = 0, а остальные 500 при page =1 |
from | Да | Отсутствует | Дата начала промежутка поиска. Задается в формате: 2023-10-31T00:00:00+00:00 ГГГГ-ММ-ДДTчч:мм:сс+чч:мм Обязательно url-encoded |
to | Да | Отсутствует | Дата окончания промежутка поиска. Задается в формате: 2023-10-31T00:00:00+00:00 ГГГГ-ММ-ДДTчч:мм:сс+чч:мм Обязательно url-encoded |
chatId | Нет | Отсутствует | Идентификатор чата |
messengerType | Нет | Отсутствует | Фильтр по типу мессенджера. Возможные значения: WHATSAPP, VIBER, TELEGRAM, VKONTAKTE, FACEBOOK, SKYPE, SLACK, YANDEX, ALICE, THREADS |
keyword | Нет | Отсутствует | Фильтр по значению в любом из полей:
|
output | Нет | Отсутствует | Используется для получения данных в виде файла, а не в JSON теле ответа. Возможные значения:
|
filename | Нет | Отсутствует | Имя файла без расширения. Актуально только при использовании output |
archive | Нет | Отсутствует | Возвращать ли файл в архиве. true/false Актуально только при использовании output |
| Примечание |
|---|
Из-за особенностей рассылки первое сообщение клиента и первое сообщение бота перепутаны местами. Следующие сообщения будут идти в нужном порядке. При входящих обращениях также будет правильный порядок сообщений. |
...
Поле | Тип | Описание |
|---|---|---|
count | Int | Общее количество найденных элементов |
items | Array[Object] | Массив найденных элементов |
| id | String | Идентификатор чат-сессии |
| dialogLink | String | Ссылка на диалог |
| name | String | Имя чат-сессии |
| chatId | String | Идентификатор чата |
| chatName | String | Имя чата |
| markedAsSpam | String | Было ли помечено как спам |
| operatorId | String | Идентификатор оператора |
| operatorName | String | Имя оператора |
| operatorAssignedAt | String | Дата присвоения диалога текущему/последнему оператору |
| previousOperators | Array[String] | Массив предыдущих операторов |
| firstOperatorName | String | Имя первого оператора |
| firstOperatorAssignedAt | String | Дата присвоения диалога первому оператору |
| previousOperatorsAsString | String | Массив предыдущих операторов строкой |
| botName | String | Название сценария |
| clientId | String | Идентификатор клиента (внутренний) |
| clientExternalId | String | Идентификатор клиента (внешний) |
| clientIp | String | IP клиента |
| userAgent | String | User Agent браузера клиента |
| messengerType | String | Тип мессенджера |
| status | String | Статус чат-сессии |
| startedAt | String | Дата начала чат-сессии |
| closedAt | String | Дата закрытия чат-сессии |
| operatorFirstMessageCreatedAt | String | Дата первого сообщения оператора |
| operatorLastMessageCreatedAt | String | Дата последнего сообщения оператора |
| botLastMessageCreatedAt | String | Дата последнего сообщения бота |
| lastMessageCreatedAt | String | Дата последнего сообщения |
| clientLastMessageCreatedAt | String | Дата последнего сообщения клиента |
| clientOnlineAt | String | Дата и время, когда клиент был online |
| clientOfflineAt | String | Дата и время, когда клиент был offline |
| referer | String | Значение заголовка referer на странице, с которой пришел клиент |
| price | String | Стоимость всех сообщений чат сессии |
| messages | Array[Object] | Массив сообщений |
| | id | String | Идентификатор сообщения |
| | authorId | String | Идентификатор автора сообщения |
| | authorName | String | Имя автора сообщения |
| | authorType | String | Тип автора сообщения |
| | type | String | Тип сообщения |
| | price | String | Цена за сообщения |
| | body | String | Текст сообщения |
| | attachments | Array | Вложения в сообщении |
| | answers | Array[String] | Варианты ответа/кнопки в сообщении |
| | createdAt | String | Дата создания сообщения |
| messagesAsString | String | Все сообщения одной строкой |
| operatorMessageCount | Int | Количество сообщений оператора |
| botMessageCount | Int | Количество сообщений бота |
| clientMessageCount | Int | Количество сообщений клиента |
| messageCount | Int | Количество всех сообщений |
| dialogResultsFromBot | String | Значение поля "Подтверждение результата" |
| dialogResultsFromBotJson | Object | Все результаты бота одним объектом |
| | nps | String | Значение поля NPS |
| | confirmation | String | Значение поля "Подтверждение результата" |
| | Var | String | Значение произвольного результата |
| | markers | Array[String] | Массив маркеров в чат-сессии |
| | initialVariables | Array | Стартовые переменные в чат-сессии |
| dialogResultsFromOperator | String | Результат, проставленный оператором |
| nps | String | Значение поля NPS |
| csi | String | Значение csi |
| fcr | String | Значение fcr |
| whatsappPhone | String | Номер телефона клиента в WhatsApp |
| markers | String | Маркеры одной строкой |
| rating | String | Оценка клиента |
| closedBy | String | Кем была закрыта сессия |
| timerFirstAnswer | Int | Таймер первого ответа |
| timerNextAnswers | Int | Таймер последующих ответов |
| operatorFirstAnswer | Int | Таймер первого ответа оператора |
| operatorNextAnswers | Int | Таймер последующих ответов оператора |
...