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

Редактирование бота

PUT/bots/{id}
bots:write

Метод для редактирования бота.

Для редактирования бота вам необходимо знать его id и указать его в URL запроса. Все редактируемые параметры бота указываются в теле запроса.

Вы не можете редактировать бота, настройки которого вам недоступны (поле «Кто может редактировать настройки бота» находится во вкладке «Основное» в настройках бота).

Параметры пути

id
integer, (int32)
*
Идентификатор бота
Пример:1738816

Тело запроса

application/json
webhook
object
*
Объект параметров вебхука редактируемого бота
name
string
Имя бота
Пример:Бот задач
Длина:
<= 255 символов
nickname
string
Никнейм бота. Должен заканчиваться на _bot.
Пример:tasks_bot
Длина:
<= 255 символов
outgoing_url
string
URL исходящего вебхука
Пример:https://www.website.com/tasks/new
events[]
array of strings
События, на которые подписан бот
Возможные значения
Пример:["message_new"]
trigger_on
string
Условие срабатывания исходящего вебхука
Возможные значения
Пример:commands
По умолчанию:
commands
commands[]
array of strings
Команды бота (триггер-слова), на которые он реагирует при trigger_on = commands. Суммарная длина команд, объединённых через запятую, не должна превышать 255 символов.
Пример:["/task","/help"]
scopes[]
array of strings
Скоупы (права доступа) токена бота. Если не указано, бот получает набор по умолчанию. Боту доступны не все скоупы: часть из них разрешена только пользовательским ролям, и попытка назначить такой скоуп возвращает 400. Служебные значения bot и all назначать нельзя.
Пример:["messages:create"]
template
string
Шаблон форматирования входящего вебхука
Пример:Заказ от {{ client }} на сумму {{ amount }} ₽
template_engine
string
Шаблонизатор для обработки шаблона входящего вебхука
Возможные значения
Пример:liquid
По умолчанию:
liquid
challenge_key
string
Название поля проверки для верификации входящего вебхука
Пример:challenge
ignore_self_messages
boolean
Игнорировать входящие сообщения, отправленные самим ботом
Пример:false
По умолчанию:
false
events_history_enabled
boolean
Сохранять историю событий бота для последующего получения через метод истории событий
Пример:false
По умолчанию:
false
who_can_add
string
Кто может добавлять бота в чаты
Возможные значения
Пример:creator
По умолчанию:
creator
can_edit[]
array of strings
Роли, которым, помимо создателя, разрешено редактировать настройки бота. Создатель может редактировать всегда. Пустой массив — редактировать может только создатель.
Возможные значения
Пример:["admin"]

Ответ

200OK
The request has succeeded.
data
object
*
Параметры бота
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[]
array of strings
*
События, на которые подписан бот
Возможные значения
Пример:["message_new"]
trigger_on
string
*
Условие срабатывания исходящего вебхука
Возможные значения
Пример:commands
commands[]
array of strings
*
Команды бота (триггер-слова)
Пример:["/task"]
scopes[]
array of strings
*
Скоупы (права доступа) токена бота. Набор по умолчанию шире того, что можно назначить явно, поэтому здесь могут встречаться значения, недоступные для явной установки.
Пример:["messages:create"]
template
nullablestring
*
Шаблон форматирования входящего вебхука. null, если не задан.
Пример:Заказ от {{ client }} на сумму {{ amount }} ₽
template_engine
string
*
Шаблонизатор для обработки шаблона входящего вебхука
Возможные значения
Пример:liquid
challenge_key
nullablestring
*
Название поля проверки для верификации входящего вебхука. null, если не задано.
Пример:challenge
ignore_self_messages
boolean
*
Игнорировать входящие сообщения, отправленные самим ботом
Пример:false
events_history_enabled
boolean
*
Сохранять историю событий бота для последующего получения через метод истории событий
Пример:false
single_chat
boolean
*
Ограничивает бота одной беседой или каналом: true — бота можно добавить только в один такой чат, false — в несколько. Личные чаты и треды в ограничение не входят.
Пример:false
can_edit[]
array of strings
*
Роли, которым, помимо создателя, разрешено редактировать настройки бота. Создатель может редактировать всегда. Пустой массив — редактировать может только создатель.
Возможные значения
Пример:["admin"]
who_can_add
string
*
Кто может добавлять бота в чаты
Возможные значения
Пример:creator
Редактирование бота
pachca bots update 1738816 \  --name='Бот задач' \  --nickname=tasks_bot \  --outgoing-url=https://www.website.com/tasks/new \  --events='["message_new"]' \  --commands='["/task","/help"]' \  --scopes='["messages:create"]' \  --template='Заказ от {{ client }} на сумму {{ amount }} ₽' \  --challenge-key=challenge \  --can-edit='["admin"]' \  --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"    }  }}