Ringflow REST API · v2

Один API для викликів, SMS і AI — створено для сучасних команд.

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— Негайно завершити активний дзвінок

SMS і MMS

POST/v2/messages— Надсилайте SMS або MMS одному одержувачу
POST/v2/messages/bulk— Пакетуйте до 1000 повідомлень на запит
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— Надання нового секретаря AI
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, і a Retry-After заголовок на 429s щоб ви могли елегантно відступити.

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

Чому 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 підтримує виробничі комунікації в масштабі.

Арджун Мехта

Начальник інженерного відділу, Zenia Health — Мумбаї

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

Перевірений клієнт

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

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

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

Перевірений клієнт

Бен Харгрівз

Керівник платформи, StackRoute — Лондон

“Кінцеві точки двоканального запису та асинхронної транскрипції врятували нас від побудови власного каналу мовлення. Ringflow просто справляється з цим, і затримка справді вражає.”

Перевірений клієнт

Надія Юсупова

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

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

Перевірений клієнт

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

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

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

Перевірений клієнт

Парк Су Джин

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

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

Перевірений клієнт

FAQ

Часті запитання

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

Увійдіть на свою інформаційну панель Ringflow, перейдіть до Налаштування → Розробник → Ключі API та натисніть Новий ключ. Кожна клавіша прив’язана до певних ресурсів (дзвінків, повідомлень, штучного інтелекту чи всіх інших) і прив’язана до одного робочого середовища.

так Кожен обліковий запис Ringflow містить постійне середовище Sandbox. Виклики ізольованого середовища використовують імітацію маршрутизації через оператора, тож ви можете перевірити повну інтеграцію, включаючи записи, AI Receptionist та веб-перехоплення, без будь-якої плати за використання або реальної телефонної лінії.

У більшості випадків від реєстрації до живого дзвінка менше 5 хвилин. Надайте номер на інформаційній панелі, скопіюйте свій ключ API та опублікуйте в /v2/calls. Наш посібник із адаптації крок за кроком розповідає про це.

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

Ringflow пропонує регіони проживання даних США та ЄС на рівні робочого простору. Угоди про ділове партнерство доступні в планах Business і Enterprise для випадків використання в охороні здоров’я. Зверніться до нашої команди, щоб отримати повний пакет документів із безпеки.

Адміністратор служби штучного інтелекту входить до планів Business і Enterprise. Облікові записи Sandbox і Starter мають доступ для читання кінцевих точок ШІ для тестування інтеграції, але для обробки викликів ШІ в реальному часі потрібна активна підписка Business або Enterprise.