База знаний BotVsem ⤵

< Все темы
Печать

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

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

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

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

https://app.botvsem.ru/api/v1/getReferrers

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

Path Parameters

contact_id
REQUIRED
integer

 

ID контакта

depth
OPTIONAL
integer

 

Глубина дерева, мин. 1, макс. 10.

is_flat
OPTIONAL
boolean

По умолчанию вы получаете информацию в виде дерева, если укажите значение этого поля в 1, то информация придет в виде списка рефереров.

200: OK
Запрос успешно обработан. Результат в виде дерева, включая текущий контакт.
 
{
"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.botvsem.ru/api/v1/getReferrals

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

Path Parameters

filters
OPTIONAL
object

Поля для фильтрации данных. Например фильтр по тегу: {"tag_name": "Горячий"} {"tag_name": ["Горячий", "Холодный"]} {"tag_id": 1} {"tag_id": [1, 2]}

page
OPTIONAL
integer

 

Номер страницы результатов.

contact_id
REQUIRED
integer

 

ID контакта.

200: OK
 
 

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

https://app.botvsem.ru/api/v1/getCountReferrals

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

Path Parameters

filters
OPTIONAL
object

Поля для фильтрации данных. Например фильтр по тегу: {"tag_name": "Горячий"}
{"tag_name": ["Горячий", "Холодный"]}
{"tag_id": 1}
{"tag_id": [1, 2]}

contact_id
REQUIRED
integer

 

ID контакта.

200: OK
 
{
"data": {
"count": 1
}
}
Предыдущая Свободные счета
Следующая Теги
Оглавление