Все боты пространства, включая тех, кто недоступен вам для редактирования. У таких ботов приходят только имя и ник, остальные настройки — null. Только тех ботов, которых вы можете настраивать, возвращает метод GETСписок ботов.
Метод доступен владельцу пространства. Каждый запрос записывается в журнал аудита событий с типом company_bots_accessed.
Параметры строки запроса
query
string
Поисковая фраза для фильтрации ботов по имени
Пример:
задачlimit
integer, (int32)
Количество возвращаемых сущностей за один запрос. Целое число вне допустимых значений заменяется ближайшей границей.
Пример:
1По умолчанию:
50Диапазон:
1 — 50cursor
string
Курсор для пагинации (из
meta.paginate.next_page)Пример:
eyJpZCI6MTczODgxNn0Ответ
200OK
The request has succeeded.
data[]
array of objects
*id
integer, (int32)
*Идентификатор бота (совпадает с
user_id бота)Пример:
1738816oauth_client
nullableobject
*Параметры авторизации от имени сотрудника.
null у бота, недоступного вам для редактирования. Может прийти и у бота с выключенной авторизацией, а у бота без токенов может прийти null.client_id
string
*Идентификатор клиента для ссылки авторизации
Пример:
aB3dE5fG7hJ9kL1mN3pQ5rS7tU9vW1xYclient_secret_preview
string
*Секрет клиента в маскированном виде. Полное значение приходит в
client_secret один раз: при включении серверного клиента, при переключении клиента на серверный и при ротации секрета.Пример:
cH5kR9mN...x7Qpconfidential
boolean
*Где хранится секрет:
true — серверное приложение, false — приложение без секрета, обмен кода по PKCEПример:
trueredirect_uris[]
array of strings
*Адреса возврата после согласия
Пример:
["https://example.com/oauth/callback"]scopes[]
array of strings
*Права, которые бот запрашивает у сотрудника на экране согласия
Пример:
["messages:read","messages:create"]webhook
object
*Объект параметров вебхука
name
string
*Имя бота
Пример:
Бот задачДлина:
<= 255 символовnickname
string
*Никнейм бота
Пример:
tasks_botДлина:
<= 255 символовoutgoing_url
nullablestring
*URL исходящего вебхука.
null или пустая строка, если адрес не задан: бот тогда получает события только из истории событий, если она включена.Пример:
https://example.com/tasks/newevents[]
nullablearray of strings
*События, на которые подписан бот
Возможные значения
Пример:
["message_new"]trigger_on
nullablestring
*Условие срабатывания исходящего вебхука
Возможные значения
Пример:
commandscommands[]
nullablearray of strings
*Команды бота (триггер-слова)
Пример:
["/task"]scopes[]
nullablearray of strings
*Скоупы (права доступа) токена бота
Пример:
["messages:create"]template
nullablestring
*Шаблон форматирования входящего вебхука.
null, если не задан.Пример:
Заказ от {{ client }} на сумму {{ amount }} ₽template_engine
nullablestring
*Шаблонизатор для обработки шаблона входящего вебхука
Возможные значения
Пример:
liquidchallenge_key
nullablestring
*Название поля проверки для верификации входящего вебхука.
null, если не задано.Пример:
challengelink_preview_enabled
nullableboolean
*Показывать превью ссылок в сообщениях входящего вебхука. При
true ссылки из любых сообщений этого бота, в том числе отправленных через API, получают и боты с разворачиванием ссылок.Пример:
trueignore_self_messages
nullableboolean
*Не присылать боту события о сообщениях, которые он отправил сам, и о реакциях на эти сообщения, кто бы их ни поставил или снял. Нажатия кнопок приходят всегда.
Пример:
falseevents_history_enabled
nullableboolean
*Сохранять историю событий бота для последующего получения через метод истории событий
Пример:
falsesingle_chat
nullableboolean
*Ограничивает бота одной беседой или каналом:
true — бота можно добавить только в один такой чат, false — в несколько. Личные чаты и треды в ограничение не входят.Пример:
falsecan_edit[]
nullablearray of strings
*Роли, которым, помимо создателя, разрешено редактировать настройки бота. Создатель может редактировать всегда. Пустой массив — редактировать может только создатель.
Возможные значения
Пример:
["admin"]who_can_add
nullablestring
*Кто может добавлять бота в чаты
Возможные значения
Пример:
creatormeta
object
*Метаданные пагинации
paginate
object
*Вспомогательная информация
next_page
string
*Курсор пагинации следующей страницы
Пример:
eyJxZCO2MiwiZGlyIjomSNYjIn3prev_page
string
Курсор пагинации предыдущей страницы. Используется для polling новых записей «сверху» списка.
Пример:
eyJxZCO2MiwiZGlyIjoiYXNjIn0has_next
boolean
Есть ли ещё данные на следующей странице. На последней странице —
false.Пример:
truehas_prev
boolean
Есть ли ещё данные на предыдущей странице. На первом запросе без курсора —
false.Пример:
false