LeadTex

https://docs.leadteh.ru/
Admin
LeadTex is a chatbot builder platform that enables creating multi-channel bots for messaging apps,...
Tokens:55,449
Snippets:364
Trust Score:8.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /api/v1/getMe

Source: https://docs.leadteh.ru/rabota-s-api/akkaunt?q=

Простой метод для тестирования токена. Возвращает информацию о текущем аккаунте.

```APIDOC
## GET /api/v1/getMe

### Description
Простой метод для тестирования токена. Возвращает информацию о текущем аккаунте.

### Method
GET

### Endpoint
https://app.leadteh.ru/api/v1/getMe

### Response
#### Success Response (200)
- **data** (object) - Объект с информацией об аккаунте.
  - **id** (integer) - Идентификатор аккаунта.
  - **name** (string) - Имя пользователя.
  - **phone** (string|null) - Телефон пользователя.
  - **email** (string) - Email пользователя.
  - **created_at** (string) - Дата создания аккаунта в формате ISO 8601.

#### Response Example
{
  "data": {
    "id": 1,
    "name": "Дмитрий",
    "phone": null,
    "email": "dmitriy@example.com",
    "created_at": "2019-01-08T16:56:07+00:00"
  }
}
```

--------------------------------

### GET https://app.leadteh.ru/api/v1/getMe — пример ответа

Source: https://docs.leadteh.ru/rabota-s-api/akkaunt?q=

Метод позволяет тестировать токен. Отправка в запросе данных контакта должна быть отключена. Ответ содержит данные аккаунта: id, name, phone, email, created_at.

```json
{
  "data": {
    "id": 1,
    "name": "Дмитрий",
    "phone": null,
    "email": "dmitriy@example.com",
    "created_at": "2019-01-08T16:56:07+00:00"
  }
}
```

--------------------------------

### Ответ 200 OK для GET /api/v1/getListSchema

Source: https://docs.leadteh.ru/rabota-s-api/spiski/schema-spiska?q=

Пример успешного ответа на запрос получения схемы списка. Содержит id схемы, поля с их настройками (name, type, is_required, is_hidden, is_encryptable), название списка, флаг is_menu и даты создания/обновления.

```json
{
  "data": {
    "id": "5dee4800c2cc5a38ec797235",
    "fields": {
      "name": {
        "name": "Название",
        "type": "string",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "quantity": {
        "name": "Количество",
        "type": "number",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      },
      "is_vip": {
        "name": "VIP",
        "type": "bool",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "contact": {
        "name": "Контакт",
        "type": "contact",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "key": {
        "name": "Ключ",
        "type": "string",
        "is_required": true,
        "is_hidden": true,
        "is_encryptable": true
      },
      "img": {
        "name": "Изображение",
        "type": "image",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      }
    },
    "name": "Заказы",
    "is_menu": false,
    "created_at": "2019-12-09T13:11:28+00:00",
    "updated_at": "2019-12-09T13:11:28+00:00"
  }
}
```

--------------------------------

### GET /api/v1/getListSchemas

Source: https://docs.leadteh.ru/rabota-s-api/spiski/schema-spiska?q=

Метод позволяет получить списки (схемы). В запросе не требуется отправка данных контакта. Ответ содержит массив схем с полями и их свойствами.

