REST API v1.0

API Документация

Интегрируйте WhatsApp-рассылки, чат-ботов и аналитику в ваш продукт. Полное описание API, примеры кода и руководства.

Быстрый старт

Начните отправлять сообщения через API за 4 простых шага

1

Создание аккаунта

Зарегистрируйтесь и подтвердите email

2

Получите API-ключ

Сгенерируйте ключ в настройках дашборда

3

Подключите WhatsApp

Отсканируйте QR-код для привязки

4

Отправьте первое сообщение

Используйте API или дашборд

Аутентификация

API-ключ в заголовке

Все запросы к External API требуют заголовок X-API-Key. Создайте ключ в разделе Настройки → API-ключи в вашем дашборде.

Безопасное хранение

Ключи шифруются и не хранятся в открытом виде

Rate limiting

Защита от злоупотреблений с лимитами по тарифу

Отзыв в один клик

Деактивируйте скомпрометированный ключ мгновенно

bash
# Аутентификация через X-API-Key
curl -H "X-API-Key: wz_live_abc123def456" \
  https://wazzapo.kz/api/v1/external/instances

# Ответ: 200 OK
{
  "instances": [
    {
      "name": "my-whatsapp",
      "status": "connected",
      "phone": "+7 700 123 4567"
    }
  ]
}

Примеры кода

Отправьте первое сообщение на любом языке

bash
curl -X POST https://wazzapo.kz/api/v1/external/messages/send \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "instance_name": "my-whatsapp",
    "phone": "77001234567",
    "message": "Здравствуйте! Ваш заказ готов.",
    "type": "text"
  }'

API Endpoints

Базовый URL: https://wazzapo.kz/api/v1/external

POST/api/v1/external/messages/send

Отправка текстового сообщения или медиа

instance_namephonemessagetype
GET/api/v1/external/messages

Получение истории сообщений с фильтрацией

limitoffsetphonedate_from
POST/api/v1/external/contacts

Создание или обновление контакта

phonenametagscustom_fields
GET/api/v1/external/analytics/summary

Агрегированная аналитика по сообщениям

date_fromdate_tometricgroup_by
POST/api/v1/external/broadcasts

Запуск массовой рассылки по списку контактов

contactstemplate_idschedule_at
GET/api/v1/external/instances

Список подключённых WhatsApp сессий

statuspagelimit

Rate Limits

Лимиты зависят от вашего тарифного плана

Free

60 req/min

API запросы

100/день

Сообщения

Starter

300 req/min

API запросы

5 000/день

Сообщения

Pro

1 000 req/min

API запросы

50 000/день

Сообщения

Enterprise

Без лимита

API запросы

Без лимита

Сообщения

Руководства

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

Начало работы

  • Первые шаги с платформой
  • Подключение WhatsApp устройств
  • Импорт контактов из CSV
  • Создание первой рассылки

Автоматизация

  • Создание чат-ботов без кода
  • Визуальный конструктор workflows
  • Планировщик сообщений
  • Настройка вебхуков

Аналитика

  • Отчеты по доставке
  • Метрики вовлечённости
  • Воронка продаж
  • Экспорт данных

Управление

  • Командная работа и роли
  • Биллинг и тарифы
  • Безопасность аккаунта
  • API-ключи и доступы

Часто задаваемые вопросы

Ответы на популярные вопросы по API

Готовы к интеграции?

Создайте бесплатный аккаунт и начните отправлять сообщения через API уже через 5 минут