Получить шаги бота

Метод bots/getSteps возвращает шаги бота — те же, что в списке выбора шага в интерфейсе. Вывод по страницам через count и offset, пример запроса.

Обновлено

Показывает шаги бота — те же, что в списке выбора шага в интерфейсе.

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

Параметры

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

ID бота — id из ответа bots/get.

Пример: 607d97c6a01c6a25972ed95e

count
целое число

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

offset
целое число

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

Результат

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

{
  "status": "ok",
  "response": {
    "items": [
      {
        "id": "607d97c6a01c6a25972ed960",
        "title": "Приветствие",
        "contain": "messages",
        "contain_name": "Сообщение",
        "is_start": false
      },
      {
        "id": "607d97c6a01c6a25972ed95f",
        "title": "Получено новое входящее сообщение",
        "contain": null,
        "contain_name": null,
        "is_start": true
      }
    ],
    "total": 2
  }
}

Коды ошибок

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

Код

Когда

7

«Бот не найден»: бота с таким bot_id нет или он из чужого сообщества. Та же ошибка, если bot_id не передан или записан неверно.

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

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

curl
PHP
Python
JavaScript
curl -X POST https://bot-api.targethunter.ru/external-api/v2/bots/getSteps \
  -H "Authorization: Bearer <ваш_токен>" \
  -H "Content-Type: application/json" \
  -d '{"bot_id": "607d97c6a01c6a25972ed95e"}'
$token = '<ваш_токен>';
$url = 'https://bot-api.targethunter.ru/external-api/v2/bots/getSteps';
$params = [
    'bot_id' => '607d97c6a01c6a25972ed95e',
];

$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/bots/getSteps'
params = {
    'bot_id': '607d97c6a01c6a25972ed95e',
}

response = requests.post(url, json=params, headers={'Authorization': f'Bearer {token}'})
print(response.json())
const token = '<ваш_токен>';
const params = {
  "bot_id": "607d97c6a01c6a25972ed95e"
};

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