UA	US	RU

UA	US	RU

API (Application Programming Interface) — это инструмент, который позволяет вашим приложениям, сайтам, CRM "общаться" и обмениваться данными с платформой Leeloo.ai. C помощью API вы можете
получить информацию о ваших клиентах, передать данные о клиентах (офферах) в таблицу, подключить систему онлайн-оплаты или доставки, без сложной и затратной разработки.

1 Введение в использование API
2 Шаблоны сообщений
3 Сообщения
- 3.1 Получить список сообщений из чата по каналу коммуникации
- 3.2 Отправка сообщений
4 Каналы коммуникации
5 LGT
- 5.1 Создать источник траффика в LGT
6 Заказы
7 Подписчики
8 Теги
9 Туннели
10 Пользователи
- 10.1 Получить список пользователей платформы
- 10.2 Получить информацию по конкретному пользователю платформы

Введение в использование API

Заголовок запроса (Headers)

При выполнении запросов к Leeloo.AI вам необходимо использовать Headers, “+Заголовок запроса”
в “Ключ” вставьте X-Leeloo-AuthToken а в “Значение” ваш Leeloo.ai API токен.

Где взять API токен?

API токен можно найти в разделе Leeloo.ai API на платформе Leeloo.ai. Он необходим для аутентификации запросов к API, подтверждая, что запросы исходят от авторизованного пользователя.

Типы запросов

На платформе доступны различные типы запросов, которые можно использовать для интеграции с внешними системами:

GET: для получения данных. Запрашивает информацию с API.
POST: для отправки данных. Отправляет данные (например, регистрация нового пользователя)
PUT: для обновления существующих данных.

Использование переменных и пользовательских полей

Переменные можно создавать в разделе Содержимое → Переменные
Пользовательские поля можно создавать в разделе Содержимое → Поля

Переменные и пользовательские поля можно вставлять в тело запроса (Body), если требуется динамическая передача данных. Например, если нужно передать данные о пользователе или статусе заказа, вставляйте переменные в поля запроса для передачи индивидуальной информации.

Список системных ID (переменных), доступных в платформе:

category_id - id категории шаблонов сообщений
Этот category_id берем из ссылки при открытии категории шаблона в разделе
Туннели продаж, Шаблоны сообщений.
Пример - https://app.leeloo.ai/campaigns-templates/category_id/templates
account_id - id канала связи берем из сылки в карте клиента в раздел Чаты.
Пример - https://app.leeloo.ai/chats/unread/account_id/5e60191da0fd4a000d3998bc/
template_id - id шаблона сообщения на платформе берем из шаблона сообщения созданного в категории шаблонов.
Пример - https://app.leeloo.ai/campaigns-templates/category_id/templates/creator/template_id
person_id - id канала коммуникации берем из ссылки клиента в разделе Чаты.
Пример - https://app.leeloo.ai/chats/all/account_id/person_id
leadgentool_id - id Инструмента Лидогенерации (LGT) берем из туннеля продаж, вашего уже созданного ЛГТ. Нажмите правой кнопкой миши по нему, затем “Скопировать ID LGT”
paymentCreditsId - id платежной системы. Можно узнать в настройках платформы, разделе Платежи нажав “Подробнее” на подключенном платеже
Пример - https://app.leeloo.ai/settings/integrations/payments/credits/payment-credit/manual/paymentCreditsId
offerId - id Предложения берем из созданного вами Оффера (Предложения) разделе Туннеле Продаж.
Пример - https://app.leeloo.ai/campaigns-offers/offerId/offers/1
managerId - id менеджера (Пользователя) которого вы добавили в платформу через раздел Пользователи нажмите на созданного позьвателя и скопируйте id в ссылке.
Пример - https://app.leeloo.ai/settings/company/users/user/managerId
order_id - id заказа тоесть когда ваш оффер перешел в статус заказа. Этот id можно взять выполнив запрос Получить Список Ордеров где в ответе будет иформация про заказ в том числе id заказа.
Пример - "{"data":[{"id":"order_id","person_id":"person_i","title":"Курс9","price":20,"currency":"USD","status":"REJECTED","createdAt":"2024-10-03T08:00:02.853Z","updatedAt":"2024-10-03T15:25:49.028Z"},
user_id - id пользователя (Подписчика) именно аудитории. Получить можно выполнив запрос Получить Список Пользователей Платформы где в ответе будет информация про id пользователя
Пример - "{"data":{"id":"user_id","name":"Andrew","createdAt":"2024-02-21T12:32:55.085Z","updatedAt":"2024-10-07T06:42:52.631Z"},"status":1}"
tunnel_id - id туннеля продаж. Получить можно перейдя в ваш туннель продаж скопировав из адресно строки
Пример - https://app.leeloo.ai/tunnels/tunnel_id/tree
tunnel_block_id - id блока в туннеле продаж. Получить можно перейдя в ваш туннель продаж, нажав на блок, скопировав из адресно строки
Пример - https://app.leeloo.ai/tunnels/tunnel_id/tree/tunnel_block_id
connection_id - id канала связи. Получить можно выполнив запрос на получение информации о пользователях, или конкретном пользователе. Напримере запроса Получить Информацию по Конкретному Человеку
Пример -
{
"account_id": "account_id",
"connection_id": "connection_id",
"connection_status": "OK",
"from": "TELEGRAM"
}
tag_id - id Тега который мы присваиваем пользователям (подписчикам). Получить можно перейдя в Настройки плайтформы, раздел Настройки CRM, Теги нажав “Скопировать ID” правее от созданного Тега.

