Информация о боте

GET/bots/{id}

Настройки бота. Токен в ответе не приходит — его показывают один раз при создании бота и при вызове метода POSTРотация токена бота. Токены бота отдаёт GETСписок токенов бота.

Метод отдаёт только тех ботов, которых вызывающий вправе настраивать: своих, а также чужих, если настройки бота открывают доступ администраторам пространства или руководителям чатов, где бот состоит. На остальных метод ответит 403.

Токену со скоупом bots:write метод отвечает и без bots:read. Если при этом вы можете управлять токенами бота (permissions.recreate_token), в webhook приходят адрес входящего вебхука url, секрет подписи secret_token и тело последнего запроса на входящий вебхук last_request_body.

Перечень всех ботов пространства, включая чужих, доступен владельцу пространства на тарифе «Корпорация» — GETСписок ботов пространства.

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

Идентификатор бота

Пример:1738816

Ответ

200OK

The request has succeeded.

Параметры бота

Идентификатор бота (совпадает с user_id бота)

Пример:1738816

Имя бота

Пример:Бот задач

Никнейм бота

Пример:tasks_bot

Ссылка на аватар бота. null, если аватар не задан.

Пример:https://files.example.com/uploads/0001/0001/image.jpg

Идентификатор сотрудника, создавшего бота. null, если создатель не записан.

Пример:12