```APIDOC
## GET /api/v1/getListSchemas

### Description
Метод позволяет получить списки (схемы). В запросе не требуется отправка данных контакта.

### Method
GET

### Endpoint
https://app.leadteh.ru/api/v1/getListSchemas

### Response
#### Success Response (200)
- **data** (array) - Массив схем. Каждая схема содержит:
  - **id** (string) - Идентификатор схемы.
  - **fields** (object) - Объект полей схемы. Каждое поле содержит:
    - **name** (string) - Название поля.
    - **type** (string) - Тип поля (string, number, bool, contact, image).
    - **is_required** (bool) - Обязательность поля.
    - **is_hidden** (bool) - Скрытость поля.
    - **is_encryptable** (bool) - Возможность шифрования поля.
  - **name** (string) - Название схемы.
  - **is_menu** (bool) - Флаг отображения в меню.
  - **created_at** (string) - Дата создания.
  - **updated_at** (string) - Дата обновления.
- **links** (object) - Объект ссылок пагинации:
  - **first** (string) - Ссылка на первую страницу.
  - **last** (string) - Ссылка на последнюю страницу.
  - **prev** (string|null) - Ссылка на предыдущую страницу.
  - **next** (string|null) - Ссылка на следующую страницу.
- **meta** (object) - Метаданные пагинации:
  - **current_page** (integer) - Текущая страница.
  - **from** (integer) - Начальный индекс.
  - **last_page** (integer) - Последняя страница.
  - **path** (string) - Базовый путь.
  - **per_page** (integer) - Количество элементов на странице.
  - **to** (integer) - Конечный индекс.
  - **total** (integer) - Общее количество элементов.

#### Response Example
{
  "data": [
    {
      "id": "5dee4800c2cc5a38ec797235",
      "fields": {
        "name": {
          "name": "Название",
          "type": "string",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "quantity": {
          "name": "Количество",
          "type": "number",
          "is_required": false,
          "is_hidden": false,
          "is_encryptable": false
        },
        "is_vip": {
          "name": "VIP",
          "type": "bool",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "contact": {
          "name": "Контакт",
          "type": "contact",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "key": {
          "name": "Ключ",
          "type": "string",
          "is_required": true,
          "is_hidden": true,
          "is_encryptable": true
        },
        "img": {
          "name": "Изображение",
          "type": "image",
          "is_required": false,
          "is_hidden": false,
          "is_encryptable": false
        }
      },
      "name": "Заказы",
      "is_menu": false,
      "created_at": "2019-12-09T13:11:28+00:00",
      "updated_at": "2019-12-09T13:11:28+00:00"
    }
  ],
  "links": {
    "first": "https://leadteh.ru/api/v1/getListSchemas?page=1",
    "last": "https://leadteh.ru/api/v1/getListSchemas?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://leadteh.ru/api/v1/getListSchemas",
    "per_page": 50,
    "to": 1,
    "total": 1
  }
}
```

--------------------------------

### Получение списка схем через GET getListSchemas

Source: https://docs.leadteh.ru/rabota-s-api/spiski/schema-spiska?q=

Пример успешного ответа (200 OK) при вызове метода getListSchemas, содержащий массив данных с описанием полей, метаданные пагинации и ссылки.

```json
{
  "data": [
    {
      "id": "5dee4800c2cc5a38ec797235",
      "fields": {
        "name": {
          "name": "Название",
          "type": "string",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "quantity": {
          "name": "Количество",
          "type": "number",
          "is_required": false,
          "is_hidden": false,
          "is_encryptable": false
        },
        "is_vip": {
          "name": "VIP",
          "type": "bool",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "contact": {
          "name": "Контакт",
          "type": "contact",
          "is_required": true,
          "is_hidden": false,
          "is_encryptable": false
        },
        "key": {
          "name": "Ключ",
          "type": "string",
          "is_required": true,
          "is_hidden": true,
          "is_encryptable": true
        },
        "img": {
          "name": "Изображение",
          "type": "image",
          "is_required": false,
          "is_hidden": false,
          "is_encryptable": false
        }
      },
      "name": "Заказы",
      "is_menu": false,
      "created_at": "2019-12-09T13:11:28+00:00",
      "updated_at": "2019-12-09T13:11:28+00:00"
    }
  ],
  "links": {
    "first": "https:\/\/leadteh.ru\/api\/v1\/getListSchemas?page=1",
    "last": "https:\/\/leadteh.ru\/api\/v1\/getListSchemas?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https:\/\/leadteh.ru\/api\/v1\/getListSchemas",
    "per_page": 50,
    "to": 1,
    "total": 1
  }
}
```

--------------------------------

### Ответ метода GET /api/v1/getContacts

Source: https://docs.leadteh.ru/rabota-s-api/kontakty?q=

Пример успешного ответа (код 200) на запрос получения списка контактов. Содержит массив контактов с полями id, bot_id, phone, email, name, messenger, address, utm, created_at и другие, а также информацию о пагинации в links и meta.

