AISARAISAR
REST API

Каналы

Канал — подключённый источник переписки: WhatsApp, Telegram, Instagram, SIP-телефония и т.д. Подключение и первичная настройка канала (QR-код, OAuth с Meta, SIP-провижининг) выполняются через мастер в личном кабинете (my.aisar.app/settings/channels/add), а не напрямую через этот API — мастер использует отдельные, специфичные для каждого провайдера эндпоинты подключения. Через публичный REST API вы читаете список каналов и их состояние подключения, управляете жизненным циклом уже подключённого канала (пауза/возобновление/переподключение/отключение) и настраиваете правила доступа операторов к каналу.

Эндпоинты

МетодПуть
GET/v1/channels

Список каналов компании (по умолчанию без черновиков настройки).

GET/v1/channels/{channel}

Получить канал по id вместе с конфигурацией провайдера.

GET/v1/channel-types

Справочник типов каналов с их возможностями (capabilities) и провайдерами.

POST/v1/channels/{channel}/disconnect

Отключить канал (прекратить приём/отправку сообщений).

POST/v1/channels/{channel}/reconnect

Переподключить ранее отключённый канал.

POST/v1/channels/{channel}/pause

Приостановить канал (временно, без разрыва сессии).

POST/v1/channels/{channel}/resume

Возобновить работу приостановленного канала.

DELETE/v1/channels/{channel}

Удалить канал (мягкое удаление).

GET/v1/channels/{channel}/access

Правила доступа операторов/команд к каналу.

POST/v1/channels/{channel}/access

Обновить правила доступа к каналу (allow/block по команде или пользователю).

Примеры

Список подключённых каналов

Запрос

bash
curl -X GET "https://api.aisar.app/v1/channels?status=connected" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Ответ

json
{
  "data": [
    {
      "id": 3,
      "company_id": 1,
      "channel_type_id": 1,
      "provider_key": "whatsapp",
      "name": "Основной WhatsApp",
      "account_name": "+77001234567",
      "status": "connected",
      "setup_state": "ready",
      "allow_broadcasts": true,
      "allow_automations": true,
      "allow_inbound_handling": true,
      "connected_at": "2026-01-15T09:00:00Z",
      "last_inbound_at": "2026-02-09T18:00:00Z",
      "channel_type": { "id": 1, "key": "whatsapp", "name": "WhatsApp" }
    }
  ]
}

Приостановка канала

Запрос

bash
curl -X POST "https://api.aisar.app/v1/channels/3/pause" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Ответ

json
{
  "data": {
    "message": "Channel status updated.",
    "channel": {
      "id": 3,
      "status": "paused",
      "status_changed_at": "2026-02-09T18:30:00Z"
    }
  }
}