Versions Compared

Old Version 40

changes.mady.by.user Max Lapaichuk

Saved on

compared with

New Version 41

changes.mady.by.user Max Lapaichuk

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Запрос

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

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

ОтветResponse

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

...

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

Запрос

GET https://api.leeloo.ai/api/v2/categories/templates/5d4835a291fbbd000e29e910
Где 5d4835a291fbbd000e29e910 - айди {category_id}

Path Params
category_id (example: 5b3f543bb2737000133d25b0) - id категории шаблонов сообщений.

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

ОтветResponse

Code Block
{
    "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 шаблона сообщения на платформе

Code Block
{
    "account_id": "5e42be688d4fff000cafe5cc",
    “template_id”: “5e42be758d4fff000cafe6ef”
    "variables": {
          "key1": "value1",
          "key2": "value2"
    }
}

Где
account_id - айди канала связи
template_id - айди шаблона сообщения на платформе

Ответ

...

Response

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

...

GET https://api.leeloo.ai/api/v2/communication-channels/5e1c83acb5ff27000ef4e207{person_id}/chat-messages?limit=202&offset=0
Где 5e1c83acb5ff27000ef4e207 - айди

Path Params
person_id (example: 5b3f543bb2737000133d25b0) - id канала коммуникации.URL parameters:

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

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

ОтветResponse

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

В теле запроса

...

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

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

Code Block
{
    "account_id": "5b3f543bb2737000133d25b0",
    "text": "текст сообщения"
}

Где
account_id - айди канала связи

Ответ

Response

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

...

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

URL parameters:

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

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

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

ОтветResponse

Code Block
{

...


    "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

...


}

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

Запрос:

GET https://api.leeloo.ai/api/v2/communication-channels/leeloo_{account_id}/person где leeloo account id person 

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

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

Response

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

...

Code Block
{
    "data":

...

 {
        "id":

...

 "

...

        "name": "some name",

...

617fd5cc1cc06d2ae24dd9eb",
        "name": "Mark Down",
        "tags":

...

 [
            "Tag 26"
        ],
        "profileImage":

...

 "https://static.leeloo.

...

ai/images/

...

5e18a2a3ed0b7a000d6c9446/

...

abd88bd0-

...

3b0a-

...

11ec-

...

82ee-

...

bb08992a1760%5B571x1100%5Djpg",

...


        "gender":

...

 "

...

OTHER",

...


        "phone":

...

 "+

...

380977451099",

...


        "email":

...

 "

...

lapaychuk95808@gmail.com",

...


        "locale":

...

 "ru_RU",

...


        "accounts":

...

            {

                "account_id": "5eecce1fbf8f43368d939628",

...

 [
            {
                "account_id": "617fd5cc1cc06d42c94dd9ec",
                "connection_id":

...

 "

...

61308ac5d087cbc40f1e478d",

...


                "connection_status":

...

 "OK",

...


                "from":

...

 "

...

            },

            {

                "account_id": "5eec9e23832be4000e6e010c",

                "connection_id": "5e1c3b3eb70fb190127935e8",

                "connection_status": "OK",

                "from": "FACEBOOK"

            }

        ],

        "subscribeHistory": [

            {

                "tunnelName": "New tunnel",

                "leadgentoolName": "New LGT",

                "trafficSource": "Default traffic source",

                "tunnelId": "5eecb50e888be4ad0e6e2e0f",

                "leadgentoolId": "5eeccda49515db0011dce5b3",

                "trafficSourceId": "5eeccda4ew35db0011dce5b5",

                "accountId": "5eecce1fbf8f43120d939628"

            },

            {

                "tunnelName": "New tunnel",

                "leadgentoolName": "New LGT",

                "trafficSource": "Default traffic source",

                "tunnelId": "5eecb50e888be4023e6e2e0f",

                "leadgentoolId": "5eeccda49515dqw011dce5b3",

                "trafficSourceId": "5eeccda49515db0rt1dce5b5",

                "accountId": "5eec9e23888be4150e6e010c"

            },

            {

                "tunnelName": "AMO action",

                "leadgentoolName": "New LGT",

                "trafficSource": "Default traffic source",

                "tunnelId": "5ef2fd47ac0af2000cc4b966",

                "leadgentoolId": "5ef2fd85ac0af2000cc4b9c0",

                "trafficSourceId": "5ef2fd85ac0af2000cc4b9c2",

                "accountId": "5eecce1fbf8f43000d939628"

            },

        ],

        "links": {

            "contactedUsers": [],

            "orders": [

                {

                    "type": "orders",

                    "id": "5ef0b1e227ed28a3fd0c5589"

                }

            ]

        },

        "custom_fields": [

            {

                "type": "EMAIL",

                "name": "pochta",

                "value": "milko@mail.com"

            },

            {

                "name": "Число месяц",

                "type": "DATE",

                "value": "2021-03-12T00:00:00.000Z"

            },

            {

                "type": "PHONE",

                "name": "Номерок",

                "value": "+380971234567"

            },

            {

                "type": "KEYWORD",

                "name": "Текст",

                "value": "opa opa opa pa"

            }

        ],

        "created_at": "2020-06-19T14:39:27.612Z",

        "updated_at": "2020-06-25T13:22:24.187Z"

    },

    "included": {},

    "status": 1

}

LGT

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

...

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

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

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 - описание трафик соурса

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

Response

Code Block
{
  "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/leadgentools/5e285aa06da476000ca1b053/create-traffic-source
Где 5e285aa06da476000ca1b053 - айди ЛГТ

В теле запроса

...

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

Code Block
{
    "namepaymentCreditsId": "5e3c3533f04b1f000c27b534"some ts",
    "descriptionemail": "someemail123@gmail.com",
ts description"
}

Где
some ts - имя трафик соурса
some ts description - описание трафик соурса

Ответ

Code Block
{   "dataphone": {
"+380669999777",
       "typetransactionDate": "normal2020-02-04T11:46:48.803Z",
   
    "fb_adset_idofferId": null,
  "5e3c357bf04b1f000c27b83a",
     "nameisNotifyAccount": "some tsfalse",
   
    "descriptionpersonId": "5e1c4676b70fb2001279c268"some,
ts description",         "synchronized_with_fb"managerId": false,
"5e1c1236b70fb3331279c444"
}

Response

Code Block
{
       "synchronization_error"data": {
false,          "disabledid": false"5e5502a01b1668000ccc93ee",
          "company_idtitle": "5b9f63e3d244d2000e27692fРучной оффер",
          "leadgentool_idprice": "5e1f119d6c384804b31e945e"100,
          "tunnel_idcurrency": "5e1f11566c384804b31e9457USD",
          "created_bystatus": "5b9f63e3d244d2000e276957OPENED",
          "hashcreatedAt": "nn7n152020-02-25T11:18:56.419Z",
        "resubscribe_button_id":  "5e32d0ed28faf61fc396f6b1",
        "createdAt"updatedAt": "2020-0102-30T1225T11:4918:4956.273Z419Z",
        "updatedAt": "2020-01-30T12:49:49.273Z"},
        "id": "5e32d0ed28faf61fc396f6b0"
  },
  "status": 1
}

Заказы

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

...

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

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

Code Block
{
    "data": [
        {
            "paymentCreditsIdid": "5e3c3533f04b1f000c27b5345e399d72a2d0e2000dd584c1",
    "email            "person_id": "email123@gmail.com5df0fac42121a5000e07d80b",
    "phone            "title": "+380669999777manual offer",
    "transactionDate            "price": "2020-02-04T11:46:48.803Z200,
            "currency": "USD",
    "offerId            "status": "5e3c357bf04b1f000c27b83aRESOLVED",
    "isNotifyAccount            "createdAt": "false2020-02-04T16:36:02.213Z",
            "updatedAt": "2020-02-04T16:38:58.168Z"
        }],
     "personIdmeta": {
        "5e1c4676b70fb2001279c268limit": 1,
        "offset": 0,
          "managerIdfilteredCount": 20,
        "5e1c1236b70fb3331279c444totalCount": 93
    }

...

,
    "status": 1
}

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

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

Code Block
{
    "status": 1,
    "data": {
 
        "id": "5e5502a01b1668000ccc93ee5e2825e081fbca000d8596e4",
 
        "titlecreatedAt": "Ручной оффер2015-04-02T14:20Z",
 
        "priceupdatedAt": 100,
 "2015-04-02T14:20Z",
        "currencytitle": "USDTitle11",
 
        "statusdescription": "OPENEDDescription1",
 
        "createdAtprice": "2020-02-25T11:18:56.419Z",
 100,
        "updatedAtcurrency": "2020-02-25T11:18:56.419Z"
      },UAH", //['USD', 'EUR', 'UAH', 'RUB']
        "status": 1
}

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

GET https://api.leeloo.ai/api/v2/orders?limit=20&offset=0
URL parameters:
Limit - ограничение количества результатов (не рекомендуется выгружать большое количество данных сразу, так как это может замедлить выгрузку данных)
Offset - скольок результатов пропустить (по умолчанию 0)

Ответ

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

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

Запрос

...

"SUCCESS", //['ORDER', 'PENDING', 'FAILED', 'SUCCESS', 'REFUNDED'],
        "paymentMethod": "WAYFORPAY", //['WAYFORPAY', 'YANDEX_MONEY', 'ASSET_PAYMENT', 'MANUAL']
    }
}

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

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

