Публичный API
Публичный API Pleep v1 — шаблонные сообщения WhatsApp, выгрузка диалогов, этапы лида и исходящие вебхуки
Публичный API Pleep позволяет связать Pleep с вашими системами: отправлять шаблонные сообщения WhatsApp, выгружать диалоги, читать и менять этап лида, а также получать события в момент, когда они происходят.
Что можно делать через API
- Отправлять шаблонные сообщения — инициировать отправку WhatsApp-сообщений из ваших систем без входа в личный кабинет
- Массовая отправка — отправлять нескольким получателям в одном запросе
- Выгружать диалоги — получать переписку по номерам или диапазону дат, вместе с текущим этапом лида
- Управлять этапами лида — читать и менять этап в воронке по идентификатору диалога
- Получать события — исходящие вебхуки вместо опроса API
- Поддержка обоих каналов WABA — работает с WABA Coexistence (Meta Cloud API) и устаревшим WABA (GupShup)
Начало работы
- Создайте API-ключ в личном кабинете
- Выберите нужный раздел: Отправка шаблонного сообщения, Получение диалогов, Этапы лида или Исходящие вебхуки
- Выполните ваш первый API-запрос
Версия API
Текущая версия API — v1. Все эндпоинты имеют префикс /api/v1/.
Аутентификация
Все API-запросы требуют API-ключ, передаваемый в заголовке X-API-Key. Создать и управлять API-ключами можно в личном кабинете → Разработчикам.
Храните API-ключ в безопасности
API-ключ отображается только один раз при создании. Сохраните его в надёжном месте. Если вы его потеряете, отзовите старый ключ и создайте новый.
Лимиты запросов
По умолчанию API допускает 30 запросов в минуту на один API-ключ. У методов этапов лида отдельный лимит — 60 запросов в минуту. При превышении вы получите ошибку 429 с кодом RATE_LIMITED. Подождите и повторите запрос через некоторое время.
Исходящие вебхуки под этот лимит не попадают: там Pleep вызывает вас, а не наоборот.
Базовый URL
Все API-запросы отправляются на базовый URL вашего инстанса Pleep: