API REFERENCE / REST

REST API referansı

Volor REST API kimlik doğrulama, temel URL, idempotency, sayfalama, hız limitleri ve kanal uç noktaları için teknik referans.

Son güncelleme: 15 Ağustos 2026Okuma: ReferansDüzenleme öner

BASE

Temel URL ve sürüm

Tüm yönetim istekleri HTTPS üzerinden yapılır. Sürüm URL üzerinde taşınır; bilinmeyen alanları görmezden gelen ileri uyumlu istemciler önerilir.

https://api.volor.io/v1

Header	Zorunlu	Açıklama
Authorization	Evet	Bearer server API key
Content-Type	Body varsa	application/json
Idempotency-Key	POST için önerilir	24 saatlik tekrar koruması
Volor-Version	İsteğe bağlı	Hesap varsayılanını override eder

POST /v1/channels

Kanal oluştur

curl https://api.volor.io/v1/channels --request POST \
  --header "Authorization: Bearer $VOLOR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: room-order-9041" \
  --data '{"name":"consultation_9041","profile":"group","region":"eu","maxParticipants":12}'

Alan	Tür	Açıklama
name	string	Proje içinde benzersiz kanal adı
profile	enum	p2p, group, webinar
region	enum	auto, eu, us veya izinli bölge
maxParticipants	integer	1–100000 profil sınırında
metadata	object	En fazla 4 KB özel bağlam

200 OK

Kanal nesnesi

Kanal nesnesi güncel katılımcı sayısını özetler. Kesin katılımcı yaşam döngüsü için webhook olaylarını kullanın.

{
  "id": "chn_01J61R0GQ2A",
  "name": "consultation_9041",
  "profile": "group",
  "region": "eu",
  "state": "idle",
  "participantCount": 0,
  "createdAt": "2026-08-15T13:00:00Z",
  "metadata": { "orderId": "9041" }
}

GET /v1/channels

Sayfalama ve filtreleme

curl "https://api.volor.io/v1/channels?limit=50&state=active" \
  --header "Authorization: Bearer $VOLOR_API_KEY"

Parametre	Varsayılan	Sınır
limit	20	1–100
after	—	Bir önceki nextCursor
state	—	idle, active, ended
createdAfter	—	ISO 8601 timestamp

Hız limitleri

429 yanıtında Retry-After header’ını izleyin. Limitler ürün ve sözleşmeye göre değişebilir; Console her proje için etkin değeri gösterir.

Kapsam	Örnek limit	Header
Project	600 istek/dk	Volor-RateLimit-Project
Endpoint	120 oluşturma/dk	Volor-RateLimit-Endpoint
Burst	30 istek/sn	Volor-RateLimit-Remaining