Справочник API

Лиды

Получить все лиды для чат-флоу

HTTP

GET /leads/{id}Возвращает все лиды, связанные с указанным агентами.

Авторизация

string required

bearerAuth JWT-токен

Параметры пути

string required

id (string) — ID агента

Коды ответов:

200 — успешная операция (массив объектов)
400 — некорректный ID
404 — лиды не найдены
500 — внутренняя ошибка сервера

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

[
  {
    "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "chatflowid": "7c4e8b7a-7b9a-4b4d-9f3e-2d28f1ebea02",
    "chatId": "d7b0b5d8-85e6-4f2a-9c1f-9d9a0e2ebf6b",
    "createdDate": "2024-08-24T14:15:22Z"
  }
]

Создать лид в агенте

HTTP

POST /leads Создаёт новый лид, связанный с конкретным агентом.

Авторизация

string required

bearerAuth JWT-токен

Тело запроса (application/json)

id (string · uuid) — уникальный идентификатор лидаname (string) — имя лидаemail (string) — email лидаphone (string) — телефон лидаchatflowid (string) — ID агента, с которым связан лидchatId (string) — ID чата/сессии, с которым связан лидcreatedDate (string · date-time) — дата и время создания

Коды ответов:

200 — лид успешно создан
400 — некорректное тело запроса
422 — ошибка валидации
500 — внутренняя ошибка сервера

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

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "chatflowid": "7c4e8b7a-7b9a-4b4d-9f3e-2d28f1ebea02",
  "chatId": "d7b0b5d8-85e6-4f2a-9c1f-9d9a0e2ebf6b",
  "createdDate": "2024-08-24T14:15:22Z"
}

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

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "chatflowid": "7c4e8b7a-7b9a-4b4d-9f3e-2d28f1ebea02",
  "chatId": "d7b0b5d8-85e6-4f2a-9c1f-9d9a0e2ebf6b",
  "createdDate": "2024-08-24T14:15:22Z"
}

Обратная связь

Пинг