Получить переменные подписчика

Метод contacts/getVars возвращает пользовательские переменные одного подписчика вместе с их значениями. Параметры, ответ и пример запроса.

Обновлено

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

Нужен личный токен с продуктом BotHunter — как получить. Кому доступен: владельцу сообщества и сотрудникам с ролью «Админ (полный доступ)» или «Пользователи».

Параметры

group_id
целое число
обязательный

Номер сообщества — group_id из ответа groups/get.

Пример: 123456

channel
строка
обязательный

Канал сообщества: VK, TG, OK, MAX, CHAT или AVITO — константы.

Пример: VK

uid
целое число
обязательный

Номер человека в соцсети или мессенджере, например id страницы ВКонтакте.

Пример: 102036383

count
целое число

Сколько записей вернуть: по умолчанию 100, не больше 500.

offset
целое число

Сколько записей пропустить — для выборки по страницам.

Результат

Возвращает объект: items — массив переменных, total — сколько их всего.

{
  "status": "ok",
  "response": {
    "items": [
      {
        "id": "61af67fb5bc8635f3f53b18b",
        "title": "Бонусы",
        "name": "bonus",
        "value": "150"
      },
      {
        "id": "61af67fb5bc8635f3f53b18c",
        "title": "Город",
        "name": "city",
        "value": null
      }
    ],
    "total": 2
  }
}

Коды ошибок

Общие ошибки — на странице API.

Код

Когда

7

Не передан group_id или channel, значение неверное или такого сообщества нет.

«Подписчик не найден»: такого человека нет среди подписчиков сообщества или uid неверный.

Пример запроса

Подставьте свой токен вместо <ваш_токен>.

curl
PHP
Python
JavaScript
curl -X POST https://bot-api.targethunter.ru/external-api/v2/contacts/getVars \
  -H "Authorization: Bearer <ваш_токен>" \
  -H "Content-Type: application/json" \
  -d '{"group_id": 123456, "channel": "VK", "uid": 102036383}'
$token = '<ваш_токен>';
$url = 'https://bot-api.targethunter.ru/external-api/v2/contacts/getVars';
$params = [
    'group_id' => 123456,
    'channel' => 'VK',
    'uid' => 102036383,
];

$curl = curl_init($url);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode($params),
]);

$response = json_decode(curl_exec($curl), true);
curl_close($curl);
import requests

token = '<ваш_токен>'
url = 'https://bot-api.targethunter.ru/external-api/v2/contacts/getVars'
params = {
    'group_id': 123456,
    'channel': 'VK',
    'uid': 102036383,
}

response = requests.post(url, json=params, headers={'Authorization': f'Bearer {token}'})
print(response.json())
const token = '<ваш_токен>';
const params = {
  "group_id": 123456,
  "channel": "VK",
  "uid": 102036383
};

const response = await fetch('https://bot-api.targethunter.ru/external-api/v2/contacts/getVars', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(params),
});
console.log(await response.json());