Получение списка диалогов
Запрос позволяет получить список диалогов по идентификатору бота, дате создания или обновления. Параметры фильтрации задаются через параметры запроса.
Запросы
Query параметры
| Название | Тип | Обязательный | Описание | Пример |
|---|---|---|---|---|
BotID | integer | Нет | Идентификатор бота | 1446 |
PageNumber | integer | Нет | Номер страницы | 1 |
PageCount | integer | Нет | Количество записей на странице | 20 |
CreatedTo | string | Нет | Окончание периода фильтрации по дате создания диалога. При необходимости можно указать время и часовой пояс. Формат - ISO 8601 | 2023-05-01 |
CreatedFrom | string | Нет | Начало периода фильтрации по дате создания диалога. При необходимости можно указать время и часовой пояс. Формат - ISO 8601 | 2023-05-29 |
UpdatedFrom | string | Нет | Начало периода фильтрации по дате последнего сообщения респондента в диалоге. При необходимости можно указать время и часовой пояс. Формат - ISO 8601 | 2023-05-20 |
UpdatedTo | string | Нет | Окончание периода фильтрации по дате последнего сообщения респондента в диалоге. При необходимости можно указать время и часовой пояс. Формат - ISO 8601 | 2023-05-29 |
Пример запроса
curl --location --request GET 'https://manual.bot.one/api/v2/conversations?BotID=1446&CreatedFrom=2023-05-01&CreatedTo=2023-05-29' \
--header 'Authorization: Basic ZC5keW1icnlsb3ZhQHByvLnRlY2g6Q2F2ZTIwMTY='Ответ
Успешный ответ
200 - Успешное выполнение запроса. В ответе вернется список диалогов.
{
"0": {
"id": "7eea9bb4-0e47-441b-ad39-0b7715a6978f",
"name": "#319 Perm",
"status": "in-process",
"ip": "92.255.128.210",
"location": "Perm",
"updated": "",
"duration": 935037,
"source": "web"
},
"1": {
"id": "2368bb59-59e9-467d-91a5-44fdaba94f30",
"name": "#318 Meppel",
"status": "completed",
"ip": "37.1.220.250",
"location": "Meppel",
"updated": "2023-05-11T08:25:26+00:00",
"duration": 13,
"source": "web"
},
"meta": {
"pagination": {
"total": 9,
"count": 9,
"per_page": 40,
"current_page": 1,
"total_pages": 1,
"links": {}
}
}
}Параметры ответа
| Название | Описание |
|---|---|
id | Идентификатор диалога |
name | Название диалога (норма диалога + город, из которого начат) |
status | Статус диалога |
ip | IP-адрес пользователя, который начал диалог |
location | Город, из которого начат |
updated | Дата и время публикации последнего сообщения в диалоге в формате ISO |
duration | Длительность диалога в секундах |
source | Cервис, гдe был начат диалог |
Коды ошибок
| Код ошибки | Наименование | Описание |
|---|---|---|
400 | Bad Request | Убедитесь, что все параметры запроса имеют нужный формат |
401 | Unauthorized | Проверьте логин и пароль для авторизации в системе |
403 | Forbidden | Проблема с подключением к инстансу или диалогу. Это может быть связано с невалидным токеном, блокировкой инстанса, остановкой сервиса, удалением или завершением диалога и пр. |