Во всех запросах дату необходимо указывать с учетом нулевого часового пояса UTC-0
Все запросы которые задействуют Body должны отправляться в JSON формате

Шаблоны сообщений

Получить список категорий шаблонов сообщений

GET https://api.leeloo.ai/api/v2/categories/templates

ВАЖНО: В Headers, “Заголовок запроса” в “Ключ” вставьте X-Leeloo-AuthToken а в “Значение” ваш Leeloo.ai API токен.

Response

"data": {
        "categories": [
            {
                "id": "5e3bf3fdb70492000f72cd6c",
                "name": "Category 1"
            },
            {
                "id": "5e18a2a3ed0b7a000d6c948f",
                "name": "Category 2"
            }
        ]
    },
    "status": 1
}

Получить список шаблонов сообщений внутри категории

GET https://api.leeloo.ai/api/v2/categories/templates/{category_id}

Path Params
category_id (example: 5b3f543bb2737000133d25b0) - id категории шаблонов сообщений
Этот category_id берем из ссылки при открытии категории шаблона в разделе Туннели продаж, Шаблоны сообщений.
Пример: https://app.leeloo.ai/campaigns-templates/categoty_id/templates

ВАЖНО: В Headers, “Заголовок запроса” в “Ключ” вставьте X-Leeloo-AuthToken а в “Значение” ваш Leeloo.ai API токен.

Response

{
    "data": {
        "templates": [
            {
                "id": "5e42be758d4fff000cafe6ef",
                "message_name": "test template 2"
            },
            {
                "id": "5e42be688d4fff000cafe5cc",
                "message_name": "test template 1"
            }
        ]
    },
    "status": 1
}

Отправка шаблона сообщения

POST https://api.leeloo.ai/api/v2/messages/send-template

Request Body(json)
account_id (example: 513f543gb2737020133d25b0) - id канала связи берем из сылки в карте клиента в раздел чаты. Пример: https://app.leeloo.ai/chats/unread/account_id/5e60191da0fd4a000d3998bc/
template_id (example: 6b3f543bb2737003133d25b4) - id шаблона сообщения на платформе

{
  "account_id": "66fac2b853d5123567d207b7",
  "template_id": "65fc3f2656789099e157e817",
  "variables": {
    "key1": "value1",
    "key2": "value2"
  }
}

Response

Сообщения

Получить список сообщений из чата по каналу коммуникации

Запрос

GET https://api.leeloo.ai/api/v2/communication-channels/{person_id}/chat-messages?limit=2&offset=0

Path Params
person_id (example: 5b3f543bb2737000133d25b0) - id канала коммуникации берем из ссылки клиента в разделе Чаты. Пример https://app.leeloo.ai/chats/all/66fac2b853d5470e1ed207b6/person_id

Query Params
limit - ограничение количества результатов (не рекомендуется выгружать большое количество данных сразу, так как это может замедлить выгрузку данных)
offset - сколько результатов пропустить (по умолчанию 0)

Response

Отправка сообщений

POST https://api.leeloo.ai/api/v2/messages/send-message

Request Body(json)
account_id (example: 5b3f543bb2737000133d25b0) - id канала связи
text - текст сообщения которое хотим отправить

Response

Каналы коммуникации

Получить список каналов коммуникации (с внешними UTM-метками)

