Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions apps/docs/content/api/authorization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ related:
Некоторые возможности API доступны исключительно с токеном бота:

- [Удаление события](DELETE /webhooks/events/{id}) — удаление события из истории событий бота
- [Саморегистрация вебхука бота](PUT /bot/webhook) — бот сам меняет `URL` своего исходящего вебхука
- [Unfurl (разворачивание ссылок)](POST /messages/{id}/link_previews) — создание предпросмотров ссылок в сообщениях
- [Открытие представления](POST /views/open) — открытие модального окна с формой для пользователя

Expand All @@ -87,9 +88,9 @@ Authorization: Bearer <ACCESS_TOKEN>
Скоупы определяют, к каким методам API имеет доступ токен. Разные типы токенов получают скоупы по-разному:

- **Персональный токен** — вы выбираете скоупы вручную при создании и можете изменить их позже в настройках токена. Токен получит только запрошенные разрешения.
- **Токен бота** — скоупы задаются автоматически и не настраиваются. Все боты (входящие вебхуки, исходящие вебхуки, unfurl-боты) получают одинаковый фиксированный набор разрешений.
- **Токен бота** — скоупы можно выбрать при создании или редактировании бота (параметр `scopes` в методах [Новый бот](POST /bots) и [Редактирование бота](PUT /bots/{id}) либо во вкладке «API» настроек бота). Если скоупы не указаны, бот получает набор по умолчанию.

При добавлении новых скоупов в API токены ботов обновляются автоматически, а в персональных токенах новые скоупы можно включить в настройках токена.
Боту доступны и собственные скоупы самоуправления, недоступные персональным токенам: `bot_self:webhook:write` — бот сам меняет `URL` своего исходящего вебхука методом [Саморегистрация вебхука бота](PUT /bot/webhook), и `bot_self:write` — самостоятельное управление настройками бота.

Проверить скоупы текущего токена можно методом [Информация о токене](GET /oauth/token/info).

Expand Down
21 changes: 11 additions & 10 deletions apps/docs/content/api/models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,27 +43,27 @@ hideTableOfContents: true
## Статус пользователя

- [Статус сотрудника](GET /users/{user_id}/status)
- [Текущий статус](GET /profile/status)
- [Новый статус](PUT /profile/status)
- [Свой статус](GET /profile/status)
- [Новый свой статус](PUT /profile/status)
- [Новый статус сотрудника](PUT /users/{user_id}/status)
- [Удаление статуса](DELETE /profile/status)
- [Удаление своего статуса](DELETE /profile/status)
- [Удаление статуса сотрудника](DELETE /users/{user_id}/status)

<ModelSchema name="UserStatus" />

## Аватар

- [Загрузка аватара](PUT /profile/avatar)
- [Удаление аватара](DELETE /profile/avatar)
- [Загрузка своего аватара](PUT /profile/avatar)
- [Удаление своего аватара](DELETE /profile/avatar)
- [Загрузка аватара сотрудника](PUT /users/{user_id}/avatar)
- [Удаление аватара сотрудника](DELETE /users/{user_id}/avatar)

<ModelSchema name="AvatarData" />

## Сотрудник

- [Создать сотрудника](POST /users)
- [Информация о профиле](GET /profile)
- [Новый сотрудник](POST /users)
- [Свой профиль](GET /profile)
- [Информация о сотруднике](GET /users/{id})
- [Список сотрудников](GET /users)
- [Список сотрудников тега](GET /group_tags/{id}/users)
Expand Down Expand Up @@ -95,7 +95,7 @@ hideTableOfContents: true
- [Список чатов](GET /chats)
- [Поиск чатов](GET /search/chats)
- [Скачать архив экспорта](GET /chats/exports/{id})
- [Обновление чата](PUT /chats/{id})
- [Редактирование чата](PUT /chats/{id})
- [Архивация чата](PUT /chats/{id}/archive)
- [Разархивация чата](PUT /chats/{id}/unarchive)
- [Редактирование роли](PUT /chats/{id}/members/{user_id})
Expand Down Expand Up @@ -153,9 +153,10 @@ hideTableOfContents: true

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