Дата и время создания бота (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ

Пример:2025-05-15T14:30:00.000Z

Сколько сотрудников авторизовали бота

Пример:3

Дата и время, когда бот последний раз работал (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ: запрос на входящий вебхук или вызов API любым токеном бота, включая токены сотрудников. null, если такого не было. Использование токена учитывается не чаще раза в минуту.

Пример:2025-05-15T14:30:00.000Z

Объект параметров вебхука

Имя бота

Пример:Бот задач

Длина:

<= 255 символов

Никнейм бота

Пример:tasks_bot

Длина:

<= 255 символов

URL исходящего вебхука. null, если исходящий вебхук у бота не настроен.

Пример:https://example.com/tasks/new

События, на которые подписан бот

Возможные значения

Пример:["message_new"]

Условие срабатывания исходящего вебхука

Возможные значения

Пример:commands

Команды бота (триггер-слова)

Пример:["/task"]

Скоупы (права доступа) токена бота. Набор по умолчанию шире того, что можно назначить явно, поэтому здесь могут встречаться значения, недоступные для явной установки.

Пример:["messages:create"]

Шаблон форматирования входящего вебхука. null, если не задан.

Пример:Заказ от {{ client }} на сумму {{ amount }} ₽

Шаблонизатор для обработки шаблона входящего вебхука

Возможные значения

Пример:liquid

Название поля проверки для верификации входящего вебхука. null, если не задано.

Пример:challenge

Показывать превью ссылок в сообщениях входящего вебхука

Пример:true

Не присылать боту события о его собственных сообщениях и реакциях

Пример:false

Сохранять историю событий бота для последующего получения через метод истории событий

Пример:false

Ограничивает бота одной беседой или каналом: true — бота можно добавить только в один такой чат, false — в несколько. Личные чаты и треды в ограничение не входят.

Пример:false

Роли, которым, помимо создателя, разрешено редактировать настройки бота. Создатель может редактировать всегда. Пустой массив — редактировать может только создатель.

Возможные значения

Пример:["admin"]

Кто может добавлять бота в чаты

Возможные значения

Пример:creator

Источник входящего вебхука. null, если входящий вебхук у бота выключен.

Возможные значения

Пример:simple

Домены, ссылки на которые бот разворачивает

Пример:["example.com"]

Дата и время последнего запроса на входящий вебхук бота (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. null, если запросов не было.

Пример:2025-05-15T14:30:00.000Z

Адрес входящего вебхука. null, если входящий вебхук у бота выключен. Приходит в ответе об одном боте токену со скоупом bots:write, который может управлять токенами бота (permissions.recreate_token).

Пример:https://api.pachca.com/webhooks/01JAXK7R3B5Y8Q2W4E6T9V1N3M

Секрет подписи исходящего вебхука: им подписан заголовок Pachca-Signature. Приходит в ответе об одном боте токену со скоупом bots:write, который может управлять токенами бота (permissions.recreate_token).

Пример:pachca_wh_3pX9vQ2mL7rT5yW8kN4bH6jF1dS0aZcVxE2uI9oP7qR3tY5wK8nM4gB6hJ1lD0fA

Тело последнего запроса на входящий вебхук бота. Длиннее 128 КБ обрезается и заканчивается на ...[truncated]. null, если запросов не было. Приходит в ответе об одном боте токену со скоупом bots:write, который может управлять токенами бота (permissions.recreate_token).

Пример:{"client": "ООО Ромашка", "amount": 15000}

Включена ли у бота авторизация от имени сотрудника

Пример:true

Параметры авторизации от имени сотрудника. Может прийти и у бота с выключенной авторизацией, поэтому включена ли она, смотрите в oauth_client_enabled. У бота без токенов может прийти null.

Идентификатор клиента для ссылки авторизации

Пример:aB3dE5fG7hJ9kL1mN3pQ5rS7tU9vW1xY

Секрет клиента в маскированном виде. Полное значение приходит в client_secret один раз: при включении серверного клиента и при ротации секрета.

Пример:cH5kR9mN...x7Qp

Где хранится секрет: true — серверное приложение, false — приложение без секрета, обмен кода по PKCE

Пример:true

Адреса возврата после согласия

Пример:["https://example.com/oauth/callback"]

Права, которые бот запрашивает у сотрудника на экране согласия

Пример:["messages:read","messages:create"]

Что вы можете делать с этим ботом

Менять авторизацию от имени сотрудника, страницу в витрине и имя бота

Пример:true

Выпускать, менять и удалять токены бота и обновлять секрет клиента

Пример:true

Удалить бота

Пример:true

Секрет клиента. Приходит один раз: при включении серверного клиента, при переходе на него и при ротации секрета.

Пример:dGhpc19pc19ub3RfYV9yZWFsX3NlY3JldA

Информация о боте

pachca bots get 1738816 \  --json \  --token YOUR_ACCESS_TOKEN

Ответ 200

{  "data": {    "id": 1738816,    "name": "Бот задач",    "nickname": "tasks_bot",    "avatar_url": null,    "creator_id": 12,    "created_at": "2025-05-15T14:30:00.000Z",    "authorized_users_count": 3,    "last_used_at": "2025-05-20T09:15:00.000Z",    "webhook": {      "name": "Бот задач",      "nickname": "tasks_bot",      "outgoing_url": "https://example.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",      "kind": "simple",      "unfurl_domains": [],      "last_request_at": "2025-05-20T09:15:00.000Z",      "url": "https://api.pachca.com/webhooks/01JAXK7R3B5Y8Q2W4E6T9V1N3M",      "secret_token": "pachca_wh_3pX9vQ2mL7rT5yW8kN4bH6jF1dS0aZcVxE2uI9oP7qR3tY5wK8nM4gB6hJ1lD0fA",      "last_request_body": "{\"client\": \"ООО Ромашка\", \"amount\": 15000}"    },    "oauth_client_enabled": true,    "oauth_client": {      "client_id": "aB3dE5fG7hJ9kL1mN3pQ5rS7tU9vW1xY",      "client_secret_preview": "dGhpc19p...ZWNy",      "confidential": true,      "redirect_uris": [        "https://example.com/oauth/callback"      ],      "scopes": [        "messages:read",        "messages:create"      ]    },    "promo": {      "description": "Собирает сводку по задачам и присылает её в чат",      "published": true,      "promo_images": []    },    "permissions": {      "update_oauth_client": true,      "recreate_token": true,      "destroy": true    }  }}