Content Comparison

UA	US	RU

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

...

• 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” правее от созданного Тега.
  

...

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

Получение информации о

...

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

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

...

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

...

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'

...

{
    "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

...

{
    "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
}

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

...

подписчику

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

...

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

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

...

подписчику

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

...

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

Добавить тег

...

подписчику

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

...