Справочник API

Документация для разработчиков

One API. Every Channel.

Подключайте все маршруты сообщений через единый API и получайте входящие события через стандартный Webhook.

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

Введение

UnifyPort — это один REST API плюс один стандартный поток webhook-событий для Telegram, WhatsApp, LINE, X (ранее Twitter), Zalo и TikTok. Отправляйте через POST /v1/messages, получайте всё в виде нормализованных событий — SDK отдельных провайдеров не требуются, а для Node.js, PHP, Go и Python доступны официальные SDK UnifyPort.

Обзор

Рабочая область

Рабочее пространство объединяет аккаунты для обмена сообщениями, ключи API и Webhook. Используйте его X-Api-Key при вызове API; ID пространства в теле запроса не нужен.

Аккаунт

Аккаунт для обмена сообщениями — это аккаунт Telegram, WhatsApp или другого канала, подключённый к UnifyPort. Создайте его и завершите авторизацию канала для отправки и получения сообщений.

Состояние подключения (Runtime)

Состояние подключения аккаунта к каналу. Проверяйте runtime_status отдельно от авторизации; running означает готовность подключения.

Webhook

Точка для долговременного хранения входящего трафика. В UnifyPort нет REST API чтения истории сообщений и гарантированного повтора пропущенных доставок, поэтому сначала зарегистрируйте webhook и сохраняйте события при получении. WhatsApp HistorySync может дать ограниченную best-effort непрерывность после bootstrap или reconnect, но это не полный архив.

Проверка API-ключа

Shell

curl "https://api.unifyport.ai/v1/workspace" \
  -H "X-Api-Key: <YOUR_API_KEY>"

Примечания

  • Базовый URL: https://api.unifyport.ai. Все эндпоинты /v1 аутентифицируются заголовком X-Api-Key.
  • Подготовьте API Key рабочего пространства, аккаунт WhatsApp и публичный HTTPS-приёмник Webhook. Храните API Key и секрет подписи на сервере. Проверьте ключ запросом ниже.
  • JSON success and error responses carry a top-level request_id; requests with no response body, such as successful 204 deletes, expose it only through the X-Request-Id response header. Quote that value when reporting issues. Send your own X-Request-Id request header and it is echoed as client_request_id in JSON responses for client-side reconciliation.

Дальнейшие шаги

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

От пустого workspace до первого сообщения WhatsApp и первого входящего события.

Возможности провайдеров

Какие типы сообщений, действия и события каждый канал реально поддерживает сегодня.

Получение событий

Заголовки доставки, проверка HMAC-подписи, повторные попытки и гарантии порядка.

Справочник ошибок

Конверт ошибки и все машиночитаемые коды ошибок, сгруппированные по HTTP-статусу.