API

Rodyr Reach’i kendi sistemlerinize bağlayın. Müşteri, kampanya, asistan ve çalıştırmaları REST API ile yönetin.

Kimlik doğrulama

Her istek bir API anahtarı gerektirir. Anahtarınızı Ayarlar → API Anahtarları bölümünden oluşturun. Anahtar yalnızca oluşturma anında bir kez gösterilir; güvenli bir yerde saklayın.

Anahtarı Authorization başlığında gönderin:

Authorization: Bearer rk_live_xxxxxxxxxxxxxxxx

Not: Her anahtarın izin kapsamı (leads, campaigns, calls, personas, runs) ve dakikalık istek sınırı vardır. Anahtarı yetkisiz kişilerle paylaşmayın; sızdığında panodan iptal edin.

Yanıt biçimi

Başarılı yanıtlar veriyi data içinde döndürür; listelerde sayfalama bilgisi meta alanında gelir. Hatalar error içinde bir code ve message taşır.

{ "data": [ ... ], "meta": { "total": 120, "page": 1, "per_page": 50 } }

{ "error": { "code": "unauthorized", "message": "Invalid API key" } }

Örnek

curl https://reach.rodyr.com/api/v1/leads?per_page=50 \
  -H "Authorization: Bearer rk_live_xxxxxxxxxxxxxxxx"

curl -X POST https://reach.rodyr.com/api/v1/runs \
  -H "Authorization: Bearer rk_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"campaign_id":"...","max_calls_total":100}'

Uç noktalar

GET/api/v1/leadsMüşterileri listele (sayfalama, durum, arama)

POST/api/v1/leadsMüşteri oluştur (email veya phone zorunlu)

GET/api/v1/leads/{id}Tek müşteri

PATCH/api/v1/leads/{id}Müşteri güncelle (do_not_call dahil)

DELETE/api/v1/leads/{id}Müşteri sil

GET/api/v1/campaignsKampanyaları listele

POST/api/v1/campaignsKampanya oluştur (name zorunlu)

GET/api/v1/campaigns/{id}Tek kampanya

PATCH/api/v1/campaigns/{id}Kampanya güncelle

GET/api/v1/callsAramaları listele (kampanya, müşteri, durum)

GET/api/v1/calls/{id}Tek arama (süre, sonuç)

GET/api/v1/personasAsistanları listele

POST/api/v1/personasAsistan oluştur

GET/api/v1/runsÇalıştırmaları listele

POST/api/v1/runsÇalıştırma başlat (campaign_id zorunlu)

GET/api/v1/runs/{id}Tek çalıştırma

POST/api/v1/runs/{id}/pauseÇalıştırmayı duraklat

POST/api/v1/runs/{id}/cancelÇalıştırmayı iptal et

Gerçek zamanlı bildirimler

Aramalar tamamlandığında kendi sisteminize bildirim almak için Webhook’lar rehberine bakın.