POST https://api.leeloo.ai/api/v2/orders/5e2825e081fbca000d8596e4
Где 5e2825e081fbca000d8596e4 - айди конкретного ордера.

Ответ

...

{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

Code Block
{
    "data": {
        "updatedAtid": "2015-04-02T14:20Z",5b3f608db2737000133d25b6"
        "title": "Title11",
  },
     "descriptionstatus": "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/5d8e0126e83880000d537ae3
Где 5d8e0126e83880000d537ae3 - айди ручного ордера без частичных оплат.

В теле запроса (все нужны, кроме userComments)

  • 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'

Ответ

Code Block
{
    "data": {
        "id": "5b3f608db2737000133d25b6"
      },
    "status": 1
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

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] - фильтр по номеру телефону. Опционально

ОтветResponse

Code Block
{
    "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": "2020-01-13T14:21:36.462Z"
     }
}

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

Запрос
GET https://api.leeloo.ai/api/v2/people/595f5d522a934035decc093d?include=contactedUsers,orders

В сслыке необходимо указывать ID человека. Скопировать данный ID можно в адресной ссылке в разделе CRM

...

Либо в разделе “Чаты” где этло первый ID в адрестной строке

...

Также, можно получить ID путем выгрузки аккаунтов из Лилу.

Ответ

{
"data": {
"id": "5da5998fcecdb311d73d3049",
"name": "Test test",
"tags": [
"11111111111111"
],
"profileImage": "http://example.com/example.jpg",
"gender": "MALE",
"phone": "+380669999999",
"email": "email@gmail.com",
"locale": "ru_RU",
"accounts": [
{
"account_id": "5da5998fcecdb311d73d304a",
"connection_id": "5da59953a554f211d2a34202",
"connection_status": "OK",
"from": "FACEBOOK"
}
],
"subscribeHistory": [
{
"tunnelName": "New tunnel",
"leadgentoolName": "New LGT",
"trafficSource": "Default traffic source",
"tunnelId": "5da064520f8bcb09b10893f7",
"leadgentoolId": "5da064c30f8bcb09b10893fc",
"trafficSourceId": "5da064c30f8bcb09b10893fe",
"accountId": "5da5998fcecdb311d73d304a"
},
{
"tunnelName": "New tunnel",
"leadgentoolName": "New LGT",
"trafficSource": "Default traffic source",
"tunnelId": "5daf083403c5000153e026b8",
"leadgentoolId": "5daf083403c5000153e026b9",
"trafficSourceId": "5daf083503c5000153e026c2",
"accountId": "5da5998fcecdb311d73d304a"
}
],
"links": {
"contactedUsers": [
{
"type": "users",
"id": "5b9f63e3d244d2000e276930"
}
],
"orders": [
{
"type": "orders",
"id": "5e30523c135e0c1d02b29f51"
},
{
"type": "orders",
"id": "5e25a0a420a1ed028772f1f3"
}
]
},
"custom_fields": [
{
"type": "KEYWORD",
"name": "выражение",
"value": "asdadadsad"
},
{
"type": "PHONE",
"name": "телефон",
"value": "+380667998899"
},
{
"name": "тест дата",
"type": "DATE",
"value": "2020-03-31T11:13:51.725Z"
},
{
"name": "тест номер",
"type": "NUMBER",
"value": 1234
}
],
"created_at": "2019-10-15T10:03:59.061Z",
"updated_at": "2020-01-30T10:00:32.840Z"
},
"included": {
"users": [
{
"id": "5b9f63e3d244d2000e276930",
"name": "Test",
"createdAt": "2018-09-17T08:20:51.427Z",
"updatedAt": "2019-10-11T11:41:37.255Z"
}
],
"orders": [
{
"id": "5e30523c135e0c1d02b29f51",
"title": "AssetOffer",
"price": 200,
"currency": "USD",
"status": "RESOLVED",
"updatedAt": "2020-01-28T15:24:46.988Z"
},
{
"id": "5e25a0a420a1ed028772f1f3",
"title": "AssetOffer",
"price": 200,
"currency": "USD",
"status": "OPENED",
"updatedAt": "2020-01-20T12:44:20.686Z"
}
]
},
"status": 1
}

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

Запрос
PUT https://api.leeloo.ai/api/v2/people/595f5d522a934035decc093d
Где 595f5d522a934035decc093d - айди человека.

В теле запроса
{
"phone": "+380669999999",
"email": "email@gmail.com",
"custom_fields": [
{
"type": "KEYWORD",
"name": "выражение",
"value": "asdadadsad"
},
{
"type": "PHONE",
"name": "телефон",
"value": "+380667998899"
},
{
"name": "тест дата",
"type": "DATE",
"value": "2020-03-31T11:13:51.725Z"
},
{
"name": "тест номер",
"type": "NUMBER",
"value": 1234
}
]
}

Ответ
{
"data": {},
"status": 1
}

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

...

 }],
    "meta": {
    "totalCount": 1,
    "filteredCount": 1,
    "limit": 20,
    "offset": 0
    }
}

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

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

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

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

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

