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

Ротация токена бота

POST/bots/{id}/recreate_token
bots:write

Метод генерирует боту новый access_token и сразу инвалидирует прежний. Используйте его при компрометации токена или плановой ротации секрета в CI.

Доступен администратору, владельцу компании или создателю бота. Укажите id бота в URL запроса. Новый токен возвращается в ответе только один раз — сохраните его сразу.

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

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

Ответ

200OK
The request has succeeded.
data
object
*
Параметры созданного бота
id
integer, (int32)
*
Идентификатор бота (совпадает с user_id бота)
Пример:1738816
webhook
object
*
Объект параметров вебхука
name
string
*
Имя бота
Пример:Бот задач
nickname
string
*
Никнейм бота
Пример:tasks_bot
outgoing_url
nullablestring
*
URL исходящего вебхука
Пример: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
access_token
string
*
Токен доступа бота. Возвращается при создании бота и при ротации токена. Текущий токен также можно посмотреть и скопировать в интерфейсе — вкладка «API» настроек бота.
Пример:bm90X2FfcmVhbF90b2tlbg
Ротация токена бота
pachca bots recreate-token 1738816 \  --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    },    "access_token": "bm90X2FfcmVhbF90b2tlbg"  }}