Bots

Список ботов

Боты, которых вызывающий вправе настраивать: созданные им самим и те, чьи настройки открывают ему доступ к редактированию.

Параметр query отбирает ботов по части имени, без опечаток. Токены ботов в списке не приходят — их показывают один раз при создании и при ротации.

Перечень всех ботов пространства, включая чужих, доступен владельцу на тарифе «Корпорация» — [Список ботов пространства](GET /company/bots). Там чужие боты приходят с одними лишь именем и ником, остальные настройки скрыты.

get/bots

Request

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

Query parameters

querystring
Example:задач

Поисковая фраза для фильтрации ботов по имени

limitinteger
Example:1

Количество возвращаемых сущностей за один запрос

cursorstring
Example:eyJpZCI6MTczODgxNn0

Курсор для пагинации (из meta.paginate.next_page)

Response

The request has succeeded.

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"
        ]
      }
    }
  ],
  "meta": {
    "paginate": {
      "next_page": "eyJxZCO2MiwiZGlyIjomSNYjIn3",
      "prev_page": "eyJxZCO2MiwiZGlyIjoiYXNjIn0",
      "has_next": true
    }
  }
}

Changes

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