GET https://api.leeloo.ai/api/v2/communication-channels?limit=20&offset=0&filter[last_message][from]=2020-02-10&filter[last_message][to]=2020-04-14

Query Params
limit - ограничение количества результатов (не рекомендуется выгружать большое количество данных сразу, так как это может замедлить выгрузку данных)
offset - сколько результатов пропустить (по умолчанию 0)
filter[last_message][from] - фильтр по последнему сообщению от указанного числа

filter[last_message][to] - фильтр по последнему сообщению до указанного числа

Response

Получение списка каналов связи

GET https://api.leeloo.ai/api/v2/connections

Response

Получение информации о человеке по каналу коммуникации (получить person_id зная параметр account_id)

GET https://api.leeloo.ai/api/v2/communication-channels/{account_id}/person

Path Params
account_id (example: 5b3f543bb2737000133d25b0) - id канала коммуникации

Response

LGT

Создать источник траффика в LGT

POST https://api.leeloo.ai/api/v2/leadgentools/{leadgentool_id}/create-traffic-source

Path Params
leadgentool_id (example: 5b3f543bb2737000133d25b0) - id инструмента лидогенерации

Request Body (json)
name - имя трафик соурса
description - описание трафик соурса

Response

Заказы

Создать ручной ордер

POST https://api.leeloo.ai/api/v2/orders

Request Body(json)
paymentCreditsId (example: 5b3f543bb2737000133d25b2) - id платежной системы. Можно узнать в настройках платформы, раздел с платежными системами.
email - Email адрес человека
phone - телефон человека
transactionDate - желаемая дата проведения транзакции (для отображения на платформе) указывается в формате 2020-02-04T11:46:48.803Z
offerId (example: 5b3f543bb2737000133d25b0) - id оффера
isNotifyAccount - сообщать человеку о создании заказа или нет (может быть значение true или false)
personId (example: 5b3f543bb2737000133d25b1) - id человека
managerId (example: 5b3f543bb2737000133d25b0) - id юзера платформи за кем будет закреплен заказ. Необязательно. Если не указать конкретного юзера - продажа будет System

Response

Получить список ордеров

GET https://api.leeloo.ai/api/v2/orders?limit=20&offset=0

Query Params
limit - ограничение количества результатов (не рекомендуется выгружать большое количество данных сразу, так как это может замедлить выгрузку данных)
offset - скольок результатов пропустить (по умолчанию 0)

Response

Получить информацию по отдельному ордеру

GET https://api.leeloo.ai/api/v2/orders/{order_id}

Path Params
order_id (example: 5b3f543bb2737000133d25b0) - айди конкретного ордера

Response

Обновить информацию в МАНУАЛ (ручном) ордере

Ордер НЕ МОЖЕТ БЫТЬ с частичными оплатами

POST https://api.leeloo.ai/api/v2/orders/{order_id}

Path Params
order_id (example: 5b3f543bb2737000133d25b0) - айди ручного ордера без частичных оплат.

IMPORTANT: Pass your auth token in 'X-Leeloo-AuthToken' header.

Request Body (form-data)
status example: 'RESOLVED', (one_of: RESOLVED/REJECTED)
paymentDate example: '2018-06-27 07:32',
currency example: 'RUB',
price example: '100' (actual price that you receive from account),
userComments example: 'actual date dont match'

Response

Подписчики

Получить список всех подписчиков

GET https://api.leeloo.ai/api/v2/people?limit=20&offset=100&filter[tags]=vip&filter[tags]=tag2&filter[last_message][from]=2015-04-02&filter[last_message][to]=2015-04-03&filter[phone]=+380966565556&filter[email]=feliks@gmail.com

Query Params
limit - ограничение количества результатов (не рекомендуется выгружать большое количество данных сразу, так как это может замедлить выгрузку данных)
offset - скольок результатов пропустить (по умолчанию 0)
filter[tags] - если необходима фильтрация по тегам. Опционально
filter[last_message] { from: 'js_date', to: 'js_date' } - фильтр по дате последнего сообщния. Обязателен.
filter[phone] - фильтр по номеру телефону. Опционально
filter[email] - фильтр по емейлу. Опционально

Response

Получить информацию по конкретному человеку

GET https://api.leeloo.ai/api/v2/people/{person_id}?include=contactedUsers,orders

Path Params
person_id (example: 5b3f543bb2737000133d25b0) - id человека на платформе

Response

Обновить информацию в карточке клиента

PUT https://api.leeloo.ai/api/v2/people/{person_id}

