Вернуться в Bot.one

Получение списка диалогов

GET /v1/conversations

Запрос позволяет получить список диалогов по идентификатору бота, дате создания или обновления. Параметры фильтрации задаются через параметры запроса.

Запрос

Query параметры

НазваниеТипОбязательныйОписаниеПример
BotIDintegerНетИдентификатор бота123
PageNumberintegerНетНомер страницы1
PageCountintegerНетКоличество записей на странице20
CreatedTostringНетОкончание периода фильтрации по дате создания диалога. При необходимости можно указать время и часовой пояс. Формат - ISO 86012022-09-14
CreatedFromstringНетНачало периода фильтрации по дате создания диалога. При необходимости можно указать время и часовой пояс. Формат - ISO 86012022-09-14
UpdatedFromstringНетНачало периода фильтрации по дате последнего сообщения респондента в диалоге. При необходимости можно указать время и часовой пояс. Формат - ISO 86012022-09-14
UpdatedTostringНетОкончание периода фильтрации по дате последнего сообщения респондента в диалоге. При необходимости можно указать время и часовой пояс. Формат - ISO 86012022-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Статус диалога
ipIP-адрес пользователя, который начал диалог
locationГород, из которого начат
updatedДата и время публикации последнего сообщения в диалоге в формате ISO
durationДлительность диалога в секундах
Коды ошибок
Код ошибкиНаименованиеОписание
400Bad RequestУбедитесь, что все параметры запроса имеют нужный формат
401UnauthorizedПроверьте логин и пароль для авторизации в системе
403ForbiddenПроблема с подключением к инстансу или диалогу. Это может быть связано с невалидным токеном, блокировкой инстанса, остановкой сервиса, удалением или завершением диалога и пр.