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

Один ключ, один базовый URL, один формат ответа для SMS и messenger-эндпоинтов.

Базовый URL: https://chatvendor.net/api/v1. Передавайте ключ как Bearer-токен. Каждый ответ имеет вид {"success": true, "data": …} или {"success": false, "error": {"code", "message"}}.

Ключи создаются в панели в разделе Разработчик → API-ключи, со скоупами, ограничивающими возможности ключа, и окружением: live или test.

01
Создайте ключ
Разработчик → API-ключи → Новый ключ. Скопируйте один раз; потом виден только префикс.
02
Сделайте запрос
curl https://chatvendor.net/api/v1/me -H "Authorization: Bearer cv_live_…"
03
Слушайте события
Зарегистрируйте URL вебхука и проверяйте заголовок X-ChatVendor-Signature.

С чего начать

Ключи, scope'ы, формат ответа и первый запрос.

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

Создайте ключ в Developer → API keys и передавайте его как bearer token. Ключ — серверный секрет: никогда не кладите его в JavaScript браузера или мобильное приложение.

Authorization: Bearer cv_live_xxxxxxxxxxxx

Ключ cv_test_ проходит весь поток, но не трогает SIM и мессенджеры — интегрируйтесь, не тратя кредит. Ключи sms_, выданные до ChatVendor 2.0, продолжают работать.

Scope'ы

У каждого ключа есть scope'ы; каждый эндпоинт указывает нужный. Эндпоинтам мессенджеров также нужен тариф с API.

messages:sendОтправлять сообщения

messages:readЧитать сообщения

devices:readЧитать устройства

devices:manageУправлять устройствами

webhooks:manageУправлять webhook'ами

analytics:readЧитать аналитику

channels:readЧтение сетей и чатов

channels:writeОтправка в чаты

leads:readЧтение лидов

leads:writeУправление лидами

scenarios:manageУправление запусками сценариев

ai:useИспользовать AI

Формат ответа

Base URL https://chatvendor.net/api/v1. Каждый ответ — JSON с флагом success; у списков есть объект meta с пагинацией. Ошибки всегда в одном формате — ветвитесь по code, а не по тексту сообщения.

{
  "success": true,
  "data": { "id": "msg_01j…", "status": "queued" }
}

{
  "success": false,
  "error": { "code": "INVALID_API_KEY", "message": "…" }
}

Ваш первый запрос

01
Подключите сеть
Подключите Android-телефон для SMS или аккаунт Telegram / WhatsApp / Instagram.
02
Создать ключ
Отметьте только нужные scope'ы; начните с тестового ключа.
03
Отправьте запрос
Получите список каналов, затем отправьте сообщение — два запроса ниже.

curl https://chatvendor.net/api/v1/channels -H "Authorization: Bearer cv_live_xxxxxxxxxxxx"

curl -X POST https://chatvendor.net/api/v1/channels/1/dialogs/@username/messages \
  -H "Authorization: Bearer cv_live_xxxxxxxxxxxx" -H "Content-Type: application/json" \
  -d '{"text": "Salom! Bu API orqali yuborildi."}'

curl -X POST https://chatvendor.net/api/v1/messages \
  -H "Authorization: Bearer cv_live_xxxxxxxxxxxx" -H "Content-Type: application/json" -H "Idempotency-Key: order-1234" \
  -d '{"to": "+998901234567", "message": "Your code is 483921"}'

Справочник по разделам

Вопросы

Есть ли SDK?

Да — PHP-пакет через Composer и плагин WordPress; для других языков клиент генерируется из документа OpenAPI.

Где описаны лимиты?

В разделе о лимитах ниже и в заголовках ответа X-RateLimit-Limit и X-RateLimit-Remaining.