Справочник API
Начало работы

Введение

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

Обзор

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

Ваша граница изоляции. Заголовок X-Api-Key соответствует ровно одной рабочей области и даёт к ней полный доступ — ID workspace передавать в теле запроса не нужно.

Аккаунт

Один вход в канал = одно виртуальное устройство. Создайте аккаунт через API, авторизуйте его потоком, который поддерживает провайдер (QR, код или импорт сессии), затем отправляйте и получайте сообщения через него.

Среда выполнения

Живой процесс соединения (runtime) за каждым аккаунтом. Он запускается автоматически после успешной авторизации; его состояние доступно как runtime_status. Полную машину состояний см. в разделе «Жизненный цикл аккаунта».

Webhook

Единственная запись входящего трафика. UnifyPort не хранит историю сообщений, а пропущенные события не доставляются повторно — сначала зарегистрируйте webhook-эндпоинт и сохраняйте нужные данные при получении.

Проверка 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.
  • UnifyPort сейчас доступен избранным клиентам. Свяжитесь с командой, чтобы получить доступ к рабочей области и ваш первый API-ключ.
  • Every response (success and error) carries a top-level request_id, also returned as the X-Request-Id response header — quote it when reporting issues. Send your own X-Request-Id request header and it is echoed back as client_request_id for client-side reconciliation.

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