REST API

Calleague uygulama API'sini Bearer belirteciyle çağırın — çağrı başlatın ve listeleyin, asistanları okuyun, JSON yanıtlarını işleyin.

Calleague REST API'si, panelde yaptıklarınızı koddan yapmanıza olanak tanır: ses asistanlarını yönetin, çağrı başlatıp inceleyin ve hesabınızın verilerini okuyun. Bu sayfa temel adresi, Bearer kimlik doğrulamayı ve uyarlayabileceğiniz örnek bir curl isteğiyle yanıtını kapsar.

Temel adres

Tüm istekler Calleague çalışma alanı API'nize gider. Bir kez tanımlayıp tekrar kullanın:

# Örnek temel adres — kendi çalışma alanınızı kullanın
export CALLEAGUE_BASE="https://app.calleague.ai"

Kimlik doğrulama

Her istek, standart Authorization başlığında Bearer belirteci olarak bir API anahtarı taşır:

Authorization: Bearer <API_ANAHTARINIZ>

Anahtarları uygulama içindeki hesap ayarlarınızdan oluşturur, adlandırır ve iptal edersiniz. Bir anahtar sizin izinlerinizi devralır; bu yüzden entegrasyonun ihtiyaç duyduğu kadar yetkiyle sınırlayın ve sızması durumunda yenileyin.

🔒

Bir anahtarı asla betiklere, depolara veya belgelere gömmeyin. Kendi gizli anahtar deponuzda tutun ve çalışma zamanında ekleyin. Burada gösterilen anahtarlar gerçek kimlik bilgileri değil, yer tutuculardır.

Baştan sona bir istek

Aşağıdaki görsel, tipik bir kimliği doğrulanmış isteğin ve JSON yanıtının şeklini gösterir.

API isteği ve yanıtı

curl örneği

Aşağıdaki örnek gösterim amaçlıdır — yol, gövde ve alan adları, garantili bir canlı rota değil, istek şeklini gösteren genel yer tutuculardır. Üzerinde çalıştığınız kaynağa göre uyarlayın.

# Yalnızca gösterim — genel yer tutucular, garantili canlı rota değil
curl -s -X POST "$CALLEAGUE_BASE/api/v1/calls" \
  -H "Authorization: Bearer $CALLEAGUE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "assistantId": "<asistan-id>",
        "to": "+9XXXXXXXXXX"
      }'

Başarılı bir yanıt JSON'dur. Yaygın bir şekil, sonucu bir code / data zarfına sarar:

{
  "code": 200,
  "statusText": "",
  "data": {
    "callId": "<cagri-id>",
    "status": "queued",
    "createdAt": "2026-01-01T12:00:00.000Z"
  }
}

Kaynakları listelemek sayfalanmış bir şekil döndürür — boş bir listeyi zarif biçimde işleyin:

curl -s "$CALLEAGUE_BASE/api/v1/calls?page=1&pageSize=20" \
  -H "Authorization: Bearer $CALLEAGUE_API_KEY"

{
  "code": 200,
  "data": {
    "total": 0,
    "list": []
  }
}

💡

Herhangi bir yanıtı kendi kodunuzda işlerken, .map() gibi dizi yöntemlerini çağırmadan önce savunmacı kontroller (isteğe bağlı zincirleme / null birleştirme) uygulayın. Bir liste uç noktası geçerli biçimde boş bir list döndürebilir; dolu bir şekil varsaymak en yaygın entegrasyon hatasıdır.

Hatalar

Kimlik doğrulama hataları bir hata zarfı döndürür — Authorization: Bearer başlığının var olduğunu ve anahtarın hâlâ geçerli olduğunu yeniden kontrol edin.
JSON gövdesi gönderen isteklerde her zaman Content-Type: application/json ayarlayın.
Liste uç noktaları, döndürecek bir şey olmadığında başarısız olmak yerine boş bir list döndürür — bu durumu ele alın.

İlgili

Webhook ve olaylar — çağrı yaşam döngüsü olaylarını gerçek zamanlı alın.
MCP — Calleague'ü Model Context Protocol istemcilerine bağlayın.