Clomni

Scope-lar və endpoint-lər: kampaniyalar, axınlar, avtomatlaşdırma

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

Kampaniyalar, axınlar (flow) və avtomatlaşdırma qaydaları üçün scope-lar. Hər üçündə eyni qayda var: qaralamanı write hazırlayır, müştəriyə çatan addımı (göndərmək, aktiv etmək) ayrıca send və ya publish scope-u edir.

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

    Kampaniyaları görmək (campaigns:read)

    Kampaniyaları, versiyalarını, nəticələrini və alıcıların statusunu oxuyur.

    • 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/campaign_results: Kampaniya nəticələri
    • GET /v1/campaign_results/{campaign_result_id}: Kampaniyanın nəticəsi
    • GET /v1/campaign_results/{campaign_result_id}/contacts: Kampaniya alıcıları və statusları
    • GET /v1/campaigns: Kampaniya siyahısı
    • GET /v1/campaigns/{campaign_id}: Kampaniyanı oxumaq
    • GET /v1/campaigns/{campaign_id}/versions: Kampaniyanın versiyaları

    Nümunə:

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

    Kampaniya qaralaması (campaigns:write)

    Kampaniya qaralaması yaradır və dəyişir, dərc olunmamış dəyişikliyi ləğv edir, köhnə versiyanı bərpa edir, kampaniyanı silir. Diqqət: POST /v1/campaigns-də enabled: false yazmasanız, kampaniya aktiv yaranır və campaigns:send da tələb olunur. PATCH-də enabled: true və ya scheduled_at olanda da campaigns:send 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: campaigns:read də verir.

    Endpoint-lər:

    • POST /v1/campaigns: Kampaniya yaratmaq
    • PATCH /v1/campaigns/{campaign_id}: Kampaniyanı yeniləmək
    • DELETE /v1/campaigns/{campaign_id}: Kampaniyanı silmək
    • POST /v1/campaigns/{campaign_id}/revert: Dərc olunmamış dəyişiklikləri ləğv etmək
    • POST /v1/campaigns/{campaign_id}/versions/{version}/restore: Kampaniya versiyasını bərpa etmək

    Nümunə:

    curl -X POST "https://api.clomni.ai/v1/campaigns" \
  -H "Authorization: Bearer clomni_pat_xxx" \
  -H "Content-Type: application/json" \
  -d '{"title": "Noyabr endirimi", "inbox_id": 5, "enabled": false, "scheduled_at": 1794200000, "audience": [{"type": "Label", "id": 14}], "template_params": {"name": "november_sale", "language": "az", "category": "MARKETING", "processed_params": {"body": {"1": "15%"}}}}'
  4. 4

    Kampaniya göndərmək (campaigns:send)

    Kampaniyanı göndərir və ya planlaşdırır. Müştərilərə toplu mesaj getdiyi üçün yüksək riskdir: review-da həcmi və razılığın necə alındığını 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/campaigns/{campaign_id}/publish: Kampaniyanı dərc etmək

    Nümunə:

    curl -X POST "https://api.clomni.ai/v1/campaigns/9/publish" \
  -H "Authorization: Bearer clomni_pat_xxx"
  5. 5

    Axınları görmək (flows:read)

    Axınları, qovluqları, versiyaları, statistikasını, addım hunisini və axından keçən kontaktları oxuyur, axını problemlərə görə yoxlayı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/flow_folders: Axın qovluğu siyahısı
    • GET /v1/flow_report: Axınlar hesabatı
    • GET /v1/flow_stats: Bütün axınların statistikası
    • GET /v1/flows: Axın siyahısı
    • GET /v1/flows/{flow_id}: Axını oxumaq
    • GET /v1/flows/{flow_id}/analytics: Axının statistikası
    • GET /v1/flows/{flow_id}/analytics/contacts: Axından keçən kontaktlar
    • GET /v1/flows/{flow_id}/analytics/funnel: Axının addım hunisi
    • GET /v1/flows/{flow_id}/check: Axını problemlərə görə yoxlamaq
    • GET /v1/flows/{flow_id}/versions: Axının versiyaları
    • GET /v1/flows/{flow_id}/versions/{version_id}: Axın versiyasını oxumaq

    Nümunə:

    curl "https://api.clomni.ai/v1/flows" \
  -H "Authorization: Bearer clomni_pat_xxx"
    curl "https://api.clomni.ai/v1/flows/31/check" \
  -H "Authorization: Bearer clomni_pat_xxx"
  6. 6

    Axın qaralaması (flows:write)

    Axın qaralaması yaradır və dəyişir, surətini çıxarır, qovluğa köçürür, qovluqları idarə edir. Gövdədə status göndərmək dərc sayılır və flows:publish da tələb edir.

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

    Endpoint-lər:

    • POST /v1/flow_folders: Axın qovluğu yaratmaq
    • PATCH /v1/flow_folders/{flow_folder_id}: Qovluğu yeniləmək
    • DELETE /v1/flow_folders/{flow_folder_id}: Qovluğu silmək
    • POST /v1/flows: Axın yaratmaq
    • PATCH /v1/flows/{flow_id}: Axını yeniləmək
    • POST /v1/flows/{flow_id}/copy: Axının surətini çıxarmaq
    • PATCH /v1/flows/{flow_id}/move: Axını qovluğa köçürmək

    Sorğunun gövdəsi üçün developer.clomni.ai-dakı API reference-ə baxın.

  7. 7

    Axını aktivləşdirmək (flows:publish)

    Axını aktivləşdirir və ya söndürür, köhnə versiyanı bərpa edir, axını silir. Aktiv axın müştəriyə özü yazır, ona görə yüksək riskdir. API ilə konkret söhbətdə axını başlatmaq endpoint-i yoxdur: axını trigger, operator, AI agent və ya mobil tətbiq (Clomni.startFlow) başladır.

    • 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:

    • DELETE /v1/flows/{flow_id}: Axını silmək
    • POST /v1/flows/{flow_id}/publish: Axını aktivləşdirmək və ya söndürmək
    • POST /v1/flows/{flow_id}/versions/{version_id}/restore: Axın versiyasını bərpa etmək

    Sorğunun gövdəsi üçün developer.clomni.ai-dakı API reference-ə baxın.

  8. 8

    Avtomatlaşdırmanı görmək (automations:read)

    Avtomatlaşdırma qaydalarını oxuyur: hadisə, şərtlər, əməliyyatlar və qaydanın aktiv olub-olmaması.

    • 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/automation_rules: Avtomatlaşdırma qaydası siyahısı
    • GET /v1/automation_rules/{automation_rule_id}: Qaydanı oxumaq

    Nümunə:

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

    Qayda qaralaması (automations:write)

    Qayda qaralaması yaradır və dəyişir, aktiv etmədən. POST-da active: false yazmasanız, qayda aktiv yaranır və automations:publish da lazımdır. PATCH-də active: true da automations:publish istəyir.

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

    Endpoint-lər:

    • POST /v1/automation_rules: Avtomatlaşdırma qaydası yaratmaq
    • PATCH /v1/automation_rules/{automation_rule_id}: Qaydanı yeniləmək

    Nümunə:

    curl -X POST "https://api.clomni.ai/v1/automation_rules" \
  -H "Authorization: Bearer clomni_pat_xxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "VIP söhbətləri satış komandasına", "event_name": "conversation_created", "active": false, "conditions": [{"attribute_key": "customer_tier", "filter_operator": "equal_to", "values": ["gold"], "query_operator": null}], "actions": [{"action_name": "assign_team", "action_params": [3]}]}'
  10. 10

    Qaydanı aktivləşdirmək (automations:publish)

    Qaydanı aktivləşdirir və söndürür (PATCH ilə active), qaydanın surətini çıxarır, qaydanı silir. Aktiv qaydanın surəti də aktiv yaranır, ona görə surət də bu scope ilədir.

    • 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:

    • DELETE /v1/automation_rules/{automation_rule_id}: Qaydanı silmək
    • POST /v1/automation_rules/{automation_rule_id}/clone: Avtomatlaşdırma qaydasının surətini çıxarmaq

    Nümunə:

    curl -X PATCH "https://api.clomni.ai/v1/automation_rules/6" \
  -H "Authorization: Bearer clomni_pat_xxx" \
  -H "Content-Type: application/json" \
  -d '{"active": true}'
  11. 11

    Əlaqəli məqalələr

Sənəd

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