...
Authorization: Bearer Token (Метод для получения токена по логину и паролю)
URL: https://analyse.twin24.ai/analyse/api/v1/statistics/chat/sessions
Блок кода | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
https://analyse.twin24.ai/analyse/api/v1/statistics/chat/sessions?withoutCount=false&withoutItems=false&limit=1000&page=0&from=2023-10-31T00%3A00%3A00%2B00%3A00&to=2023-11-01T00%3A00%3A00%2B00%3A00&chatId=bce7d22e-dde6-4427-b391-ebbdfda44de6&messengerType=WHATSAPP&keyword=74992868344 |
Описание параметров метода:
Параметр | Обязательно | Значение по умолчанию | Описание |
---|---|---|---|
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Для WhatsApp - WHATSAPP |
keyword | Нет | Отсутствует | Фильтр по значению в любом из полей:session name, clientId, whatsapp number, telegram client Id
|
Примечание |
---|
Из-за особенностей рассылки первое сообщение клиента и первое сообщение бота перепутаны местами. Следующие сообщения будут идти в нужном порядке. При входящих обращениях также будет правильный порядок сообщений. |
...
Блок кода | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "count": 1, "items": [ { "id": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "dialogLink": "https://tcl.twin24twin24.ai/#app/dialogschats/bce7d22e-dde6-4427-b391-ebbdfda44de6/dialogs?name=dialogName&sessionId=bce7d22e-dde6-4427-b391-ebbdfda44de6", "name": "dialogName", "chatId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "chatName": "Имя Чата", "markedAsSpam": "Нет", "operatorId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "operatorName": "Имя оператора", "operatorAssignedAt": null, "previousOperators": [], "firstOperatorName": null, "firstOperatorAssignedAt": null, "previousOperatorsAsString": null, "botName": "Имя Бота", "clientId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "clientExternalId": null, "clientIp": null, "userAgent": null, "messengerType": "WHATSAPP", "status": "INACTIVE", "startedAt": "2023-10-31 01:00:40", "closedAt": "2023-10-31 11:01:00", "operatorFirstMessageCreatedAt": null, "operatorLastMessageCreatedAt": null, "botLastMessageCreatedAt": "2023-10-31 01:00:40", "lastMessageCreatedAt": "2023-10-31 01:00:40", "clientLastMessageCreatedAt": "2023-10-31 01:00:40", "clientOnlineAt": null, "clientOfflineAt": null, "referer": "", "price": "0.000000", "messages": [ { "id": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "authorId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "authorName": null, "authorType": "CLIENT", "type": "REGULAR", "price": "0.000000", "body": "Ответ Клиента", "attachments": [], "answers": [], "createdAt": "2023-10-31 01:00:40" }, { "id": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "authorId": "bce7d22e-dde6-4427-b391-ebbdfda44de6", "authorName": "Имя Чата", "authorType": "BOT", "type": "REGULAR", "price": "0.000000", "body": "Вопрос Бота", "attachments": [], "answers": [ "Вариант ответа 1", "Вариант ответа 2", "Вариант ответа 3" ], "createdAt": "2023-10-31 01:00:40" } ], "messagesAsString": "CLIENT: Ответ Клиента\nBOT: Вопрос Бота\n", "operatorMessageCount": 0, "botMessageCount": 1, "clientMessageCount": 1, "messageCount": 2, "dialogResultsFromBot": "текст подтверждения", "dialogResultsFromBotJson": { "nps": "текст nps", "confirmation": "текст подтверждения", "Var": "значение произвольного результата", "markers": [ "1", "2" ], "initialVariables": [] }, "dialogResultsFromOperator": "", "nps": "текст nps", "csi": "", "fcr": "", "whatsappPhone": "74992868344", "markers": "1,2", "rating": null, "closedBy": null, "timerFirstAnswer": 0, "timerNextAnswers": 0, "operatorFirstAnswer": 0, "operatorNextAnswers": 0 } ] } |
...
Поле | Тип | Описание | |
---|---|---|---|
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Не актуально для WhatsApp | IP клиента | |
| userAgent | StringНе актуально для WhatsApp | User Agent браузера клиента | |
| messengerType | String | Тип мессенджера | |
| status | String | Статус чат-сессии | |
| startedAt | String | Дата начала чат-сессии | |
| closedAt | String | Дата закрытия чат-сессии | |
| operatorFirstMessageCreatedAt | String | Дата первого сообщения оператора | |
| operatorLastMessageCreatedAt | String | Дата последнего сообщения оператора | |
| botLastMessageCreatedAt | StringString | Дата последнего сообщения бота | |
| lastMessageCreatedAt | StringString | Дата последнего сообщения | |
| clientLastMessageCreatedAt | StringString | Дата последнего сообщения клиента | |
| clientOnlineAt | StringНе актуально для WhatsApp | Дата и время, когда клиент был online | |
| clientOfflineAt | String | String | Дата и время, когда клиент был offlineНе актуально для WhatsApp |
| referer | String | String | Значение заголовка referer на странице, с которой пришел клиентНе актуально для WhatsApp |
| price | StringString | Стоимость всех сообщений чат сессии | |
| messages | ArrayArray[Object] | Массив сообщений | |
| | id | StringString | Идентификатор сообщения | |
| | authorId | StringString | Идентификатор автора сообщения | |
| | 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 | Таймер последующих ответов оператора |
...