Получение информации о боте

Метод позволяет получить основную информацию о текущем боте: его идентификатор, логин, отображаемое имя, описание и URL вебхука.

HTTP метод: GET

URL: https://botapi.messenger.yandex.net/bot/v1/self/get

Заголовки

Authorization: OAuth <токен>

Результат

Результатом успешного запроса является ответ с кодом 200 и телом с JSON, где содержится информация о боте.

Имя параметра Обязательный Тип Описание
ok Да boolean Флаг успешности выполнения
id Да string Идентификатор бота
login Да string Логин бота
display_name Нет string Отображаемое имя бота
webhook_url Нет string URL для получения обновлений через webhook
organizations Нет integer[] Список идентификаторов организаций, к которым подключен бот

В случае ошибки возвращается соответствующий статус HTTP. Описание ошибки приходит в поле description.

Имя параметра Обязательный Тип Описание
ok Да boolean Флаг успешности выполнения
description Да string Описание ошибки

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

curl -H 'Authorization: OAuth AtXXXXXXXXXXX' 'https://botapi.messenger.yandex.net/bot/v1/self/get'

Пример успешного ответа

{
  "ok": true,
  "id": "6d8d04f7-31f7-4030-8926-305587256f0e",
  "login": "my-bot",
  "display_name": "My Bot",
  "webhook_url": "https://example.com/webhook"
}

Пример ответа с ошибкой

{"ok": false, "description": "Unauthorized"}
Предыдущая
О сервисе
Следующая
Создание чата или канала