Ringflow REST API · v2

Один API для звонков, СМС и ИИ — создан для современных команд.

REST API Ringflow дает вам программный контроль над каждой частью вашего стека коммуникаций — исходящими вызовами, массовыми SMS, двухканальными записями, агентами AI Receptionist и веб-перехватчиками событий в реальном времени — и все это за единой конечной точкой с аутентификацией.

Бесплатная постоянная песочница5 минут до первого живого звонкаУровень API, поддерживаемый соглашением об уровне обслуживания

Получите свой API-ключ Просмотреть полную документацию

POST https://api.ringflow.com/v2/calls

curl -X POST https://api.ringflow.com/v2/calls \
  -H "Authorization: Bearer $RINGFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to":   "+14155550199",
    "from": "+19172544289",
    "recordDualChannel": true,
    "aiReceptionistId": "agent_rfw_support"
  }'
# 201 Created
{
  "id":       "call_rfw_2Kj8mNpQ",
  "status":   "ringing",
  "to":       "+14155550199",
  "recording": true,
  "ai":        true
}

API, поддерживаемый соглашением об уровне обслуживания·Корпоративная безопасность·БАД доступен·Редактирование записи звонков·Подписание событий HMAC·Резиденция данных в ЕС и США

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

Все, что вам нужно, ничего лишнего.

Шесть групп ресурсов, один базовый URL-адрес, одна схема аутентификации. Каждая конечная точка имеет версию, возвращает согласованный JSON и поставляется с примерами запросов/ответов в файле полная ссылка.

Голосовые вызовы

POST/v2/calls— Совершите исходящий звонок на любой номер
GET/v2/calls/:id— Получить статус, продолжительность и запись в реальном времени
POST/v2/calls/:id/transfer— Теплый или холодный перевод во время разговора
DELETE/v2/calls/:id— Немедленно завершить активный вызов

СМС и ММС

POST/v2/messages— Отправьте SMS или MMS одному получателю
POST/v2/messages/bulk— Пакетная обработка до 1 000 сообщений за запрос
GET/v2/messages/:id— Статус доставки опроса и квитанция оператора связи

Записи

POST/v2/calls/:id/record— Начать двухканальную запись разговоров
DELETE/v2/calls/:id/record— Остановить запись и активировать сохранение
POST/v2/recordings/:id/transcribe— Запросить асинхронную транскрипцию AI

AI Receptionist

POST/v2/ai/agents— Предоставьте нового администратора с искусственным интеллектом
PUT/v2/ai/agents/:id/knowledge— Часто задаваемые вопросы, документация и правила передачи сообщений
GET/v2/ai/sessions/:id/summary— Получить сводку AI после звонка

События

POST/v2/events/subscriptions— Подпишитесь на любое событие платформы
GET/v2/events/subscriptions— Список и фильтрация ваших подписок
DELETE/v2/events/subscriptions/:id— Удаление подписки на событие

Аутентификация и ключи

POST/v2/auth/tokens— Выпуск кратковременного токена на предъявителя
POST/v2/auth/keys— Создать ключ API рабочей области с ограниченной областью действия
PUT/v2/auth/keys/:id/rotate— Вращение ключей без простоев

Клиентские SDK

Идиоматические клиенты для вашего стека.

Каждый Ringflow SDK создается сначала на коде, а не на основе спецификации. Повторные попытки, курсоры пагинации и проверка веб-перехватчиков — это первоклассные вещи, а не второстепенные.

npm i @ringflow/sdk

import { Ringflow } from "@ringflow/sdk"

const client = new Ringflow({
  apiKey: process.env.RINGFLOW_API_KEY,
  region: "us-east-1",
})

// Place a call and stream status updates
const call = await client.calls.create({
  to:        "+14155550199",
  from:      "+19172544289",
  recordDualChannel: true,
  onStatus: (evt) => console.log(evt.status),
})

console.log(call.id)   // call_rfw_2Kj8mNpQ

Умные повторы с джиттером

Пагинация на основе курсора

Встроенная проверка подписи.

100% покрытие TypeScript

Ограничения ставок

Предсказуемые лимиты на каждом уровне.

Ограничения применяются для каждого рабочего пространства, а не для каждого IP-адреса. Каждый ответ несет X-RateLimit-Remaining, X-RateLimit-Resetи Retry-After заголовок включен 429 с чтобы вы могли изящно отступить.

План	устойчивый	Взрывной колпачок	Одновременные вызовы
Песочница	5 запросов/с	15 запросов/с	2 звонка
Стартер	40 запросов/с	80 запросов/с	25 звонков
Бизнес	150 запросов/с	300 запросов/с	150 звонков
ПредприятиеОбычай	Обычай	Обычай	Безлимитный

Почему Ringflow

Построен по-другому. Цены справедливые.