```json
{
  "data": [
    {
      "id": 1,
      "bot_id": 1,
      "phone": "79991234567",
      "email": "info@example.com",
      "name": "Иван Иванов",
      "messenger": "whatsapp",
      "address": "г. Москва, ул. Пушкина, д. 5",
      "utm": {
        "utm_source": "landing",
        "utm_medium": "...",
        "utm_campaign": "...",
        "utm_term": "...",
        "utm_content": "..."
      },
      "created_at": "2019-05-10T10:38:28+00:00"
    },
    {
      "id": 2,
      "bot_id": 1,
      "phone": "792712312321",
      "email": null,
      "name": "Петр Петров",
      "messenger": "telegram",
      "telegram_id": "123456",
      "telegram_username": "superman",
      "address": null,
      "utm": null,
      "created_at": "2019-04-02T12:16:16+00:00"
    },
    {
      "id": 3,
      "bot_id": 2,
      "phone": null,
      "email": null,
      "name": "Василий Васильев",
      "messenger": "viber",
      "viber_id": "1123456789dD20=",
      "address": null,
      "utm": null,
      "created_at": "2019-05-11T15:31:34+00:00"
    },
  ],
  "links": {
    "first": "http:\/\/leadteh.ru\/api\/v1\/getContacts?page=1",
    "last": "http:\/\/leadteh.ru\/api\/v1\/getContacts?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "http:\/\/leadteh.ru\/api\/v1\/getContacts",
    "per_page": 500,
    "to": 3,
    "total": 3
  }
}
```

--------------------------------

### GET /api/v1/getListSchema

Source: https://docs.leadteh.ru/rabota-s-api/spiski/schema-spiska

Метод позволяет получить схему списка по её ID. Требуется указать параметр schema_id в строке запроса.

```APIDOC
## GET /api/v1/getListSchema

### Description
Метод позволяет получить схему списка по её ID.

### Method
GET

### Endpoint
https://app.leadteh.ru/api/v1/getListSchema

### Parameters
#### Query Parameters
- **schema_id** (string) - Required - ID схемы

### Response
#### Success Response (200)
Запрос успешно обработан.

#### Response Example
{
  "data": {
    "id": "5dee4800c2cc5a38ec797235",
    "fields": {
      "name": {
        "name": "Название",
        "type": "string",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "quantity": {
        "name": "Количество",
        "type": "number",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      },
      "is_vip": {
        "name": "VIP",
        "type": "bool",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "contact": {
        "name": "Контакт",
        "type": "contact",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "key": {
        "name": "Ключ",
        "type": "string",
        "is_required": true,
        "is_hidden": true,
        "is_encryptable": true
      },
      "img": {
        "name": "Изображение",
        "type": "image",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      }
    },
    "name": "Заказы",
    "is_menu": false,
    "created_at": "2019-12-09T13:11:28+00:00",
    "updated_at": "2019-12-09T13:11:28+00:00"
  }
}
```

--------------------------------

### GET /api/v1/getBotTags

Source: https://docs.leadteh.ru/rabota-s-api/kontakty/tegi

Получение списка всех тегов для указанного бота. Требуется указать идентификатор бота в пути.

```APIDOC
## GET /api/v1/getBotTags

### Description
Получить список всех тегов для определенного бота.

### Method
GET

### Endpoint
https://app.leadteh.ru/api/v1/getBotTags

### Parameters
#### Path Parameters
- **bot_id** (string) - Required - ID бота.

### Response
#### Success Response (200)
- **data** (array of strings) - Список тегов.

#### Response Example
{
  "data": [
    "leadtex",
    "заявка"
  ]
}
```

--------------------------------

### GET /api/v1/getReferrers

Source: https://docs.leadteh.ru/rabota-s-api/kontakty/referalnaya-sistema

Получение списка или дерева рефереров контакта. Метод возвращает информацию о вышестоящих пользователях в реферальной программе.

```APIDOC
## GET /api/v1/getReferrers

### Description
Получить список или дерево рефереров контакта.

### Method
GET

### Endpoint
https://app.leadteh.ru/api/v1/getReferrers

### Parameters
#### Path Parameters
- **contact_id** (integer) - Required - ID контакта.
- **depth** (integer) - Required - Глубина дерева, мин. 1, макс. 10.
- **is_flat** (boolean) - Optional - По умолчанию возвращается информация в виде дерева, если значение равно `1`, то информацию вернется в виде списка рефереров.

### Response
#### Success Response (200)
Запрос успешно обработан. Результат в виде дерева, включая текущий контакт.

#### Response Example
```json
{
  "data": {
    "id": 3,
    "name": "Иван Иванов",
    "messenger": "telegram",
    "created_at": "2019-05-10T10:38:28+00:00",
    "referrer": {
      "id": 2,
      "name": "Петр Петров",
      "messenger": "telegram",
      "created_at": "2019-05-10T10:38:25+00:00",
      "referrer": {
        "id": 1,
        "name": "Василий Васильев",
        "messenger": "telegram",
        "created_at": "2019-05-10T10:11:42+00:00"
      }
    }
  }
}
```
```

