API и интеграции

Рассылки через REST API

Раздельное создание и запуск кампании, проверка аудитории и согласий без обещания гарантированной доставки.

Обновлено 22.08.2026
Время чтения 14 мин
Сложность Средний
Цель инструкции

Создать безопасный черновик кампании и не запустить его случайно.

Короткий маршрут

Что вы сделаете

Откройте нужный шаг сразу или идите по порядку. Проверка результата остаётся в самой инструкции.

  1. 01 Методы
  2. 02 Безопасный порядок
  3. 03 Что означает успех API
  4. 04 Ошибки и отмена

Результат: интеграция создаст проверяемый черновик; запуск останется отдельным осознанным действием.

Методы

Метод Что делает
GET /campaigns Список
GET /campaigns/{campaign} Одна кампания
POST /campaigns Создаёт черновик или запланированную запись
POST /campaigns/{id}/run Отдельно запускает или планирует

Чтение требует campaigns:read, создание и запуск — campaigns:write.

Права чтения и записи кампаний платформы
Системе отчётности не нужен campaigns:write. Разделяйте создание и чтение.

Безопасный порядок

  1. Сначала создайте только тестовую аудиторию.
  2. Проверьте согласие, назначение, канал и содержание.
  3. Создайте черновик по схеме OpenAPI.
  4. Прочитайте его через GET и проверьте статус.
  5. Не вызывайте run в автоматическом тесте.
  6. Для реального запуска введите отдельное подтверждение оператора.
curl --fail-with-body \
  -H "Authorization: Bearer $APPSMAX_API_TOKEN" \
  "https://telegram.appsmax.ru/api/v1/campaigns?page=1&per_page=20&sort=created_at"
Журнал REST API с методом и HTTP-статусом
Создание и запуск должны быть двумя различимыми записями. Сохраняйте request ID проверки.

Что означает успех API

2xx подтверждает принятие операции платформы, но не гарантирует доставку конкретному человеку. Доставка зависит от аудитории, согласия, канала, подключения и правил внешней платформы.

Ошибки и отмена

  • 403 — нет campaigns:write.
  • 409 — состояние уже изменилось; сначала перечитайте кампанию.
  • 422 — поля не соответствуют контракту.
  • 429 — остановите цикл и примените ограничение скорости.

Незапущенный тестовый черновик удалите либо архивируйте штатным способом кабинета. Не вызывайте undocumented DELETE.

Нужна помощь с запуском?

Если не хочется разбираться самостоятельно, мы можем помочь. Поможем настроить платформу под вашу задачу и быстрее запустить проект без лишних шагов.