Перейти к содержимому
AISARAISAR
REST API

Быстрые ответы

Сниппеты (быстрые ответы) — заготовленные компанией текстовые шаблоны с опциональными вложенными файлами, которые оператор вставляет в чат одним действием без ручного набора текста. Эта группа управляет библиотекой сниппетов компании: список, создание, обновление, удаление и скачивание прикреплённых файлов.

Отличие от шаблонов сообщений

В отличие от шаблонов сообщений (Templates), сниппеты не проходят модерацию у провайдера и используются только внутри уже открытого 24-часового окна переписки.

Формат запроса и поля формы

Создание и обновление — multipart/form-data, так как поддерживают загрузку файлов. Поля формы:

  • name (обязательное, до 255 символов).
  • message (обязательное).
  • files[] (опционально, до 50 МБ на каждый файл).

Обновление вложений

При обновлении новые файлы докладываются через files[], а уже прикреплённые удаляются передачей их идентификаторов в remove_file_ids[].

Эндпоинты

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

Список быстрых ответов компании.

POST/v1/snippets

Создать быстрый ответ (multipart/form-data, файлы опциональны, до 50 МБ каждый).

POST/v1/snippets/{snippet}

Обновить быстрый ответ — текст, добавить/удалить файлы (multipart/form-data).

DELETE/v1/snippets/{snippet}

Удалить быстрый ответ.

GET/v1/snippets/{snippet}/files/{snippetFile}/download

Скачать файл, прикреплённый к быстрому ответу (по подписанной ссылке).

Примеры

Создание быстрого ответа

Запрос

bash
curl -X POST "https://api.aisar.app/v1/snippets" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "name=Приветствие" \
  -F "message=Здравствуйте! Чем можем помочь?" \
  -F "files[]=@/path/to/price-list.pdf"

Ответ

json
{
  "data": {
    "id": 9,
    "company_id": 1,
    "name": "Приветствие",
    "message": "Здравствуйте! Чем можем помочь?",
    "files": [
      {
        "id": 21,
        "name": "price-list.pdf",
        "size": 48213,
        "type": "application/pdf",
        "download_url": "https://api.aisar.app/v1/snippets/9/files/21/download?expires=...&signature=..."
      }
    ],
    "updated_at": "2026-02-09T18:00:00Z"
  }
}

Список быстрых ответов

Запрос

bash
curl -X GET "https://api.aisar.app/v1/snippets" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Ответ

json
{
  "data": [
    {
      "id": 9,
      "company_id": 1,
      "name": "Приветствие",
      "message": "Здравствуйте! Чем можем помочь?",
      "files": [],
      "updated_at": "2026-02-09T18:00:00Z"
    }
  ]
}

Обновление: замена вложения через remove_file_ids

Запрос

bash
curl -X POST "https://api.aisar.app/v1/snippets/9" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "name=Приветствие (обновлённое)" \
  -F "message=Здравствуйте! Рады помочь." \
  -F "files[]=@/path/to/catalog.pdf" \
  -F "remove_file_ids[]=21"

Ответ

json
{
  "data": {
    "id": 9,
    "company_id": 1,
    "name": "Приветствие (обновлённое)",
    "message": "Здравствуйте! Рады помочь.",
    "files": [
      {
        "id": 22,
        "name": "catalog.pdf",
        "size": 102400,
        "type": "application/pdf",
        "download_url": "https://api.aisar.app/v1/snippets/9/files/22/download?expires=...&signature=..."
      }
    ],
    "updated_at": "2026-02-10T09:30:00Z"
  }
}