UA	US	RU

UA	US	RU

API (Application Programming Interface) — це інструмент, який дозволяє вашим додаткам, сайтам, CRM "спілкуватися" та обмінюватися даними з платформою Leeloo.ai. За допомогою 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/66fac2b853d5470e1ed207b6/account_id/
template_id - id шаблону повідомлення на платформі беремо зі створеного шаблону повідомлення в категорії шаблонів.
Приклад - https://app.leeloo.ai/campaigns-templates/category_id/templates/creator/template_id
person_id - id каналу комунікації беремо зі посилання клієнта у розділі Чати.
Приклад - https://app.leeloo.ai/chats/all/person_id/account_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_id","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” праворуч від створеного Тега.

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

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

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

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

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

{
  "account_id": "66fac2b853d5123567d207b7",
  "template_id": "65fc3f2656789099e157e817"
}

Response

{
    "status": 1,
    "data": {}
}

Повідомлення

Отримати список повідомлень із чату за каналом комунікації

Запит

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

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

Query Params
limit - обмеження кількості результатів (не рекомендується завантажувати велику кількість даних одразу, оскільки це може уповільнити завантаження)
offset - скільки результатів пропустити (за замовчуванням 0)

Response

{
    "data": [
          {
          "id": "5e3bf8d6c6ed91000c8534ae",
          "text": "Test API v.1 message template",
          "type": "YOUR_MESSAGE",
          "read": true,
          "createdAt": "2020-02-06T11:30:30.035Z",
          "updatedAt": "2020-02-06T11:30:30.035Z"
          },
          {
          "id": "5e3beba47fa862000e3b4d05",
          "text": "API message",
          "type": "YOUR_MESSAGE",
          "read": true,
          "createdAt": "2020-02-06T10:34:12.230Z",
          "updatedAt": "2020-02-06T10:34:12.230Z"
          }
    ],
    "meta": {
          "limit": 3,
          "offset": 0,
          "filteredCount": 3,
          "totalCount": 52
    },
    "status": 1
}

ВАЖЛИВО! Приклад відповіді на запит показаний для встановленого параметра ліміту рівного двом. При зміні значення параметра ліміту змінюватиметься і кількість повідомлень у відповіді на запит.

Відправка повідомлень

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

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

Request Body(json)
account_id (example: 5b3f543bb2737000133d25b0) - id канала зв’язку
text - текст повідомлення, яке хочемо відправити

{
    "account_id": "5b3f543bb2737000133d25b0",
    "text": "текст повідомлення"
}

Response

{
    "status": 1,
    "data": {}
}

Канали комунікації