Request Body(json)

Code Block
{
	"phone": "+380669991876",
    "email": "newmail@gmail.com",
	"custom_fields": [
        {
            "type": "EMAIL", //PHONE, DATE, KEYWORD, NUMBER
            "name": "emailcust",
            "value": "customemail@gmail.com"
        }
    ]
}

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

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

В теле запросаIMPORTANT: Pass your auth token in 'X-Leeloo-AuthToken' header.

Request Body(json)

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

NOTE: connected_users_ids - is not required

ОтветResponse

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

В теле запроса (в формате JSONIMPORTANT: Pass your auth token in 'X-Leeloo-AuthToken' header.

Request Body(json)

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

ОтветResponse

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

...

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

Запрос

PUT https://api.leeloo.ai/api/v2/people/5e3957b1d37987000cd46948{person_id}/add-comment
Где: 5e3957b1d37987000cd46948 - айди человека. Можно узнать перейдя в карточку человека в СРМ, или в чатах (предпоследний айди в адресной строке)В теле запроса

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

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

Request Body(json)

Code Block
{
  "comment": "привет888"some text"
}

ОтветResponse

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

...

Теги

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

Запрос
GEThttps://api.leeloo.ai/api/v2/tagsВ параметрах дополнительно ничего не указывается. В Headers запроса указывается токен авторизации комании.

ОтветIMPORTANT: Pass your auth token in 'X-Leeloo-AuthToken' header.

Response

Code Block
{
    "status": 1,
          "data": [{
              "id": "595f5d522a934035decc093d",
              "name": "Tag #1",
    }]
}

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

Запрос

PUT https://api.leeloo.ai/api/v2/people/595f5d522a934035decc093d{person_id}/remove-tag
Где 595f5d522a934035decc093d

Path Params
person_id (example: 5b3f543bb2737000133d25b0) - айди человекаВ теле запроса
form data parameters(all required):

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

Request Body(form-data)
tag_id (example: 5b3f543bb2737000133d25b0) - id тега

ОтветResponse

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

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

...

PUT https://api.leeloo.ai/api/v2/people/595f5d522a934035decc093d//people/{person_id}/add-tagГде 595f5d522a934035decc093d

Path Params
person_id (example: 5b3f543bb2737000133d25b0) - айди человекаВ теле запроса
form data parameters(all required):

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

Request Body(form-data)
tag_id (example: 5b3f543bb2737000133d25b0) - id тега

ОтветResponse

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

...

Туннели

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

...

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

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

...

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

...

GEThttps://api.leeloo.ai/api/v2/tunnels/595f5d522a934035decc093d?include=leadgentools
Где 595f5d522a934035decc093d - айди туннеля.Ответ/{tunnel_id}?include=leadgentools

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

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

Response

Code Block
{
    "status": 1,
    "data": {
        "id": "595f5d522a934035decc093d",
        "name": "My tunnel",
        "createdAt": "2015-04-02T14:20Z",
        "updatedAt": "2015-04-02T14:20Z",
        "links": {
            "leadgentools": [{
                        "type": "leadgentools",
                        "id": "222f5d522a934035decc093d" }]
        }
    },
    "linked": {
        "leadgentools": [{
            "id": "222f5d522a934035decc093d",
            "name": "LGT1",
            "type": "LINK", //['LINK', 'QR', 'WIDGET', 'POPUP', 'FORM', 'FB_AD', 'DEFAULT']
          }]
    }
}

...

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

Запрос
GEThttps://api.leeloo.ai/api/v2/tunnels/statsВ параметрах дополнительно ничего не указывается. В Headers запроса указывается токен авторизации комании.

ОтветIMPORTANT: Pass your auth token in 'X-Leeloo-AuthToken' header.

Response

Code Block
{
    "status": 1,
    "data": [{
          "subscribers": 10,
          "uniqSubscribers":2,
          "orders": 4,
          "sales": 3,
          "uniqSales": 2
          "visits": 14,
          "uniqVisits": 5
          "shows": 5,
          "uniqShows": 3
          "totalSale": 200, // in USD
          "totalExpenses": 100
      }]  
}

...


Запрос
GEThttps://api.leeloo.ai/api/v2/tunnels/595f5d522a934035decc093d{tunnel_id}/stats
Где 595f5d522a934035decc093d - айди туннеля в компанииОтвет

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

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

Response

Code Block
{
    "status": 1,
    "data": [{
        "subscribers": 10,
        "uniqSubscribers":2,
        "orders": 4,
        "sales": 3,
        "uniqSales": 2
        "visits": 14,
        "uniqVisits": 5
        "shows": 5,
        "uniqShows": 3
        "totalSale": 200, // in USD
        "totalExpenses": 100
      }]
}

...

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

...

GEThttps://api.leeloo.ai/api/v2/users?limit=20&offset=0В параметрах дополнительно ничего не указывается. В Headers запроса указывается токен авторизации комании.

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

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

Ответ

Code Block
{
    "status": 1,
    "data": [
        {
        "id": "445f5d522a934035decc093d",
        "name": "Igor",
        "createdAt": "2015-04-02T14:20Z",
        "updatedAt": "2015-04-02T14:20Z",
        },
        {
        "id": "125f5d522a934035decc093d",
        "name": "Alexey",
        "createdAt": "2015-04-02T14:20Z",
        "updatedAt": "2015-04-02T14:20Z",
        }
      ],
    "meta": {
        "totalCount": 1,
        "filteredCount": 1,
        "limit": 20,
        "offset": 0
      }
}

...

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

...

GEThttps://api.leeloo.ai/api/v2/users/445f5d522a934035decc093d
Где 445f5d522a934035decc093d - айди пользователя на платформе.Ответ{user_id}

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

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

Response

Code Block
{
    "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/connections

Овет:IMPORTANT: Pass your auth token in 'X-Leeloo-AuthToken' header.

Response

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

...

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

Тип запроса: POST https://api.leeloo.ai/api/v2/communication-channels/{account_id}/manual-subscribe

Path Params
Вместо account_id нужно подставить айди акаунта который нужно подписатьВ теле запроса
form data parameters(Все параметры необходимы для корректной работы): - 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)

...

Важно!: Pass your auth token in 'X-Leeloo-AuthToken' header.

Овет:- id блока в тунеле

Response

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