Для разработчиков

Список ботов пространства

GET/company/bots
company_bots:readКорпорация

Метод для получения списка ботов всего пространства, включая тех, кто недоступен вам для редактирования. У таких ботов приходят только имя и никнейм, остальные настройки — null.

Метод доступен Владельцу пространства. Каждый запрос записывается в журнал аудита событий с типом company_bots_accessed.

Параметры строки запроса

query
string
Поисковая фраза для фильтрации ботов по имени
Пример:задач
limit
integer, (int32)
Количество возвращаемых сущностей за один запрос
Пример:1
По умолчанию:
50
Диапазон:
1 — 50
cursor
string
Курсор для пагинации (из meta.paginate.next_page)
Пример:eyJpZCI6MTczODgxNn0

Ответ

200OK
The request has succeeded.
data[]
array of objects
*
id
integer, (int32)
*
Идентификатор бота (совпадает с user_id бота)
Пример:1738816
webhook
object
*
Объект параметров вебхука
name
string
*
Имя бота
Пример:Бот задач
Длина:
<= 255 символов
nickname
string
*
Никнейм бота
Пример:tasks_bot
Длина:
<= 255 символов
outgoing_url
nullablestring
*
URL исходящего вебхука. null, если исходящий вебхук у бота не настроен.
Пример:https://www.website.com/tasks/new
events[]
nullablearray of strings
*
События, на которые подписан бот
Возможные значения
Пример:["message_new"]
trigger_on
nullablestring
*
Условие срабатывания исходящего вебхука
Возможные значения
Пример:commands
commands[]
nullablearray of strings
*
Команды бота (триггер-слова)
Пример:["/task"]
scopes[]
nullablearray of strings
*
Скоупы (права доступа) токена бота
Пример:["messages:create"]
template
nullablestring
*
Шаблон форматирования входящего вебхука. null, если не задан.
Пример:Заказ от {{ client }} на сумму {{ amount }} ₽
template_engine
nullablestring
*
Шаблонизатор для обработки шаблона входящего вебхука
Возможные значения
Пример:liquid
challenge_key
nullablestring
*
Название поля проверки для верификации входящего вебхука. null, если не задано.
Пример:challenge
ignore_self_messages
nullableboolean
*
Игнорировать входящие сообщения, отправленные самим ботом
Пример:false
events_history_enabled
nullableboolean
*
Сохранять историю событий бота для последующего получения через метод истории событий
Пример:false
single_chat
nullableboolean
*
Ограничивает бота одной беседой или каналом: true — бота можно добавить только в один такой чат, false — в несколько. Личные чаты и треды в ограничение не входят.
Пример:false
can_edit[]
nullablearray of strings
*
Роли, которым, помимо создателя, разрешено редактировать настройки бота. Создатель может редактировать всегда. Пустой массив — редактировать может только создатель.
Возможные значения
Пример:["admin"]
who_can_add
nullablestring
*
Кто может добавлять бота в чаты
Возможные значения
Пример:creator
meta
object
*
Метаданные пагинации
paginate
object
*
Вспомогательная информация
next_page
string
*
Курсор пагинации следующей страницы
Пример:eyJxZCO2MiwiZGlyIjomSNYjIn3
prev_page
string
Курсор пагинации предыдущей страницы. Используется для polling новых записей «сверху» списка.
Пример:eyJxZCO2MiwiZGlyIjoiYXNjIn0
has_next
boolean
Есть ли ещё данные на следующей странице. На последней странице — false.
Пример:true
has_prev
boolean
Есть ли ещё данные на предыдущей странице. На первом запросе без курсора — false.
Пример:false
Список ботов пространства
# Добавьте --all для автоматической пагинацииpachca bots list-company \  --query=задач \  --limit=1 \  --json \  --token YOUR_ACCESS_TOKEN
Ответ 200
{  "data": [    {      "id": 1738816,      "webhook": {        "name": "Бот задач",        "nickname": "tasks_bot",        "outgoing_url": "https://www.website.com/tasks/new",        "events": [          "message_new"        ],        "trigger_on": "commands",        "commands": [          "/task"        ],        "scopes": [          "messages:create"        ],        "template": "Заказ от {{ client }} на сумму {{ amount }} ₽",        "template_engine": "liquid",        "challenge_key": "challenge",        "link_preview_enabled": true,        "ignore_self_messages": false,        "events_history_enabled": false,        "single_chat": false,        "can_edit": [          "admin"        ],        "who_can_add": "creator"      }    },    {      "id": 1738817,      "webhook": {        "name": "Бот релизов",        "nickname": "release_bot",        "outgoing_url": null,        "events": null,        "trigger_on": null,        "commands": null,        "scopes": null,        "template": null,        "template_engine": null,        "challenge_key": null,        "link_preview_enabled": null,        "ignore_self_messages": null,        "events_history_enabled": null,        "single_chat": null,        "can_edit": null,        "who_can_add": null      }    }  ],  "meta": {    "paginate": {      "next_page": "eyJpZCI6MTczODgxN30"    }  }}