API для разработчиков

Личное сообщение одним POST-запросом.

REST API для вашей CRM на тарифе Business: контакты, диалоги, сделки, задачи, цепочки и сообщения в Telegram, X и общем ящике соцсетей. Bearer-авторизация, ключи с ограниченными правами, идемпотентность, заголовки лимитов и исходящие вебхуки. SDK не нужен.

  • JSON поверх HTTPS
  • Быстрые ответы
  • Надёжность заложена в основу

Последнее обновление:

Выберите свой стек

Один эндпоинт. Четыре языка.

Один JSON-контракт. Скопировали, вставили, запустили. Полная спецификация OpenAPI описывает каждый эндпоинт, каждую ошибку и каждый payload вебхука.

curl -X POST https://api.pinlyx.com/v1/telegram/messages \  -H "Authorization: Bearer csk_live_***" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{"accountId":7421,"username":"sarah_miller","text":"Добро пожаловать"}'

Полный справочник и каталог ошибок: docs.pinlyx.com/api

Авторизация

Ключи с правами. По умолчанию минимум доступа.

Создавайте API-ключи с ограниченными правами: только чтение для аналитических дашбордов, запись для боевых отправщиков, управление для автоматизации операций. Меняйте ключи без простоя: на время перехода старый и новый действуют одновременно, и ничего не ломается.

  • Bearer-авторизация

    Передавайте Authorization: Bearer csk_live_… в каждом запросе. Боевые и тестовые ключи легко отличить на глаз, так что рабочие процессы в безопасности.

  • Ограниченные права

    Выдайте ключу ровно те права, которые ему нужны. Утёкший ключ от дашборда никогда не сможет отправить сообщение.

  • Замена без простоя

    Выпустите новый ключ, выкатите его и отзовите старый. В переходный период действуют оба, поэтому лавины ошибок 401 не будет.

Боевой отправщикБоевой
csk_live_a4f9_
Права
  • contacts:readПросмотр, поиск и чтение контактов и их диалогов.
  • telegram:readПроверка статуса сообщения Telegram в очереди.
  • analytics:readСтатистика по воронке, цепочкам и аккаунтам.
  • telegram:sendПостановка сообщений Telegram в очередь с ваших аккаунтов.
  • contacts:writeСоздание, изменение и теги контактов.
  • sequences:writeЗапись контактов в цепочки, пауза и возобновление.
  • webhooks:writeРегистрация и замена эндпоинтов вебхуков.
Надёжность

Контроль нагрузки, который ничего не скрывает.

Благодаря ключам идемпотентности повторные запросы безопасны: одно и то же сообщение никогда не уйдёт дважды. Заголовки лимитов подсказывают клиенту, когда притормозить, ещё до того, как придёт ошибка 429.

Ответ · 200 OK187 ms
X-RateLimit-Limit
60
# запросов в минуту на один ключ
X-RateLimit-Remaining
48
# осталось в текущем окне
X-RateLimit-Reset
1778077380
# Unix-время сброса окна
Retry-After
12
# при 429 подождите столько секунд
  • Ключи идемпотентности

    Передавайте Idempotency-Key при каждой записи. Повтор с тем же ключом в течение 24 часов вернёт исходный ответ, а не отправит сообщение снова.

  • Лимиты на каждый ключ

    По умолчанию каждый API-ключ допускает 60 запросов в минуту, лимит настраивается для каждого ключа. Затем отправка в Telegram идёт в темпе самого аккаунта: по умолчанию 20 сообщений в час и пауза 10 секунд, с автоматическим ожиданием при flood-wait.

  • Стабильный каталог ошибок

    Каждая ошибка возвращает стабильный Error, по которому удобно ветвить логику, и понятный человеку Message, который можно показать пользователю. Формат JSON одинаков на всех эндпоинтах.

Вебхуки

Исходящие вебхуки на каждое событие.

Получайте 31 событие CRM в реальном времени. Подписи HMAC-SHA256, автоматические повторы с экспоненциальной задержкой и журнал доставок, где любую доставку можно повторить.

Другие события
  • message.sent
  • contact.created
  • pipeline.stage_changed
  • sequence.completed
  • outreach.replied
  • task.completed
  • support.ticket.created
  • subscription.changed
POSTyour-handlerдоставлено
{  "event": "message.received",  "id": "8c1f4b9e2d7a4c03b5e6f1a2",  "deliveredAt": "2026-05-06T14:32:18Z",    "channel": "telegram",    "contactId": 8821,    "counterparty": "@sarah_miller",    "text": "Здравствуйте, можете прислать демо?"}
Проверка при полученииNode.js
const sig = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');if ('sha256=' + sig !== headers['x-webhook-signature']) return 401;

Начните, когда будете готовы

Стройте на Pinlyx. Запуск за минуты.

На тарифе Business создайте ключ в панели, вставьте команду curl и посмотрите, как сообщение встаёт в очередь. Справочник OpenAPI описывает каждый эндпоинт и каждую ошибку.

  • На тарифе Business
  • Ключи создаются в панели
  • Вебхуки с подписью HMAC