--------------------------------

### GET getContactCryptoAccounts — 200 ответ со списком счетов

Source: https://docs.leadteh.ru/rabota-s-api/kontakty/svobodnye-scheta?q=

Пример успешного ответа на метод получения списка счетов. Возвращает объект data с массивом счетов, каждый содержит id, currency, amount и временные метки.

```json
{
  "data": [
    {
      "id": 2,
      "currency": "BTC",
      "amount": "0.24624642624",
      "created_at": "2019-12-24T11:19:42+00:00",
      "updated_at": "2019-12-24T11:21:57+00:00"
    }
  ]
}
```

--------------------------------

### Ответ 200 OK для POST /api/v1/createListSchema

Source: https://docs.leadteh.ru/rabota-s-api/spiski/schema-spiska?q=

Пример успешного ответа на создание схемы списка. Структура аналогична ответу getListSchema, но is_menu установлен в true. Показывает, что схема создана с указанными полями и настройками.

```json
{
  "data": {
    "id": "5dee51518a7ab32ecf060265",
    "fields": {
      "name": {
        "name": "Название",
        "type": "string",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "quantity": {
        "name": "Количество",
        "type": "number",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      },
      "is_vip": {
        "name": "VIP",
        "type": "bool",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "contact": {
        "name": "Контакт",
        "type": "contact",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "key": {
        "name": "Ключ",
        "type": "string",
        "is_required": true,
        "is_hidden": true,
        "is_encryptable": true
      },
      "img": {
        "name": "Изображение",
        "type": "image",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      }
    },
    "name": "Заказы",
    "is_menu": true,
    "created_at": "2019-12-09T13:51:13+00:00",
    "updated_at": "2019-12-09T13:51:13+00:00"
  }
}
```

--------------------------------

### deleteContactVariable() Usage Example

Source: https://docs.leadteh.ru/javascript-api/funkcii/deletecontactvariable

An example demonstrating how to delete a user variable named 'Город'.

```javascript
deleteContactVariable("Город");
```

--------------------------------

### deleteGlobalVariable() example

Source: https://docs.leadteh.ru/javascript-api/funkcii/deleteglobalvariable?q=

Example usage that deletes the global variable named 'Город' if it exists. The function returns nothing.

```javascript
deleteGlobalVariable("Город");
```

--------------------------------

### GET /api/v1/getContactVariables

Source: https://docs.leadteh.ru/rabota-s-api/kontakty/polzovatelskie-peremennye?q=

Метод для получения списка пользовательских переменных контакта.

```APIDOC
## GET /api/v1/getContactVariables

### Description
Этот метод позволяет получить список пользовательских переменных для определенного контакта.

### Method
GET

### Endpoint
https://app.leadteh.ru/api/v1/getContactVariables

### Parameters
#### Path Parameters
- **contact_id** (string) - Required - ID контакта.

### Response
#### Success Response (200)
- **data** (array) - Список переменных.
- **data[].id** (integer) - ID записи переменной.
- **data[].value** (string) - Значение переменной.
- **data[].created_at** (string) - Дата создания.
- **data[].updated_at** (string) - Дата обновления.
- **data[].variable** (object) - Объект переменной.
- **data[].variable.id** (integer) - ID переменной.
- **data[].variable.name** (string) - Имя переменной.
- **data[].variable.created_at** (string) - Дата создания переменной.
- **data[].variable.updated_at** (string) - Дата обновления переменной.
- **links** (object) - Объект ссылок пагинации.
- **meta** (object) - Метаданные пагинации.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "value": "Значение переменной",
      "created_at": "2019-10-22T20:54:20+00:00",
      "updated_at": "2019-10-22T20:54:31+00:00",
      "variable": {
        "id": 14,
        "name": "Имя переменной",
        "created_at": "2019-10-22T20:54:20+00:00",
        "updated_at": "2019-10-22T20:54:20+00:00"
      }
    },
    {
      "id": 2,
      "value": "Москва",
      "created_at": "2019-10-22T20:54:20+00:00",
      "updated_at": "2019-10-22T20:54:31+00:00",
      "variable": {
        "id": 25,
        "name": "Город",
        "created_at": "2019-10-22T20:54:20+00:00",
        "updated_at": "2019-10-22T20:54:20+00:00"
      }
    }
  ],
  "links": {
    "first": "https://leadteh.ru/api/v1/getContactVariables?page=1",
    "last": "https://leadteh.ru/api/v1/getContactVariables?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://leadteh.ru/api/v1/getContactVariables",
    "per_page": 100,
    "to": 2,
    "total": 2
  }
}
```

