Clomni

Scope-lar və endpoint-lər: inbox-lar və kanallar

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

Inbox-ların ayarları, üzvləri, iş saatları və kanalların vəziyyəti üçün scope-lar. Inbox bir kanalın workspace-dəki nüsxəsidir: iki WhatsApp nömrəsi iki ayrı inbox-dur.

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

    Inbox-ları görmək (inboxes:read)

    Inbox-ları və ayarlarını oxuyur: ad, kanal növü, iş saatları, avtomatik təyinat, üzvlər. Inbox kanalın workspace-dəki nüsxəsidir, məsələn hər WhatsApp nömrəsi ayrıca inbox-dur. Kanal sirləri və tokenləri heç vaxt qaytarılmır. Təsdiqlənmiş WhatsApp şablonlarının siyahısı da bu scope ilə açılır.

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

    Endpoint-lər:

    • GET /v1/inbox_members/{inbox_id}: Inbox-un operatorları
    • GET /v1/inboxes: Inbox siyahısı
    • GET /v1/inboxes/{inbox_id}: Inbox-u oxumaq
    • GET /v1/inboxes/{inbox_id}/assignable_agents: Inbox-da təyin oluna bilən operatorlar
    • GET /v1/whatsapp/templates: Təsdiqlənmiş WhatsApp şablonları. messages:send.template ilə də açılır

    Nümunə:

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

    Inbox ayarlarını dəyişmək (inboxes:write)

    Inbox ayarlarını dəyişir: ad, salamlama, avtomatik təyinat, iş saatları və inbox-un operatorları. Gövdədə channel obyekti göndərsəniz, channels:manage da lazımdı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: inboxes:read də verir.

    Endpoint-lər:

    • POST /v1/inbox_members: Inbox-a operator əlavə etmək
    • PATCH /v1/inbox_members: Inbox operatorlarını əvəz etmək
    • DELETE /v1/inbox_members: Inbox-dan operator çıxarmaq
    • PATCH /v1/inboxes/{inbox_id}: Inbox ayarlarını dəyişmək
    • PATCH /v1/working_hours/{working_hour_id}: İş saatlarını dəyişmək

    Nümunə:

    curl -X PATCH "https://api.clomni.ai/v1/inboxes/5" \
  -H "Authorization: Bearer clomni_pat_xxx" \
  -H "Content-Type: application/json" \
  -d '{"enable_auto_assignment": true}'
    curl -X POST "https://api.clomni.ai/v1/inbox_members" \
  -H "Authorization: Bearer clomni_pat_xxx" \
  -H "Content-Type: application/json" \
  -d '{"inbox_id": 5, "user_ids": [12]}'
  4. 4

    Kanalın vəziyyətini görmək (channels:read)

    Kanalın vəziyyətini oxuyur: bağlıdır, kəsilib, QR statusu, WhatsApp nömrəsinin keyfiyyəti. Workspace-in WhatsApp nömrələrini və channel_id-lərini də qaytarır. Nömrə kəsiləndə öz sisteminizdə xəbərdarlıq açmaq üçün yaxşıdır.

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

    Endpoint-lər:

    • GET /v1/inboxes/{inbox_id}/health: Kanalın vəziyyəti
    • GET /v1/whatsapp/channels: WhatsApp nömrələri

    Nümunə:

    curl "https://api.clomni.ai/v1/whatsapp/channels" \
  -H "Authorization: Bearer clomni_pat_xxx"
    curl "https://api.clomni.ai/v1/inboxes/5/health" \
  -H "Authorization: Bearer clomni_pat_xxx"
  5. 5

    Kanalları idarə etmək (channels:manage)

    Kanal qoşmaq, ayırmaq və yenidən bağlamaq üçündür. Hazırda bu scope-un öz endpoint-i yoxdur: yalnız PATCH /v1/inboxes/{inbox_id} sorğusunun gövdəsində channel obyekti olanda tələb olunur. Kanalı paneldə qoşun.

    • 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: channels:read də verir.
  6. 6

    Əlaqəli məqalələr

Sənəd

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