Отримати список каналів комунікації (з зовнішніми 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

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

Query Params
limit - обмеження кількості результатів (не рекомендується завантажувати велику кількість даних одразу, оскільки це може уповільнити завантаження)
offset - скільки результатів пропустити (за замовчуванням 0)
filter[last_message][from] - фільтр за останнім повідомленням від вказаної дати

filter[last_message][to] - фільтр за останнім повідомленням до вказаної дати

Response

{
    "data": [
        {
            "id": "5ef074e9e31801000d73ba11",
            "person_id": "5ef074e9e31801000d73ba10",
            "name": "TIIIIK",
            "from": "TELEGRAM",
            "botStatus": "BOT",
            "lastMessageTime": "2020-08-31T07:55:53.865Z",
            "createdAt": "2020-06-22T09:07:53.351Z",
            "utmMarks": {
                "utm_source": "test_UTM_mark"
            }
        },
        {
            "id": "5ea177b8ac8f55000d2c68f1",
            "person_id": "5ea177b8ac8f55000d2c68f0",
            "name": "Adolf Shtangencirkul",
            "from": "VKONTAKTE",
            "botStatus": "BOT",
            "lastMessageTime": "2020-08-29T08:31:51.211Z",
            "createdAt": "2020-04-23T11:10:48.337Z",
            "utmMarks": {}
        }
    ],
    "meta": {
        "limit": 2,
        "offset": 0,
        "filteredCount": 2,
        "totalCount": 2
    },
    "status": 1
}

Отримання списку каналів зв’язку

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

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

Response

{
    "data": {
        "connections": [
            {
                "id": "65cf48536d81f496d4f9a673",
                "type": "telegram",
                "name": "Telegram bot"
            },
            {
                "id": "65b3791a9af7b6ef6f4a8afd",
                "type": "sendGrid",
                "name": "Sendgrid bot"
            }
        ]
    },
    "status": 1
}

Отримання інформації про підписника

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

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

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

Response

{
    "data": {
        "id": "617fd5cc1cc06d2ae24dd9eb",
        "name": "Mark Down",
        "tags": [
            "Tag 26"
        ],
        "profileImage": "https://static.leeloo.ai/images/5e18a2a3ed0b7a000d6c9446/abd88bd0-3b0a-11ec-82ee-bb08992a1760%5B571x1100%5Djpg",
        "gender": "OTHER",
        "phone": "+380977751199",
        "email": "useremail@gmail.com",
        "locale": "ru_RU",
        "accounts": [
            {
                "account_id": "617fd5cc1cc06d42c94dd9ec",
                "connection_id": "61308ac5d087cbc40f1e478d",
                "connection_status": "OK",
                "from": "FACEBOOK"
            }
        ],
        "subscribeHistory": [
            {
                "tunnelName": "for list",
                "leadgentoolName": "New LGT",
                "trafficSource": "Default traffic source",
                "tunnelId": "617fa515557acb4a2472c560",
                "leadgentoolId": "617fa612925d13644ae58e55",
                "trafficSourceId": "617fa612925d1341eee58e58",
                "accountId": "617fd5cc1cc06d42c94dd9ec"
            }
        ],
        "links": {
            "contactedUsers": [
                {
                    "type": "users",
                    "id": "60509800acc5ae000d74ce21"
                }
            ],
            "orders": [
                {
                    "type": "orders",
                    "id": "618280605402c96fa86c125a"
                }
            ]
        },
        "custom_fields": [],
        "created_at": "2021-11-01T11:55:56.358Z",
        "updated_at": "2024-02-02T12:07:54.882Z"
    },
    "included": {},
    "status": 1
}

LGT

Створити джерело трафіку в LGT

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

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

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

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

{
    "name": "some ts",
    "description": "some ts description"
}

Response

{
  "data": {
        "type": "normal",
        "fb_adset_id": null,
        "name": "some ts",
        "description": "some ts description",
        "synchronized_with_fb": false,
        "synchronization_error": false,
        "disabled": false,
        "company_id": "5b9f63e3d244d2000e27692f",
        "leadgentool_id": "5e1f119d6c384804b31e945e",
        "tunnel_id": "5e1f11566c384804b31e9457",
        "created_by": "5b9f63e3d244d2000e276957",
        "hash": "nn7n15",
        "resubscribe_button_id": "5e32d0ed28faf61fc396f6b1",
        "createdAt": "2020-01-30T12:49:49.273Z",
        "updatedAt": "2020-01-30T12:49:49.273Z",
        "id": "5e32d0ed28faf61fc396f6b0"
  },
  "status": 1
}

Замовлення

Створити ручний ордер

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

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

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

{
    "paymentCreditsId": "5e3c3533f04b1f000c27b534",
    "email": "email123@gmail.com",
    "phone": "+380669999777",
    "transactionDate": "2020-02-04T11:46:48.803Z",
    "offerId": "5e3c357bf04b1f000c27b83a",
    "isNotifyAccount": "false",
    "personId": "5e1c4676b70fb2001279c268",
    "managerId": "5e1c1236b70fb3331279c444"
}

Response

{
    "data": {
          "id": "5e5502a01b1668000ccc93ee",
          "title": "Ручний оффер",
          "price": 100,
          "currency": "USD",
          "status": "OPENED",
          "createdAt": "2020-02-25T11:18:56.419Z",
          "updatedAt": "2020-02-25T11:18:56.419Z"
      },
    "status": 1
}

Отримати список ордерів

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

Query Params
limit - обмеження кількості результатів (не рекомендується завантажувати велику кількість даних одразу, оскільки це може уповільнити завантаження)
offset - скільки результатів пропустити (за замовчуванням 0)

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

Response

{
    "data": [
        {
            "id": "5e399d72a2d0e2000dd584c1",
            "person_id": "5df0fac42121a5000e07d80b",
            "title": "manual offer",
            "price": 200,
            "currency": "USD",
            "status": "RESOLVED",
            "createdAt": "2020-02-04T16:36:02.213Z",
            "updatedAt": "2020-02-04T16:38:58.168Z"
        }],
    "meta": {
        "limit": 1,
        "offset": 0,
        "filteredCount": 20,
        "totalCount": 93
    },
    "status": 1
}

Отримати інформацію по окремому ордеру

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

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

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

Response

{
    "status": 1,
    "data": {
        "id": "5e2825e081fbca000d8596e4",
        "createdAt": "2015-04-02T14:20Z",
        "updatedAt": "2015-04-02T14:20Z",
        "title": "Title11",
        "description": "Description1",
        "price": 100,
        "currency": "UAH", //['USD', 'EUR', 'UAH', 'RUB']
        "status": "SUCCESS", //['ORDER', 'PENDING', 'FAILED', 'SUCCESS', 'REFUNDED'],
        "paymentMethod": "WAYFORPAY", //['WAYFORPAY', 'YANDEX_MONEY', 'ASSET_PAYMENT', 'MANUAL']
    }
}

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

Ордер НЕ МОЖЕ БУТИ з частковими оплатами

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

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

ВАЖЛИВО: Передайте ваш токен аутентифікації в заголовку 'X-Leeloo-AuthToken'.

Request Body (form-data)
status приклад: 'RESOLVED', (одне з: RESOLVED/REJECTED)
paymentDate приклад: '2018-06-27 07:32',
currency приклад: 'USD',
price

Response

{
    "data": {
        "id": "632af797bd3cc466fe1af584",
        "name": "John Mack",
        "createdAt": "2022-09-21T11:37:59.353Z",
        "updatedAt": "2022-09-27T12:26:12.786Z"
    },
    "status": 1
}

Підписники

Отримати список усіх підписників

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

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

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

Відповідь

{
    "status": 1,
    "data": [{
        "id": "5e1c7ce2b4066a01900cdba0",
        "name": "Feliks",
        ”email": ”feliks@gmail.com",
        ”phone": ”+380966565556"
        "tags": [
            "Mentor",
            "Professional"
            ],
        "accounts": [{
              "account_id": "5e1c7ce2b4066a01900cdba1",
              "connection_id": "5e1c7afcb4066a01900cdb8c",
              "connection_status": "OK",
              "from": "TELEGRAM"
              }],
        "lastMessageTime": "2020-01-13T14:21:36.462Z"
      }],
    "meta": {
    "totalCount": 1,
    "filteredCount": 1,
    "limit": 20,
    "offset": 0
    }
}

Отримати інформацію про конкретного підписника

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

Параметри шляху
person_id (приклад: 5b3f543bb2737000133d25b0) - id людини на платформі

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

Відповідь

{
    "data": {
        "id": "625946dd585052c1629f1b2b",
        "name": "Mark Spenser",
        "tags": [],
        "profileImage": "NOT_DEFINED",
        "gender": "NO_DATA",
        "phone": "+380977451111",
        "email": "Ray37@hotmail.com",
        "locale": "",
        "accounts": [
            {
                "account_id": "625946dd58505225f49f1b2c",
                "connection_id": "5e1edc3f18fc56000c0159b3",
                "connection_status": "OK",
                "from": "TELEGRAM"
            }
        ],
        "subscribeHistory": [
            {
                "tunnelName": "Default tunnel",
                "leadgentoolName": "Default leadgentool",
                "trafficSource": "Default traffic source",
                "tunnelId": "5e18a2a3ed0b7a000d6c9484",
                "leadgentoolId": "5e18a2a3ed0b7a000d6c9486",
                "trafficSourceId": "5e18a2a3ed0b7a000d6c9488",
                "accountId": "625946dd58505225f49f1b2c"
            }
        ],
        "links": {
            "contactedUsers": [
                {
                    "type": "users",
                    "id": "60509800acc5ae000d74ce21"
                }
            ],
            "orders": [
                {
                    "type": "orders",
                    "id": "65cf58ba1261175f8d40a75f"
                }
            ]
        },
        "custom_fields": [
            {
                "type": "PHONE",
                "name": "phone",
                "value": "+48881644207"
            }
        ],
        "created_at": "2022-04-15T10:20:13.546Z",
        "updated_at": "2024-02-16T16:16:57.065Z"
    },
    "included": {
        "users": [
            {
                "id": "60509800acc5ae000d74ce21",
                "name": "Max",
                "createdAt": "2021-03-16T11:35:28.644Z",
                "updatedAt": "2024-02-19T12:59:04.460Z"
            }
        ],
        "orders": [
            {
                "id": "65cf58ba1261175f8d40a75f",
                "title": "for API",
                "price": 100,
                "currency": "USD",
                "status": "OPENED",
                "updatedAt": "2024-02-16T12:44:42.569Z"
            }
        ]
    },
    "status": 1
}

Оновити інформацію у картці клієнта

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

Параметри шляху
person_id (приклад: 5b3f543bb2737000133d25b0) - id людини.

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

Тіло запиту(json)

{
    "phone": "+380669991876",
    "email": "newmail@gmail.com",
    "custom_fields": [
        {
            "type": "EMAIL", 
            "name": "emailcust",
            "value": "customemail@gmail.com"
        }
    ]
}

Додати людину на платформу

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

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

Тіло запиту (json)

{
    "name":"Feliks",
    "email":"feliks@gmail.com",
    "phone":"+380953066789",
    "leadgentool_id":"609290d3e060416cdea6823e",
    "connected_users_ids": ["609290d3e060416cdea68444"]
}

Відповідь

{
    "data": {
        "id": "60a4bcd7bc45b806ac3b1a4a",
        "person_id": "60a4bcd7bc45b83b6e3b1a49",
        "name": "Feliks",
        "tags": [],
        "from": "MANUAL",
        "botStatus": "BOT",
        "connectionStatus": "OK",
        "gender": "NOT_DEFINED",
        "phone": "+380953066789",
        "email": "feliks@gmail.com",
        "locale": "",
        "subscribeHistory": [],
        "createdAt": "2021-05-19T07:23:03.546Z",
        "updatedAt": "2021-05-19T07:23:03.546Z"
    },
    "status": 1
}

Додати SMS-з’єднання до підписника

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

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

Тіло запиту(json)

{
    "data": [{
          "name": "test123",
          "email": "test123@example.com",
          "phone": "+380667772233"
      }],
    "connection_id": "5dbfe6c5fb73e101720b3dc7",
    "leadgentool_id": "5e1f119d6c384804b31e945e",
    "tags": ["5cf7a18586236d000b1256b2"]
}

Відповідь

{
    "data": {
        "count_to_process": 1
        },
    "status": 1
}

Додати коментар до підписника

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

Параметри шляху
person_id (приклад: 5b3f543bb2737000133d25b0) - id людини

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

Тіло запиту(json)

{
  "comment": "some text"
}

Відповідь

{
    "data": {
        "created_by": "5b9f63e3d244d2000e276957",
        "company_id": "5b9f63e3d244d2000e27692f",
        "text": "some text",
        "entity_id": "5da5998fcecdb311d73d3049",
        "entity_type": "PERSON",
        "created_at": "2020-01-30T10:08:50.677Z",
        "updated_at": "2020-01-30T10:08:50.677Z",
        "id": "5e32ab3228faf61fc396f625"
    },
    "status": 1
}

Додати дзвінок в акаунт

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

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

Тіло запиту(form-data, всі обов’язкові)
user_id приклад: ‘5b0d313b307879002915b3cc’
from приклад: ‘606'
to приклад: ‘607'
date приклад: ‘2024-03-22T15:30:17.339Z'
account_id приклад: '6b0d313b307879002915b3c1’
record_link приклад: 'https://file-examples.com/storage/2017/11/file_example_MP3_5MG.mp3’ або 'NOT_DEFINED’
status приклад: 'SUCCESS' (одне з: 'TALKING', 'SUCCESS', 'NO_ANSWER', 'CLOSED_BY_SYSTEM')
duration приклад: '100' (секунди)
type приклад: INBOUND або OUTBOUND

{
  "user_id": "65d5ed778c9636bd775f715b",
  "from": "606",
  "to": "607",
  "date": "2024-03-22T15:30:17.339Z",
  "account_id": "66fac2b853d5472551d207b7",
  "record_link": "https://file-examples.com/storage/2017/11/file_example_MP3_5MG.mp3",
  "status": "SUCCESS",
  "duration": 100,
  "type": "INBOUND"
}

Відповідь

{
  "data": {
    "raw_response": {},
    "record_link": "https://file-examples.com/storage/fe7c2cbe4b65fa8179825d1/2017/11/file_example_MP3_5MG.mp3",
    "company_id": "5b9f63e3d244d2000e27692f",
    "user_id": "5b9f63e3d244d2000e276930",
    "account_id": "65b632d119471a0012c3cabd",
    "provider_type": "MANUAL",
    "to": "+380663332222",
    "from": "123",
    "type": "OUTBOUND",
    "status": "SUCCESS",
    "telephone_connection_id": "603e5096c4a05c3a9506f219",
    "call_id": "57fa99e0-e846-11ee-b73a-95e863e509cb",
    "billsec": 140,
    "created_at": "2024-03-22T12:00:36.980Z",
    "updated_at": "2024-03-22T12:00:36.980Z",
    "next_check": "2024-03-22T12:19:51.650Z",
    "id": "65fd772be3f8780013eac6b0"
  },
  "status": 1

Тунелі

Отримати список тунелів

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

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

Параметри запиту
limit - обмеження кількості результатів (не рекомендується завантажувати велику кількість даних одразу, оскільки це може уповільнити завантаження)
offset - скільки результатів пропустити (за замовчуванням 0)

Відповідь

{
    "status": 1,
    "data": [{
          "id": "595f5d522a934035decc093d",
          "name": "My tunnel",
          "createdAt": "2015-04-02T14:20Z",
          "updatedAt": "2015-04-02T14:20Z",
    }],
    "meta": {
          "totalCount": 1,
          "filteredCount": 1,
          "limit": 20,
          "offset": 0
    }
}

Отримати інформацію про тунель

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

Параметри шляху
tunnel_id (приклад: 5b3f543bb2737000133d25b0) - id тунелю

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

АПІ 2.0 / API v 2.0

Вступ до використання API

Заголовок запиту (Headers)

Де взяти API токен?

Типи запитів

Використання змінних та користувацьких полів

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

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

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

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

Відправка шаблону повідомлення

Повідомлення

Отримати список повідомлень із чату за каналом комунікації

Відправка повідомлень

Канали комунікації

Отримати список каналів комунікації (з зовнішніми UTM-мітками)

Отримання списку каналів зв’язку

Отримання інформації про підписника

LGT

Створити джерело трафіку в LGT

Замовлення

Створити ручний ордер

Отримати список ордерів

Отримати інформацію по окремому ордеру

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

Підписники

Отримати список усіх підписників

Отримати інформацію про конкретного підписника

Оновити інформацію у картці клієнта

Додати людину на платформу

Додати SMS-з’єднання до підписника

Додати коментар до підписника

Додати дзвінок в акаунт

Теги

Отримати список тегів

Видалити тег у людини

Додати тег підписнику

Тунелі

Отримати список тунелів

Отримати інформацію про тунель