- [Создание бота](POST /bots)
- [Получение бота](GET /bots/{id})
- [Новый бот](POST /bots)
- [Информация о боте](GET /bots/{id})
- [Редактирование бота](PUT /bots/{id})
- [Саморегистрация вебхука бота](PUT /bot/webhook)

<ModelSchema name="BotResponse" />

Expand Down
8 changes: 4 additions & 4 deletions apps/docs/content/api/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ hideHeader: true
<Card compact title="Новое сообщение" icon="MessageSquare" href="/api/messages/create" />
<Card compact title="Список сообщений чата" icon="MessagesSquare" href="/api/messages/list" />
<Card compact title="Поиск сообщений" icon="Search" href="/api/search/list-messages" />
<Card compact title="Создать чат" icon="Plus" href="/api/chats/create" />
<Card compact title="Создать сотрудника" icon="UserPlus" href="/api/users/create" />
<Card compact title="Новый статус" icon="Smile" href="/api/profile/update-status" />
<Card compact title="Новый чат" icon="Plus" href="/api/chats/create" />
<Card compact title="Новый сотрудник" icon="UserPlus" href="/api/users/create" />
<Card compact title="Новый свой статус" icon="Smile" href="/api/profile/update-status" />
<Card compact title="Новое напоминание" icon="Bell" href="/api/tasks/create" />
<Card compact title="Создание бота" icon="Bot" href="/api/bots/create" />
<Card compact title="Новый бот" icon="Bot" href="/api/bots/create" />
</CardRow>

## Основы API
Expand Down
6 changes: 3 additions & 3 deletions apps/docs/content/guides/bots/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ related:
Бота можно создать двумя способами:

- **Через интерфейс** — больше настроек (тип бота, аватар, доступы, шаблоны входящего вебхука) и наглядная пошаговая форма. Подходит для разовой ручной настройки.
- **Через API** ([Создание бота](POST /bots)) — программно, без интерфейса. Подходит для автоматизации: завести бота из своего сервиса или скрипта и сразу получить `access_token`.
- **Через API** ([Новый бот](POST /bots)) — программно, без интерфейса. Подходит для автоматизации: завести бота из своего сервиса или скрипта и сразу получить `access_token`.

## Создание бота через интерфейс

Expand Down Expand Up @@ -50,7 +50,7 @@ related:

## Создание бота через API

Бота можно создать программно методом [Создание бота](POST /bots) — без интерфейса. Это удобно, когда нужно завести бота из своего сервиса или скрипта.
Бота можно создать программно методом [Новый бот](POST /bots) — без интерфейса. Это удобно, когда нужно завести бота из своего сервиса или скрипта.

<Steps>
<Step title="Отправьте запрос на создание">
Expand All @@ -61,7 +61,7 @@ related:
</Step>
</Steps>

Получить параметры существующего бота можно методом [Получение бота](GET /bots/{id}), а изменить — методом [Редактирование бота](PUT /bots/{id}).
Получить параметры существующего бота можно методом [Информация о боте](GET /bots/{id}), а изменить — методом [Редактирование бота](PUT /bots/{id}). Бот может и сам прописать `URL` своего исходящего вебхука собственным токеном — методом [Саморегистрация вебхука бота](PUT /bot/webhook), без участия администратора.

## Профиль бота

Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/guides/n8n/advanced.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ AI Agent самостоятельно выбирает подходящий ин

Ресурс **Link Preview** позволяет формировать кастомные превью для ссылок в сообщениях бота.

Когда бот отправляет сообщение со ссылкой, Пачка может запросить у бота данные для превью. Бот может ответить через [Создание превью ссылки](POST /messages/{id}/link_previews) с заголовком, описанием и изображением.
Когда бот отправляет сообщение со ссылкой, Пачка может запросить у бота данные для превью. Бот может ответить через [Unfurl (разворачивание ссылок)](POST /messages/{id}/link_previews) с заголовком, описанием и изображением.

Подробнее — в [документации разворачивания ссылок](/guides/link-previews).

Expand Down
Loading
Loading