Поиск бесед по фильтру
Метод позволяет получить информацию о беседах, используя параметры фильтрации.
Запрос
GET /api/v2/channels/conversations
Параметры пути (path)
Имя параметра | Тип | Описание | Дополнительно |
---|---|---|---|
agentStageId | string | Идентификатор бота. Чтобы узнать его, перейдите в Настройки бота > API. | Опционально |
startFromDate | string | Дата начала диалога (начало периода). Строка с датой в формате ISO 8601. | Опционально |
startToDate | string | Дата начала диалога (конец периода). Строка с датой в формате ISO 8601. | Опционально |
latestMessageFromDate | string | Дата последнего сообщения (начало периода). Строка с датой в формате ISO 8601. | Опционально |
latestMessageToDate | string | Дата последнего сообщения (конец периода). Строка с датой в формате ISO 8601. | Опционально |
status | string | Статус беседы (Active, Closed, Operator). | Опционально |
channelId | string | Идентификатор канала (directline, telegram, viber, elma365). | Опционально |
pageSize | int | Размер страницы. | Опционально |
pageIndex | int | Индекс страницы. | Опционально |
Авторизация
Запрос обязательно должен использовать один из следующих методов авторизации: X-Token.
Пример запроса
Bash | |
---|---|
Пример ответа
Параметры ответа
Имя параметра | Тип | Описание |
---|---|---|
id | string | Идентификатор беседы. |
channelId | string | Идентификатор канала беседы. |
status | string | Статус беседы. |
messagesCount | int | Количество сообщений в беседе. |
members | object | Информация об участниках беседы. |
startedOn | string | Дата начала беседы. Строка с датой в формате ISO 8601. |
channelData | object | Данные канала беседы. |
latestMessageOn | string | Дата последнего сообщения в беседе. Строка с датой в формате ISO 8601. |
latestMessageDirection | string | Тип последнего сообщения в беседе (входящее или исходящее). |
latestMessageText | string | Текст последнего сообщения в беседе. |
closingStatus | string | Статус закрытия беседы. |
closingReason | string | Причина закрытия беседы. |