Большинство API-интерфейсы телефонии включить ИИ в качестве запоздалой мысли. Ringflow с нуля создал искусственный интеллект, голосовую связь и обмен сообщениями как единый согласованный API, поэтому вам не придется связывать вместе трех поставщиков.

Возможность	Ringflow	Типичная альтернатива
Единые звонки + SMS + AI в одном API		✕
Постоянная песочница — без срока действия, без карты		✕
Двухканальная запись «из коробки»		✕
AI-секретарь через конечную точку REST		✕
Доставка веб-перехватчиков с подписью HMAC
Ротация ключей API без простоев		✕
Аудит безопасности предприятия + доступность BAA		✕

Наше обязательство

REST API, созданный в соответствии с производственными стандартами.

API Ringflow предназначен для обработки реальных производственных рабочих нагрузок — согласованные ответы JSON, надежная аутентификация, четкая сигнализация ограничения скорости и постоянная «песочница» для безопасного интеграционного тестирования.

JSON-ответы

аутентификация OAuth 2.0

Заголовки ограничения скорости

Ключи идемпотентности

Повторные попытки вебхука

Версионные конечные точки

время безотказной работы 99 баллов

Тестирование в песочнице

Его любят инженерные команды в разных отраслях.

От здравоохранения до розничной торговли — API Ringflow поддерживает производственные коммуникации в любом масштабе.

Арджун Мехта

руководитель инженерного отдела, Зения Хелс — Мумбаи

“API Ringflow позволил нам встроить голосовую сортировку в наш портал пациентов за две недели. Одна только конечная точка AI Receptionist сократила объем звонков в нерабочее время на 40%.”

Проверенный клиент

Рэйчел Торрес

Вице-президент по продукту, ClearLane Finance — Остин, Техас

“Мы перевели трех поставщиков контакт-центров на Ringflow за один квартал. Унифицированная поверхность REST упростила нашу интеграцию — один поток аутентификации, одна схема веб-перехватчика и все.”

Проверенный клиент

Бен Харгривз

Руководитель платформы, StackRoute — Лондон

“Двухканальная запись и конечные точки асинхронной транскрипции избавили нас от создания собственного речевого конвейера. Ringflow просто справляется с этим, и задержка действительно впечатляет.”

Проверенный клиент

Надя Юсупова

технический директор, Orbis Retail — Дубай

“Наша конечная точка массовой рассылки SMS ежедневно без сбоев отправляет 50 000 подтверждений заказов. Квитанции о доставке попадают в наш вебхук в течение нескольких секунд — именно то, что требуется для розничной торговли.”

Проверенный клиент

Том Фицджеральд

Старший бэкэнд-инженер, Лоубридж — Чикаго Иллинойс

“Ротация ключей с нулевым временем простоя стала особенностью, которая понравилась нашей команде безопасности. Прокат ключей API без периода обслуживания — это то, чего наш старый провайдер просто не мог сделать.”

Проверенный клиент

Су-Джин Пак

Архитектор решений, Clearview SaaS — Сеул

“Go SDK идиоматичен и компилируется без ошибок при каждом запуске CI. Отмена контекста, повторные попытки и отсрочка ограничения скорости работают именно так, как вы ожидаете от первоклассного клиента.”

Проверенный клиент

Часто задаваемые вопросы

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

Войдите в свою панель управления Ringflow, перейдите в «Настройки» → «Разработчик» → «Ключи API» и нажмите «Новый ключ». Каждый ключ привязан к определенным ресурсам (вызовам, сообщениям, искусственному интеллекту или всем) и привязан к одной рабочей среде.

Да. Каждая учетная запись Ringflow включает постоянную среду «песочницы». Для вызовов в песочнице используется имитация маршрутизации оператора связи, поэтому вы можете протестировать полную интеграцию, включая записи, AI Receptionist и веб-перехватчики, без какой-либо платы за использование или реальной телефонной линии.

В большинстве случаев от регистрации до живого звонка проходит менее 5 минут. Укажите номер на панели управления, скопируйте ключ API и выполните POST в /v2/calls. Наше руководство по адаптации проведет вас через это шаг за шагом.

Каждое событие POST включает заголовок X-Ringflow-Signature-256 — дайджест HMAC-SHA256 необработанного тела запроса с ключом вашего секретного веб-перехватчика. И Node.js, и Python SDK предоставляют утилитуverifySignature(), поэтому вам никогда не придется реализовывать ее самостоятельно.

Ringflow предлагает регионы размещения данных в США и ЕС на уровне рабочей области. Соглашения о бизнес-партнерстве доступны в планах Business и Enterprise для случаев использования в сфере здравоохранения. Свяжитесь с нашей командой для получения полного пакета документации по безопасности.

Функция AI Receptionist включена в планы Business и Enterprise. Учетные записи Sandbox и Starter имеют доступ для чтения к конечным точкам AI для тестирования интеграции, но для обработки вызовов AI в реальном времени требуется активная подписка Business или Enterprise.