developers.voxi.club

Botlar, webhooklar ve platform entegrasyonlari icin tek giris noktasi.

Voxi Developers; canli OpenAPI referansi, bot REST ve gateway akislari, signed webhook dogrulama rehberi, rate limit tablolari ve hazir Node.js ile Python orneklerini tek portalda toplar.

Getting Started

Ilk 10 dakikada Voxi entegrasyonu

  1. Sunucu yonetiminde bot veya webhook yuzeyini etkinlestir.
  2. Bot yonetimi icin /api/v1/admin/bots altindan token uret.
  3. REST cagrilarinda Authorization: Bot <token> kullan.
  4. Gercek zamanli event akisi icin /api/v1/bot/gateway/events SSE hattina baglan.
  5. Incoming webhook'larda x-voxi-signature ve x-voxi-timestamp dogrulamasini ekle.

OAuth2

Kimlik ve provider akislar

Master API su anda Google, Discord ve GitHub provider callback akislariyla platform auth yuzeyini sunuyor. Portalda bu auth endpoint'leri OpenAPI referansindan izlenebilir; 3rd-party app registration kontrati icin ayni portal future-facing onboarding rehberini barindirir.

Auth referansina git

Bot API

REST + Gateway yuzeyi

Method Path Amac
GET /api/v1/bot/@me Aktif bot bilgisi
GET /api/v1/bot/channels Erisilebilir kanal listesi
POST /api/v1/bot/channels Text, voice, stage veya forum kanal olusturma
PATCH /api/v1/bot/channels/:channelId Kanal ayarlarini guncelleme
DELETE /api/v1/bot/channels/:channelId Kanal silme
GET /api/v1/bot/channels/:channelId/messages Mesaj timeline okuma
POST /api/v1/bot/channels/:channelId/messages Text kanala mesaj gonderme
GET /api/v1/bot/gateway/events SSE event stream (message_create, member_join)

Yetkiler

Permission set

  • send_messages
  • read_messages
  • manage_channels

Header

Yetkilendirme

Authorization: Bot YOUR_BOT_TOKEN

Webhooks

Incoming ve outgoing akislari

Incoming

POST /api/v1/webhooks/incoming/:token text kanala mesaj dusurur. Payload'ta content zorunludur; opsiyonel username ve avatar_url alanlari kabul edilir.

Outgoing

POST /api/v1/webhooks/outgoing ile hedef URL ve event seti tanimlanir. Su an message_create ve member_join eventleri desteklenir.

Signing

Header'lar

x-voxi-timestamp: 1713079200
x-voxi-signature: sha256=<hex-digest>

Dogrulama

HMAC kontrolu

Signed incoming webhook'larda timestamp + raw JSON body uzerinden HMAC hesaplanir. Portal altindaki verify helper ayni kontrati kullanir.

Rate limits

Operasyonel sinirlar

Yuzey Limit Not
Bot REST 60 istek / dakika Token bazli rate bucket
Push mention create 50 alici / request Master notification endpoint validation
Event reminders 500 alici / request Reminder fan-out validation
Expo push batch 100 token / batch FCM ve APNs native batch akislariyla ayni dispatch servisi

OpenAPI

Canli referans

Asagidaki Redoc paneli repo icindeki master-api/openapi.yaml dosyasini render eder. Ayni anda calisan Swagger UI icin /docs yuzeyini de kullanabilirsin.