Перейти к содержанию

Экспорт по фильтру

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

Запрос

POST /api/v1/dialogs/export

Тело запроса (body)

JSON
1
2
3
4
5
6
7
8
9
{
    "agentStageId": "string",
    "startFromDate": "string",
    "startToDate": "string",
    "latestMessageFromDate": "string",
    "latestMessageToDate": "string",
    "status": "string",
    "channelId": "string"
}

Свойства

Имя параметра Тип Описание Дополнительно
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). Опционально

Авторизация

Запрос обязательно должен использовать один из следующих методов авторизации: X-Token.

Пример запроса

Bash
1
2
3
4
5
6
7
8
curl --location 'https://client.elma-bot.ai/api/v1/dialogs/export' \
--header 'X-Token: 73802c1e-33bd-4b54-b491-1dc496d58add' \
--header 'Content-Type: application/json' \
--data '{
    "agentStageId": "642985a04823815ca247070a",
    "status": "Active",
    "channelId": "Telegram"
}'

Пример ответа

JSON
1
2
3
{
    "requestId": "6185d9f4-7a63-461f-bdaa-eb893de9c821"
}

Содержит идентификатор запроса на экспорт истории диалога. Статус запроса можно проверить, используя метод conversationExportStatus, идентификатор запроса требуется передать в качестве параметра.