Clomni

Scope-lar və endpoint-lər: zənglər, webhook-lar, hadisələr, ixrac

Son yeniləmə: 11 noyabr 2026 · 8 dəq oxunur

Zəng jurnalı, webhook abunəliyi, hadisə lenti və toplu ixrac üçün scope-lar. Webhook-un mövzuları ayrıca scope-larla açılır: conversation.* conversations:read, message.* messages:read, contact.* contacts:read istəyir. Ətraflı: App webhook-ları və hadisələr: qurmaq, mövzular, imzanın yoxlanması.

Addımlar

  1. 1

    Bu məqaləni necə oxumaq

    • Yollar https://api.clomni.ai/v1-dən sonra yazılır: GET /v1/agents tam ünvanda https://api.clomni.ai/v1/agents deməkdir. Yolda workspace ID yoxdur, çünki token bir workspace-ə bağlıdır.
    • Hər sorğuda Authorization: Bearer clomni_pat_xxx başlığı olur. Tokeni necə almaq: Developer API-də tokenlər və autentifikasiya.
    • Risk: aşağı (şəxsi məlumat yoxdur), orta (müştəri məlumatını oxuyur və ya daxili məlumatı dəyişir), yüksək (müştəriyə göndərir, silir, toplu çıxarır, canlı ayarı dəyişir).
    • Hər scope review-dan keçir, public app-da da. Ətraflı: Review: scope-ların yoxlanması və rədd səbəbləri.
    • «Əlavə verir»: write və manage eyni resursun read-ini də verir. send, delete, publish, assign, run heç nə vermir.
    • Endpoint bir neçə scope ilə açılırsa, onlardan biri kifayətdir. Scope çatmasa, API 403 insufficient_scope və cavabda required_scopes qaytarır.
    • Hər POST Idempotency-Key başlığı qəbul edir: təkrar sorğu ikinci dəfə icra olunmur.
  2. 2

    Zəngləri oxumaq (calls:read)

    Zəng jurnalını oxuyur: telefon zəngləri və WhatsApp zəngləri (istiqamət, status, müddət, söhbət, cavab verən operator). Kataloqa görə səs yazıları və transkriptlər də bu scope-a aiddir, ona görə yüksək riskdir.

    • Risk: yüksək.
    • Yoxlama: review-dan keçir və daha diqqətlə yoxlanır. Ətraflı izah və funksiyanı göstərən qısa video lazımdır, hədəf müddət 2 iş günüdür.
    • Əlavə verir: başqa scope vermir.

    Endpoint-lər:

    • GET /v1/voice_calls: Telefon zəngləri
    • GET /v1/whatsapp_calls: WhatsApp zəngləri
    • GET /v1/whatsapp_calls/{call_id}: WhatsApp zəngini oxumaq

    Nümunə:

    curl "https://api.clomni.ai/v1/whatsapp_calls" \
  -H "Authorization: Bearer clomni_pat_xxx"
    curl "https://api.clomni.ai/v1/voice_calls" \
  -H "Authorization: Bearer clomni_pat_xxx"
  3. 3

    Webhook-ları görmək (webhooks:read)

    App-ın webhook abunəliyini və çatdırılma jurnalını görmək üçündür. Webhook developer portalında, app-ın «Webhook-lar» bölməsində qurulur və jurnal orada görünür.

    • Risk: aşağı.
    • Yoxlama: review-dan keçir, aşağı riskli scope-lara tez baxılır.
    • Əlavə verir: başqa scope vermir.

    Bu scope-un /v1 API-də öz endpoint-i yoxdur.

  4. 4

    Webhook-ları idarə etmək (webhooks:write)

    Webhook abunəliyini idarə etmək üçündür. Ünvan və mövzular developer portalında seçilir. Hər mövzu öz oxuma scope-unu tələb edir: conversation.* üçün conversations:read, message.* üçün messages:read, contact.* üçün contacts:read.

    • Risk: orta.
    • Yoxlama: review-dan keçir. Bu icazə ilə hansı məlumatı, nə vaxt və nə üçün işlədəcəyinizi konkret yazın.
    • Əlavə verir: webhooks:read də verir.

    Bu scope-un /v1 API-də öz endpoint-i yoxdur.

  5. 5

    Hadisə lentini oxumaq (events:read)

    Son 30 günün hadisə lentini oxuyur: buraxılmış webhook-ları bərpa etmək və ya webhook əvəzinə sorğu ilə oxumaq üçün. Hər mövzunun öz oxuma scope-u da lazımdır, təkcə events:read boş siyahı qaytarır. Hadisələr yalnız workspace-də aktiv developer tokeni və ya quraşdırması olanda yazılır.

    • Risk: orta.
    • Yoxlama: review-dan keçir. Bu icazə ilə hansı məlumatı, nə vaxt və nə üçün işlədəcəyinizi konkret yazın.
    • Əlavə verir: başqa scope vermir.

    Endpoint-lər:

    • GET /v1/events: Hadisələri oxumaq

    Nümunə:

    curl "https://api.clomni.ai/v1/events?types=message.created,contact.updated&limit=100" \
  -H "Authorization: Bearer clomni_pat_xxx"
  6. 6

    Toplu ixrac (exports:run)

    Söhbət, mesaj və kontaktları bir faylda toplu ixrac edir (gzip JSONL). Workspace üzrə eyni anda 1 iş, 24 saatda 6 iş. Fayl linki 1 saat işləyir. Review-da məqsədi, hədəf sistemi, tezliyi və faylı nə qədər saxlayacağınızı yazın.

    • Risk: yüksək.
    • Yoxlama: review-dan keçir və daha diqqətlə yoxlanır. Ətraflı izah və funksiyanı göstərən qısa video lazımdır, hədəf müddət 2 iş günüdür.
    • Əlavə verir: başqa scope vermir.

    Endpoint-lər:

    • POST /v1/exports: İxrac başlatmaq
    • GET /v1/exports/{export_id}: İxracı oxumaq

    Nümunə:

    curl -X POST "https://api.clomni.ai/v1/exports" \
  -H "Authorization: Bearer clomni_pat_xxx" \
  -H "Content-Type: application/json" \
  -d '{"resources": ["conversations", "messages", "contacts"], "since": "2026-01-01T00:00:00Z", "until": "2026-11-01T00:00:00Z"}'
    curl "https://api.clomni.ai/v1/exports/15" \
  -H "Authorization: Bearer clomni_pat_xxx"
  7. 7

    Zəng hadisələri real vaxtda

    Zəng başlayanda, bitəndə və yazısı hazır olanda məlumatı dərhal almaq üçün workspace-in zəng webhook-ları var: onları administrator paneldə qurur, developer app lazım deyil. Bax: Zəng webhook-ları: zəngləri öz sisteminizə ötürmək.

  8. 8

    Əlaqəli məqalələr

Sənəd

Developer platforması: bələdçi v1.0 · 41 səhifə Aç Endir