#### Error Response (422)
- **message** (string) - Сообщение об ошибке.
- **errors** (object) - Объект с ошибками валидации.

#### Error Response Example
```json
{
  "message": "The given data was invalid.",
  "errors": {
    "contact_id": [
      "Поле contact id обязательно для заполнения."
    ]
  }
}
```
```

--------------------------------

### GET /api/v1/getContactCryptoAccounts

Source: https://docs.leadteh.ru/rabota-s-api/kontakty/svobodnye-scheta?q=

Получить список счетов указанного контакта. Требуется параметр contact_id.

```APIDOC
## GET /api/v1/getContactCryptoAccounts

### Description
Получить список счетов указанного контакта.

### Method
GET

### Endpoint
https://app.leadteh.ru/api/v1/getContactCryptoAccounts

### Parameters
#### Query Parameters
- **contact_id** (integer) - Required - ID контакта.

### Response
#### Success Response (200)
- **data** (array) - Список счетов.
  - **id** (integer) - ID счета.
  - **currency** (string) - Код валюты.
  - **amount** (string) - Сумма на счете.
  - **created_at** (string) - Дата создания.
  - **updated_at** (string) - Дата обновления.

#### Response Example
{
  "data": [
    {
      "id": 2,
      "currency": "BTC",
      "amount": "0.24624642624",
      "created_at": "2019-12-24T11:19:42+00:00",
      "updated_at": "2019-12-24T11:21:57+00:00"
    }
  ]
}
```

--------------------------------

### POST /api/v1/createListSchema

Source: https://docs.leadteh.ru/rabota-s-api/spiski/schema-spiska

Метод позволяет создать новую схему списка. В теле запроса передаются параметры схемы, включая поля и их настройки.

```APIDOC
## POST /api/v1/createListSchema

### Description
Метод позволяет создать новую схему списка.

### Method
POST

### Endpoint
https://app.leadteh.ru/api/v1/createListSchema

### Parameters
#### Request Body
- **is_menu** (boolean) - Required - Отображать ссылку на список в меню в интерфейсе
- **name** (string) - Optional - Название списка
- **bot_id** (integer) - Optional - ID бота, если вы хотите привязать список к боту
- **fields** (object) - Optional - Объект полей схемы. Каждое поле содержит:
  - **name** (string) - название поля
  - **slug** (string) - уникальная строка поля (не должно начинаться с цифры)
  - **type** (string) - тип поля (string, number, boolean, contact, bot) - см. ниже.
  - **is_required** (boolean) - обязательность заполнения поля
  - **is_hidden** (boolean) - скрыть поле из интерфейса?
  - **is_encryptable** (boolean) - шифровать поле для хранения в БД? По таким полям нельзя делать фильтрацию и сортировку

### Response
#### Success Response (200)
Запрос успешно обработан.

