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

Поиск бесед по фильтру

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

Запрос

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
1
2
curl --location 'https://client.elma-bot.ai/api/v2/channels/conversations?agentStageId=66260da67603d94758327b5a&status=active&channelId=directline' \
--header 'X-Token: 73802c1e-33bd-4b54-b491-1dc496d58add'

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

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "items": [
    {
      "id": "6749abb0ac3aedaaa2f898b5",
      "channelId": "directline",
      "status": "Active",
      "messagesCount": 4,
      "members": [
        {
          "id": "bot",
          "name": null,
          "nickname": null,
          "role": "Bot"
        },
        {
          "id": "670640fcc929813bba86cb18",
          "name": "user",
          "nickname": null,
          "role": "User"
        }
      ],
      "startedOn": "2024-11-29T11:55:28.4410556+00:00",
      "channelData": null,
      "latestMessageOn": "2024-11-29T11:55:37.4401716+00:00",
      "latestMessageDirection": "Outbound",
      "latestMessageText": "Выберите пункт меню",
      "closingStatus": null,
      "closingReason": null
    }
  ],
  "hasMore": false,
  "pageIndex": 0,
  "pageSize": 10,
  "totalItemCount": 1,
  "totalPageCount": 1,
  "fromItemInclusive": 0,
  "toItemExclusive": 1
}

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

Имя параметра Тип Описание
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 Причина закрытия беседы.