Получение списка диалогов
Запрос позволяет получить список диалогов по идентификатору бота, дате создания или обновления. Параметры фильтрации задаются через параметры запроса.
Запрос
Query параметры
| Название | Тип | Обязательный | Описание | Пример |
|---|---|---|---|---|
BotID | integer | Нет | Идентификатор бота | 123 |
PageNumber | integer | Нет | Номер страницы | 1 |
PageCount | integer | Нет | Количество записей на странице | 20 |
CreatedTo | string | Нет | Окончание периода фильтрации по дате создания диалога. При необходимости можно указать время и часовой пояс. Формат - ISO 8601 | 2022-09-14 |
CreatedFrom | string | Нет | Начало периода фильтрации по дате создания диалога. При необходимости можно указать время и часовой пояс. Формат - ISO 8601 | 2022-09-14 |
UpdatedFrom | string | Нет | Начало периода фильтрации по дате последнего сообщения респондента в диалоге. При необходимости можно указать время и часовой пояс. Формат - ISO 8601 | 2022-09-14 |
UpdatedTo | string | Нет | Окончание периода фильтрации по дате последнего сообщения респондента в диалоге. При необходимости можно указать время и часовой пояс. Формат - ISO 8601 | 2022-09-14 |
Пример запроса
curl --location --request GET 'manual.bot.one/api/v1/conversations?UpdatedFrom=2023-05-01&UpdatedTo=2023-05-29&BotID=1446' \
--header 'Authorization: Basic ZC5keW1icnlsb3ZhQHByvLnRlY2g6Q2F2ZTIwMTY='Ответ
Успешный ответ
200 - Успешное выполнение запроса. В ответе вернется список диалогов.
{
"0": {
"id": 341,
"name": "#318 Meppel",
"status": "completed",
"ip": "37.1.220.250",
"location": "Meppel",
"updated": "2023-05-11T08:25:26+00:00",
"duration": 13
},
"1": {
"id": 340,
"name": "#317 Meppel",
"status": "completed",
"ip": "37.1.220.250",
"location": "Meppel",
"updated": "2023-05-11T08:23:54+00:00",
"duration": 6
},
"meta": {
"pagination": {
"total": 7,
"count": 7,
"per_page": 40,
"current_page": 1,
"total_pages": 1,
"links": {}
}
}
}Параметры ответа
| Название | Описание |
|---|---|
id | Идентификатор диалога |
name | Название диалога (норма диалога + город, из которого начат) |
status | Статус диалога |
ip | IP-адрес пользователя, который начал диалог |
location | Город, из которого начат |
updated | Дата и время публикации последнего сообщения в диалоге в формате ISO |
duration | Длительность диалога в секундах |
Коды ошибок
| Код ошибки | Наименование | Описание |
|---|---|---|
400 | Bad Request | Убедитесь, что все параметры запроса имеют нужный формат |
401 | Unauthorized | Проверьте логин и пароль для авторизации в системе |
403 | Forbidden | Проблема с подключением к инстансу или диалогу. Это может быть связано с невалидным токеном, блокировкой инстанса, остановкой сервиса, удалением или завершением диалога и пр. |