Path Params
person_id (example: 5b3f543bb2737000133d25b0) - айди человека.

Request Body(json)

Добавить человека на платформе

POST https://api.leeloo.ai/api/v2/people

Request Body (json)

Response

Добавить СМС соединение к человеку

POST https://api.leeloo.ai/api/v2/people/sms

Request Body(json)

Response

Добавить комментарий к человеку

PUT https://api.leeloo.ai/api/v2/people/{person_id}/add-comment

Path Params
person_id (example: 5b3f543bb2737000133d25b0) - id человека

Request Body(json)

Response

Добавить звонок в акаунт

POST https://api.leeloo.ai/api/v2/calls

Request Body(form-data, all required)
user_id example: ‘5b0d313b307879002915b3cc’
from example: ‘606'
to example: ‘607'
date example: ‘2024-03-22T15:30:17.339Z'
account_id example: '6b0d313b307879002915b3c1’
record_link example: 'https://file-examples.com/storage/2017/11/file_example_MP3_5MG.mp3’ or 'NOT_DEFINED’
status example: 'SUCCESS' (one of: 'TALKING', 'SUCCESS', 'NO_ANSWER', 'CLOSED_BY_SYSTEM')
duration example: '100' (seconds)
type example: INBOUND or OUTBOUND

Response

Туннели

Получить список туннелей

GET https://api.leeloo.ai/api/v2/tunnels?limit=20&offset=0

Query Params
limit - ограничение количества результатов (не рекомендуется выгружать большое количество данных сразу, так как это может замедлить выгрузку данных)
offset - сколько результатов пропустить (по умолчанию 0)

Response

Получить информацию про туннель

GET https://api.leeloo.ai/api/v2/tunnels/{tunnel_id}?include=leadgentools

Path Params
tunnel_id (example: 5b3f543bb2737000133d25b0) - id тунеля

Response

Получить статистику по всем туннелям

GET https://api.leeloo.ai/api/v2/tunnels/stats

Response

Получить статистику по одному туннелю

GET https://api.leeloo.ai/api/v2/tunnels/{tunnel_id}/stats

Path Params
tunnel_id (example: 5b3f543bb2737000133d25b0) - id тунеля

Response

Подписка на туннель и блок туннеля

POST https://api.leeloo.ai/api/v2/communication-channels/{account_id}/manual-subscribe

Path Params
account_id - id канала комуникации которого нужно подписать

Request Body (form-data)
tunnel_id (example: 5b3f543bb2737000133d25b0) - id тунеля
tunnel_block_id (example: 5b3f543bb2737000133d25b0) - id блока в тунеле

Response

Пользователи

Получить список пользователей платформы

GET https://api.leeloo.ai/api/v2/users?limit=20&offset=0

Query Params
limit - ограничение количества результатов
offset - сколько результатов пропустить(по умолчанию 0)

Ответ

Получить информацию по конкретному пользователю платформы

GET https://api.leeloo.ai/api/v2/users/{user_id}

Path Params
user_id - id пользователя платформы

Response

АПИ 2.0 / API v 2.0

Введение в использование API

Заголовок запроса (Headers)

Где взять API токен?

Типы запросов

Использование переменных и пользовательских полей

Список системных ID (переменных), доступных в платформе:

Шаблоны сообщений

Получить список категорий шаблонов сообщений

Получить список шаблонов сообщений внутри категории

Отправка шаблона сообщения

Сообщения

Получить список сообщений из чата по каналу коммуникации

Отправка сообщений

Каналы коммуникации

Получить список каналов коммуникации (с внешними UTM-метками)

Получение списка каналов связи

Получение информации о человеке по каналу коммуникации (получить person_id зная параметр account_id)

LGT

Создать источник траффика в LGT

Заказы

Создать ручной ордер

Получить список ордеров

Получить информацию по отдельному ордеру

Обновить информацию в МАНУАЛ (ручном) ордере

Подписчики

Получить список всех подписчиков

Получить информацию по конкретному человеку

Обновить информацию в карточке клиента

Добавить человека на платформе

Добавить СМС соединение к человеку

Добавить комментарий к человеку

Добавить звонок в акаунт

Теги

Получить список тегов

Удалить тег у человека

Добавить тег человеку

Туннели

Получить список туннелей

Получить информацию про туннель

Получить статистику по всем туннелям

Получить статистику по одному туннелю

Подписка на туннель и блок туннеля

Пользователи

Получить список пользователей платформы

Получить информацию по конкретному пользователю платформы