Справочник API¶

SpeakNode предоставляет REST API для программного управления агентами, сессиями, кампаниями и другими ресурсами платформы.

Базовый URL¶

https://api.speaknode.com

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

API использует аутентификацию через Bearer-токен. Токен выдаётся сервером авторизации Keycloak по протоколу OAuth 2.0 / OpenID Connect.

Получение токена¶

Выполните запрос на получение токена:

curl -X POST "https://auth.example.com/realms/speaknode/protocol/openid-connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=your-client-id" \
  -d "client_secret=your-client-secret"

Использование токена¶

Передавайте токен в заголовке Authorization каждого запроса:

curl -X GET "https://api.speaknode.com/api/agents" \
  -H "Authorization: Bearer <your-token>"

Безопасность токена

Никогда не передавайте токен в URL-параметрах и не сохраняйте его в клиентском коде. Токен имеет ограниченный срок действия — обновляйте его по необходимости.

Основные эндпоинты¶

Ресурс	Описание
`/api/agents`	Управление агентами
`/api/sessions`	Сессии разговоров
`/api/campaigns`	Исходящие кампании
`/api/tools`	Инструменты
`/api/phone-numbers`	Номера телефонов
`/api/webhooks`	Вебхуки
`/api/spaces`	Рабочие пространства

Интерактивная документация¶

Полная спецификация API в формате OpenAPI (Swagger) доступна ниже. Вы можете просматривать все эндпоинты, параметры и модели, а также выполнять тестовые запросы.