#### Response Example
{
  "data": {
    "id": "5dee51518a7ab32ecf060265",
    "fields": {
      "name": {
        "name": "Название",
        "type": "string",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "quantity": {
        "name": "Количество",
        "type": "number",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      },
      "is_vip": {
        "name": "VIP",
        "type": "bool",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "contact": {
        "name": "Контакт",
        "type": "contact",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "key": {
        "name": "Ключ",
        "type": "string",
        "is_required": true,
        "is_hidden": true,
        "is_encryptable": true
      },
      "img": {
        "name": "Изображение",
        "type": "image",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      }
    },
    "name": "Заказы",
    "is_menu": true,
    "created_at": "2019-12-09T13:51:13+00:00",
    "updated_at": "2019-12-09T13:51:13+00:00"
  }
}

#### Error Response (422)
Переданы некорректные данные.

#### Error Response Example
{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "Поле Имя обязательно для заполнения."
    ],
    "fields": [
      "Поле fields обязательно для заполнения."
    ]
  }
}

### Типы поля fields["type"]
- **string** - строка/текст
- **number** - число
- **boolean** - логический тип
- **contact** - id контакта
- **bot** - id бота
- **image** - изображение
```

--------------------------------

### POST /api/v1/decodeShortLink

Source: https://docs.leadteh.ru/rabota-s-api/dopolnitelnye-metody/ssylki-na-mediafaily

Метод позволяет получить длинную ссылку на фото/видео/аудио, отправленное пользователем в бот, чтобы в дальнейшем можно было переслать данный медиафайл. Срок действия ссылки составляет 1 час.

```APIDOC
## POST /api/v1/decodeShortLink

### Description
Метод позволяет получить длинную ссылку на фото/видео/аудио, отправленное пользователем в бот, чтобы в дальнейшем можно было переслать данный медиафайл. Срок действия ссылки составляет 1 час.

### Method
POST

### Endpoint
https://app.leadteh.ru/api/v1/decodeShortLink

### Parameters
#### Request Body
- **url** (string) - Required - Короткая ссылка на медиафайл, хранящаяся в пользовательской переменной

### Response
#### Success Response (200)
- **data.url** (string) - Длинная ссылка на медиафайл

#### Response Example
{
  "data": {
    "url": "https://eva.botsister.ru/c818de47-0679-4206-aa21-84c6f6386879/file-100.jpg?expires_at=1708766653&s=MRoafvhQxYBPya0j&sign=e2ef51adb72aae6ae4e2ea46e0c3993754ac29a89fe996d9bc9015b1ffbd800f"
  }
}

#### Error Response (422)
- **message** (string) - Сообщение об ошибке
- **errors.url** (array of strings) - Список ошибок для поля url

#### Error Response Example
{
  "message": "The given data was invalid.",
  "errors": {
    "url": [
      "Поле url имеет ошибочный формат URL."
    ]
  }
}
```

--------------------------------

### GET /api/v1/getContactAccounts

Source: https://docs.leadteh.ru/rabota-s-api/kontakty/scheta

Получить список счетов указанного контакта. Требуется параметр contact_id.

```APIDOC
## GET /api/v1/getContactAccounts

### Description
Получить список счетов указанного контакта.

### Method
GET

### Endpoint
https://app.leadteh.ru/api/v1/getContactAccounts

### Parameters
#### Query Parameters
- **contact_id** (integer) - Required - ID контакта

### Response
#### Success Response (200)
- **data** (array) - Список счетов
  - **id** (integer) - ID счета
  - **currency** (string) - Валюта
  - **amount** (integer) - Сумма в минимальной денежной единице
  - **amount_note** (string) - Сумма с валютой
  - **created_at** (string) - Дата создания
  - **updated_at** (string) - Дата обновления

#### Response Example
{
  "data": [
    {
      "id": 1,
      "currency": "USD",
      "amount": 17500,
      "amount_note": "175 USD",
      "created_at": "2019-11-29T13:33:35+00:00",
      "updated_at": "2019-11-30T07:08:57+00:00"
    }
  ]
}
```

--------------------------------

### setContactByTelegramId() example

Source: https://docs.leadteh.ru/javascript-api/funkcii/setcontactvariable-1

Sets the contact for Telegram contact ID 1. After execution, the script runs for that contact.

```javascript
setContactByTelegramId(1)
```

--------------------------------

### POST /api/v1/sendMessageToWhatsApp

Source: https://docs.leadteh.ru/rabota-s-api/soobsheniya

Отправляет сообщение на WhatsApp по номеру телефона. Требует, чтобы отправка данных контакта в запросе была отключена.

```APIDOC
## POST /api/v1/sendMessageToWhatsApp

### Description
Отправляет сообщение на WhatsApp по номеру телефона. Требует, чтобы отправка данных контакта в запросе была отключена.

### Method
POST

### Endpoint
https://app.leadteh.ru/api/v1/sendMessageToWhatsApp

### Parameters
#### Request Body
- **bot_id** (integer) - Опционально - ID бота контакта.
- **phone** (string) - Опционально - Номер телефона.
- **text** (string) - Опционально - Сообщение.
- **name** (string) - Опционально - Имя контакта, необходимо отправлять когда вы пишите данному контакту в первый раз.

### Response
#### Success Response (200)
Успешный ответ.

#### Response Example
{
    "data": {
          "id": 1,
          "phone": "79991234567",
          "name": "Иван Иванов",
          "messenger": "whatsapp",
          "created_at": "2019-05-10T10:38:28+00:00"
    }
}

### Notes
- Ограничение: не больше 1-го сообщения в секунду.
```

--------------------------------

### GET /api/v1/getListSchema

Source: https://docs.leadteh.ru/rabota-s-api/spiski/schema-spiska?q=

Retrieves the schema of a list by its ID. The response contains the schema fields, their types, and metadata.

```APIDOC
## GET /api/v1/getListSchema

### Description
Retrieves the schema of a list by its ID. The response contains the schema fields, their types, and metadata.

### Method
GET

### Endpoint
https://app.leadteh.ru/api/v1/getListSchema

### Parameters
#### Query Parameters
- **schema_id** (string) - Required - ID of the schema

### Response
#### Success Response (200)
- **data** (object) - The schema object
  - **id** (string) - Schema ID
  - **fields** (object) - Object containing field definitions
    - **field_name** (object) - Field definition
      - **name** (string) - Field display name
      - **type** (string) - Field type (string, number, bool, contact, image)
      - **is_required** (boolean) - Whether the field is required
      - **is_hidden** (boolean) - Whether the field is hidden
      - **is_encryptable** (boolean) - Whether the field is encrypted
  - **name** (string) - List name
  - **is_menu** (boolean) - Whether the list is shown in the menu
  - **created_at** (string) - Creation timestamp
  - **updated_at** (string) - Last update timestamp

#### Response Example
{
  "data": {
    "id": "5dee4800c2cc5a38ec797235",
    "fields": {
      "name": {
        "name": "Название",
        "type": "string",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "quantity": {
        "name": "Количество",
        "type": "number",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      },
      "is_vip": {
        "name": "VIP",
        "type": "bool",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "contact": {
        "name": "Контакт",
        "type": "contact",
        "is_required": true,
        "is_hidden": false,
        "is_encryptable": false
      },
      "key": {
        "name": "Ключ",
        "type": "string",
        "is_required": true,
        "is_hidden": true,
        "is_encryptable": true
      },
      "img": {
        "name": "Изображение",
        "type": "image",
        "is_required": false,
        "is_hidden": false,
        "is_encryptable": false
      }
    },
    "name": "Заказы",
    "is_menu": false,
    "created_at": "2019-12-09T13:11:28+00:00",
    "updated_at": "2019-12-09T13:11:28+00:00"
  }
}
```

--------------------------------

### POST /api/v1/sendMessage (по ID контакта)

Source: https://docs.leadteh.ru/rabota-s-api/soobsheniya

Отправляет сообщение по ID контакта. Требует, чтобы отправка данных контакта в запросе была отключена.

```APIDOC
## POST /api/v1/sendMessage

### Description
Отправляет сообщение по ID контакта. Требует, чтобы отправка данных контакта в запросе была отключена.

### Method
POST

### Endpoint
https://app.leadteh.ru/api/v1/sendMessage

### Parameters
#### Query Parameters
- **file** (string) - Опционально - URL на файл.
- **image** (string) - Опционально - URL на картинку.
- **contact_id** (integer) - Опционально - ID контакта.
- **text** (string) - Опционально - Сообщение.

### Response
#### Success Response (200)
Сообщение успешно отправлено.

#### Response Example
{
    "success": true
}

#### Error Response (403)
Доступ запрещен.

#### Response Example
{
    "message": "Forbidden"
}

#### Error Response (422)
Переданные данные некорректны.

#### Response Example
{
  "message": "The given data was invalid.",
  "errors": {
    "contact_id": [
      "Поле contact id обязательно для заполнения, когда messenger \/ bot id \/ contact external id не указано."
    ],
    "text": [
      "Поле text обязательно для заполнения, когда ни одно из image \/ file не указано."
    ],
    "image": [
      "Поле image обязательно для заполнения, когда ни одно из text \/ file не указано."
    ],
    "file": [
      "Поле file обязательно для заполнения, когда ни одно из text \/ image не указано."
    ],
    "messenger": [
      "Поле messenger обязательно для заполнения, когда contact id не указано."
    ],
    "bot_id": [
      "Поле bot id обязательно для заполнения, когда contact id не указано."
    ],
    "contact_external_id": [
      "Поле contact external id обязательно для заполнения, когда contact id не указано."
    ]
  }
}

#### Error Response (429)
Превышен лимит отправки сообщений.

#### Response Example
{
    "error": "Достигнут лимит отправки сообщений для whatsapp"
}

#### Error Response (501)
Отправка для мессенджера еще не реализована.

#### Response Example
{
    "error": "На данный момент не реализована отправка сообщений в мессенджер контакта (icq)"
}
```
Tokens:
Raw