UA	US	RU

UA	US	RU

1 Шаблони повідомлень

У всіх запитах дату необхідно вказувати з урахуванням нульового часового поясу UTC-0
всі запити повинні надсилатися в JSON форматі

Шаблони повідомлень

Отримати список категорій шаблонів повідомлень

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

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

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 категорії шаблонів повідомлень

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

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

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

Request Body(json)
account_id (example: 513f543gb2737020133d25b0) - id канала связи
template_id (example: 6b3f543bb2737003133d25b4) - id шаблона сообщения на платформе

{
    "account_id": "5e42be688d4fff000cafe5cc",
    “template_id”: “5e42be758d4fff000cafe6ef”
    "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 канала коммуникации.

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

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

Response

ВАЖНО! Пример ответа на запрос показан для установленого параметра лимита равного двум. При изменении значения параметра лимита будет изменяться и кол-во сообщений в ответе на запрос.

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

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

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

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

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

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

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

Response

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

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

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

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

Response

LGT

Создать трафик соурс в ЛГТ

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

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

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

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

Response

Заказы

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

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

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

Request Body(json)
paymentCreditsId (example: 5b3f543bb2737000133d25b2) - id платежной системы. Можно узнать в настройках платформы, раздел с платежными системами.
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)

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

Response

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

GET 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.

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

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

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 человека на платформе

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

Response

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

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

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

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

Request Body(json)

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

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

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

Request Body(json)

NOTE: connected_users_ids - is not required

Response

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

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

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

Request Body(json)

Response

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

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

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

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

Request Body(json)

Response

Туннели

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

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

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

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

Response

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

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

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

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

Response

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

GEThttps://api.leeloo.ai/api/v2/tunnels/stats

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

Response

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

Запрос
GEThttps://api.leeloo.ai/api/v2/tunnels/{tunnel_id}/stats

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

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

Response

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

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

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

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

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

Ответ

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

GEThttps://api.leeloo.ai/api/v2/users/{user_id}

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

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

Response

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

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

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

Response

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

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

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

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

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

Response

Документация Leeloo.ai

АПІ 2.0/API v 2.0

Шаблони повідомлень

Отримати список категорій шаблонів повідомлень

Отримати список шаблонів повідомлень усередині категорії

Надсилання шаблону повідомлення

Сообщения

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

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

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

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

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

LGT

Создать трафик соурс в ЛГТ

Заказы

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

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

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

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

Люди

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

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

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

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

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

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

Теги

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

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

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

Туннели

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

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

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

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

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

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

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

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

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