Bots

Новый бот

Создаёт бота в пространстве и сразу отдаёт его access_token. Сохраните токен при создании: тот же самый повторно не показывают, останется перевыпустить его методом [Ротация токена бота](POST /bots/{id}/recreate_token).

Созданный бот ещё никуда не пишет. В беседу и канал он пишет только как участник, а добавляют его как сотрудника — методом [Добавление пользователей](POST /chats/{id}/members), передав id бота. В канале бот получает роль редактора. Личные сообщения и треды в открытых чатах членства не требуют.

Входящий вебхук бота отправляет сообщение сразу во все беседы и каналы, где бот состоит, поэтому набор его чатов и решает, куда оно попадёт. Токен для этого не нужен, достаточно адреса вебхука. Чтобы написать в один конкретный чат, берите метод [Новое сообщение](POST /messages) — вот там токен уже нужен.

Ник обязан заканчиваться на _bot и быть свободным в пространстве. Ограничение single_chat задаётся только здесь: при редактировании бота оно уже не меняется.

post/bots

Request

  • Base URL: https://api.pachca.com/api/shared/v1
  • URL: https://api.pachca.com/api/shared/v1/bots
  • Auth: HTTP bearer

Request body

Example request

{
  "webhook": {
    "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",
    "link_preview_enabled": true,
    "can_edit": [
      "admin"
    ]
  }
}

Response

The request has succeeded and a new resource has been created as a result.

Example response

{
  "data": {
    "id": 1738816,
    "webhook": {
      "name": "Бот задач",
      "nickname": "tasks_bot",
      "outgoing_url": "https://www.website.com/tasks/new",
      "events": [
        "message_new"
      ],
      "commands": [
        "/task"
      ],
      "scopes": [
        "messages:create"
      ],
      "template": "Заказ от {{ client }} на сумму {{ amount }} ₽",
      "challenge_key": "challenge",
      "link_preview_enabled": true,
      "can_edit": [
        "admin"
      ]
    },
    "access_token": "bm90X2FfcmVhbF90b2tlbg"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.