Реферальная система

С помощью представленных методов вы можете получить информацию о рефералах, реферерах вашего контакта.

Реферер – пользователь стоящий выше, тот кто пригласил в реферальную программу.

Реферал – пользователь стоящий ниже, тот кого пригласили в реферальную программу.

Получить рефереры контакта

GET https://app.jetbot24.ru/api/v1/getReferrers

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

Path Parameters

Name	Type	Description
api_token*	string	api токен вашего аккаунта
contact_id*	integer	id пользователя на платформе JetBot
depth	integer	Глубина дерева, мин. 1, макс. 10
is_flat	boolean	По умолчанию вы получаете информацию в виде дерева, если укажите значение этого поля в 1, то информация придет в виде списка рефереров.

Response

200 Запрос успешно обработан. Результат в виде дерева

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

Получить рефералы контакта

POST https://app.jetbot24.ru/api/v1/getReferrals

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

Body Request

Name	Type	Description
api_token*	string	api токен вашего аккаунта
contact_id*	integer	id пользователя на платформе JetBot
filters	object	Поля для фильтрации данных. Например фильтр по тегу: {"tag_name": "Горячий"} {"tag_name": ["Горячий", "Холодный"]} {"tag_id": 1} {"tag_id": [1, 2]}
page	integer	Номер страницы результатов

Response

200 Запрос успешно обработан

{
 "data": [
    {
      "id": 3,
      "bot_id": 1,
      "phone": null,
      "email": null,
      "name": "Вася",
      "address": null,
      "messenger": "telegram",
      "utm": [],
      "avatar": null,
      "telegram_id": "123456",
      "telegram_username": null,
      "vk_user_id": null,
      "created_at": "2024-11-07T15:35:51+00:00",
      "unsubscribed_at": null,
      "tags": [
        "Тег 1",
        "Тег 2"
      ],
      "variables": []
    }
  ],
  "links": {
    "first": "https://app.jetbot24.ru/api/v1/getReferrals?page=1",
    "last": "https://app.jetbot24.ru/api/v1/getReferrals?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Назад",
        "active": false
      },
      {
        "url": "https://app.jetbot24.ru/api/v1/getReferrals?page=1",
        "label": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Вперёд »",
        "active": false
      }
    ],
    "path": "https://app.jetbot24.ru/api/v1/getReferrals",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Получить количество рефералов всей сети контакта

POST https://app.jetbot24.ru/api/v1/getCountReferrals

Этот метод позволяет получить количество рефералов всей сети контакта.

Body Request

Name	Type	Description
api_token*	string	api токен вашего аккаунта
contact_id*	integer	id пользователя на платформе JetBot
filters	object	Поля для фильтрации данных. Например фильтр по тегу: {"tag_name": "Горячий"} {"tag_name": ["Горячий", "Холодный"]} {"tag_id": 1} {"tag_id": [1, 2]}

Response

200 Запрос успешно обработан

{
  "data": {
    "count": 1
  }
}