Clomni

Hansı scope lazımdır: istəyinizə görə scope və endpoint seçimi

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

Scope app-ın nəyə icazəsi olduğunu deyir. Bu məqalədə istəyinizi tapın: yanında hansı scope-ları istəmək, riskin nə olduğu, review-da nəyə baxılacağı və hansı endpoint-ləri çağırmaq lazım olduğu yazılıb. App-ı developer.clomni.ai-da yaradırsınız, bax developer.clomni.ai-da app yaratmaq: addım-addım.

Addımlar

  1. 1

    Əsas qayda: yalnız lazım olan scope-u istəyin

    Hər scope ayrıca yoxlanır. Reviewer hər scope-un təsvir etdiyiniz funksiyaya bağlı olub-olmadığına baxır və oxumaq kifayət edirsə write-ın niyə istəndiyini soruşur. Lazımsız scope «R01: bu icazə təsvir etdiyiniz funksiya üçün lazım deyil» səbəbi ilə rədd edilir.

    Az scope-un faydası:

    • review tez keçir: hər scope üçün ən az 100 simvolluq ayrıca izah yazırsınız, yüksək risk scope üçün video da lazımdır, aşağı riskli scope-lara isə tez baxılır;
    • token sızsa, ziyan yalnız həmin scope-larla məhdud qalır;
    • public app-ı qoşan administrator razılıq ekranında app-ın nə edəcəyini aydın görür.

    Necə seçmək:

    • Oxumaq kifayət edirsə, write istəməyin. write və manage eyni resursun read-ini də verir, ona görə contacts:write olan token kontaktları oxuya da bilir.
    • Webhook işlədəcəksinizsə, mövzunun oxuma scope-unu (məsələn contacts:read) ayrıca istəyin: portal mövzunu seçəndə oxuma scope-unun özünün təsdiqlənməsini yoxlayır.
    • send, delete, publish, assign, run heç nə vermir. Məsələn messages:send mesajları oxumağa icazə vermir.
    • Scope-u sonra əlavə etmək olar: Live app Live qalır, köhnə scope-lar işləyir, review-a yalnız yeni scope gedir. Public app-da yeni scope mövcud quraşdırmalara öz-özünə düşmür, administrator app-ı yenidən qoşmalıdır.
    • Lazım olmayan scope-u silin: silmək review istəmir və dərhal qüvvəyə minir.
    • Review-dan əvvəl workspace-inizin test kanalında sınayın: messages:send və conversations:write orada review-dan əvvəl də işləyir. Bax Test kanalı: app-ı real müştərisiz sınamaq.
  2. 2

    Risk və yoxlama nə deməkdir

    • Aşağı risk: müştərinin şəxsi məlumatı yoxdur, konfiqurasiya və ya toplu rəqəmlər. Məsələn reports:read, labels:read.
    • Orta risk: müştəri məlumatını və ya mesaj mətnini oxuyur, ya da yalnız daxili məlumatı dəyişir. Məsələn conversations:read, contacts:write.
    • Yüksək risk: müştəriyə göndərir, silir, toplu çıxarır, girişi və ya canlı AI, axın, qayda ayarını dəyişir. Məsələn messages:send, exports:run, agents:manage.

    Hər scope review-dan keçir, aşağı riskli olanlar da. Aşağı riskli scope-lara tez baxılır. Yüksək risk üçün ə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. Public app-da da hər scope review-dan keçir. Ətraflı: Review: scope-ların yoxlanması və rədd səbəbləri.

  3. 3

    Hazır dəstlər

    App yaradanda hazır dəst seçə bilərsiniz: dəst scope-ları özü seçir, sonra artıq olanı silirsiniz. Dəstdə olan hər scope-u saxlamaq lazım deyil.

    • «Öz panelimdə Clomni»: conversations:read, conversations:write, conversations:assign, messages:read, messages:send, notes:write, contacts:read, contacts:write, inboxes:read, agents:read, teams:read, labels:read, canned_responses:read, webhooks:write.
    • «CRM sinxronu»: contacts:read, contacts:write, custom_attributes:read, conversations:read, messages:read, webhooks:write.
    • «BI və hesabat»: reports:read, csat:read, conversations:read, agents:read, teams:read, inboxes:read.
    • «Məlumat ixracı»: exports:run, events:read.
    • «AI idarəsi»: ai_agents:read, ai_agents:write, ai_agents:train, knowledge:read, knowledge:write, ai_logs:read.
  4. 4

    1. Mesaj və söhbətləri başqa sistemə çəkmək

    Məlumat anbarı, arxiv və ya analitika üçün söhbətləri və mesajları öz bazanıza köçürürsünüz. Əvvəl hamısını sinxron endpoint-ləri ilə bir dəfə yükləyin, sonra updated_since ilə yalnız dəyişənləri götürün. Yeni mesajı dərhal almaq üçün message.created webhook-u əlavə edin.

    • Minimal scope-lar: conversations:read, messages:read.
    • Ehtiyac olsa əlavə edin: contacts:read (kontaktın telefonu və e-poçtu da lazımdırsa); events:read (server dayananda buraxılan hadisələri lentdən geri almaq üçün).
    • Risk: orta. Review-da hər scope üçün hansı məlumatı nə üçün işlətdiyinizi yazın.

    Əsas endpoint-lər:

    • GET /v1/sync/conversations: Söhbətləri sinxron etmək
    • GET /v1/sync/messages: Mesajları sinxron etmək
    • GET /v1/conversations/{conversation_id}/messages: Söhbətin mesajları

    Ətraflı: Resept: tarixçəni ixrac etmək və davamlı sinxron, Scope-lar və endpoint-lər: söhbətlər və mesajlar.

  5. 5

    2. Bütün tarixçəni bir dəfəlik köçürmək

    Başqa sistemə keçəndə və ya arxiv saxlayanda söhbət, mesaj və kontaktları bir faylda alırsınız. İxrac fonda hazırlanır, fayl linki 1 saat işləyir. İxrac davamlı sinxron deyil: sonrakı dəyişikliklər üçün yuxarıdakı sinxron yolunu işlədin.

    • Minimal scope-lar: exports:run.
    • Ehtiyac olsa əlavə edin: events:read (ixracdan sonrakı hadisələri tutmaq üçün, mövzunun oxuma scope-u ilə birlikdə).
    • Risk: yüksək (exports:run). Review-da ətraflı izah və funksiyanı göstərən qısa video lazımdır.

    Əsas endpoint-lər:

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

    Ətraflı: Resept: tarixçəni ixrac etmək və davamlı sinxron, Scope-lar və endpoint-lər: zənglər, webhook-lar, hadisələr, ixrac.

  6. 6

    3. CRM ilə kontaktları sinxron saxlamaq

    Kontaktları Clomni ilə CRM arasında uyğun saxlayırsınız: CRM ID-ni kontaktın identifier sahəsinə yazırsınız, dəyişiklikləri sinxron və webhook ilə alırsınız, CRM-dən Clomni-yə yazırsınız. Yalnız Clomni-dən CRM-ə köçürürsünüzsə, contacts:write istəməyin.

    • Minimal scope-lar: contacts:read, contacts:write, custom_attributes:read.
    • Ehtiyac olsa əlavə edin: conversations:read (CRM-də söhbət siyahısını göstərəcəksinizsə); messages:read (CRM-də yazışmanın mətnini göstərəcəksinizsə).
    • Risk: orta. Review-da hər scope üçün hansı məlumatı nə üçün işlətdiyinizi yazın.

    Əsas endpoint-lər:

    • GET /v1/sync/contacts: Kontaktları sinxron etmək
    • GET /v1/contacts/search: Kontakt axtarışı
    • POST /v1/contacts: Kontakt yaratmaq
    • PATCH /v1/contacts/{contact_id}: Kontaktı yeniləmək
    • GET /v1/custom_attribute_definitions: Xüsusi sahə siyahısı

    Ətraflı: Resept: CRM ilə kontakt sinxronu, Scope-lar və endpoint-lər: kontaktlar, etiketlər, xüsusi sahələr, hazır cavablar.

  7. 7

    4. Saytdan və ya sistemdən WhatsApp bildirişi, təsdiq kodu göndərmək

    Sifariş, çatdırılma, təsdiq kodu kimi mesajları WhatsApp Business API (Cloud) nömrəsindən göndərirsiniz. Müştəri son 24 saatda yazmayıbsa, yalnız təsdiqlənmiş şablon gedir. QR ilə bağlanmış nömrə bu API ilə göndərmir. Şablon yoxdursa və yalnız açıq pəncərədə mətn göndərəcəksinizsə, messages:send.template əvəzinə messages:send kifayətdir.

    • Minimal scope-lar: messages:send.template.
    • Ehtiyac olsa əlavə edin: channels:read (channel_id-ni API ilə tapmaq üçün, ID paneldə də görünür); messages:read (mesajın statusunu, 24 saat pəncərəsini yoxlamaq və message.* webhook-ları üçün); messages:send (mətn və fallback_template birlikdə göndərəcəksinizsə).
    • Risk: yüksək (messages:send.template). Review-da ətraflı izah və funksiyanı göstərən qısa video lazımdır.

    Əsas endpoint-lər:

    • GET /v1/whatsapp/channels: WhatsApp nömrələri
    • GET /v1/whatsapp/templates: Təsdiqlənmiş WhatsApp şablonları
    • GET /v1/whatsapp/messages/window: Nömrə üçün 24 saat pəncərəsini yoxlamaq
    • POST /v1/whatsapp/messages: Nömrəyə WhatsApp mesajı göndərmək
    • GET /v1/whatsapp/messages/{message_id}: WhatsApp mesajının statusu

    Ətraflı: Resept: saytınızdan WhatsApp bildirişi və şablon göndərmək, Scope-lar və endpoint-lər: söhbətlər və mesajlar.

  8. 8

    5. Açıq söhbətə öz sisteminizdən cavab yazmaq

    Sisteminiz müştərinin söhbətinə mesaj yazır, məsələn sifarişin statusunu. Mesaj söhbətin kanalında gedir: WhatsApp, Instagram, Messenger, e-poçt, çat. Göndərmə fonda olur, nəticə message.updated webhook-u ilə gəlir. API ilə göndərilən mesaj tokenin sahibinin adından görünür.

    • Minimal scope-lar: messages:send, conversations:read.
    • Ehtiyac olsa əlavə edin: messages:read (cavabdan əvvəl yazışmanı oxumaq və status webhook-u üçün).
    • Risk: yüksək (messages:send). Review-da ətraflı izah və funksiyanı göstərən qısa video lazımdır.

    Əsas endpoint-lər:

    • GET /v1/conversations/search: Söhbət axtarışı
    • POST /v1/conversations/{conversation_id}/messages: Mesaj göndərmək və ya daxili qeyd yazmaq
    • POST /v1/conversations/{conversation_id}/messages/{message_id}/retry: Alınmayan mesajı yenidən göndərmək

    Ətraflı: Resept: Clomni söhbətlərini öz panelinizdə göstərmək, Scope-lar və endpoint-lər: söhbətlər və mesajlar.

  9. 9

    6. Öz AI botunuzu Clomni söhbətlərinə qoşmaq

    Botunuz yeni mesajı webhook ilə alır, cavabı söhbətə yazır, bacarmayanda söhbəti operatora və ya komandaya verir. Kod yazmadan, yalnız webhook ünvanı ilə bot qoşmaq da olar: bax «Öz botunuzu kanala qoşmaq (agent botu)». Clomni-nin öz AI agentini isə ayrıca proqramsız qurmaq olar.

    • Minimal scope-lar: messages:read, messages:send, conversations:assign.
    • Ehtiyac olsa əlavə edin: conversations:write (söhbətin statusunu dəyişmək üçün: bot danışarkən pending, operatora verəndə open); notes:write (operatora daxili qeyd buraxmaq üçün); contacts:read (müştərinin adını və xüsusi sahələrini bilmək üçün).
    • Risk: yüksək (messages:send). Review-da ətraflı izah və funksiyanı göstərən qısa video lazımdır.

    Əsas endpoint-lər:

    • GET /v1/conversations/{conversation_id}/messages: Söhbətin mesajları
    • POST /v1/conversations/{conversation_id}/messages: Mesaj göndərmək və ya daxili qeyd yazmaq
    • POST /v1/conversations/{conversation_id}/toggle_status: Söhbətin statusunu dəyişmək
    • POST /v1/conversations/{conversation_id}/assignments: Söhbəti təyin etmək

    Ətraflı: Resept: AI agentdən cavab almaq, bilik bazası və öz botunuz, Öz botunuzu kanala qoşmaq (agent botu).

  10. 10

    7. Clomni AI agentini öz saytınızda və ya tətbiqinizdə işlətmək

    Clomni-də qurulmuş AI agentə sual verib cavabı öz məhsulunuzda göstərirsiniz. Agent eyni təlimatlarla və bilik bazası ilə cavab verir, söhbətə heç nə yazmır. Hər cavab workspace-in AI kreditindən çıxılır.

    • Minimal scope-lar: ai_agents:read, ai_agents:ask.
    • Ehtiyac olsa əlavə edin: billing:read (qalan AI kreditini izləmək üçün).
    • Risk: orta. Review-da hər scope üçün hansı məlumatı nə üçün işlətdiyinizi yazın.

    Əsas endpoint-lər:

    • GET /v1/ai_agents: AI agent siyahısı
    • POST /v1/ai_agents/{ai_agent_id}/ask: AI agentdən cavab almaq
    • GET /v1/ai_credits: AI kredit balansı

    Ətraflı: Resept: AI agentdən cavab almaq, bilik bazası və öz botunuz, Scope-lar və endpoint-lər: AI agentlər, bilik bazası, kömək mərkəzi.

  11. 11

    8. AI agentin bilik bazasını avtomatik yeniləmək

    Saytınızda qayda, qiymət və ya məhsul səhifəsi dəyişəndə sisteminiz bilik bazasına yeni link və ya fayl əlavə edir, köhnəni silir, FAQ yazır. Sənəd fonda oxunur, bir neçə dəqiqə çəkə bilər.

    • Minimal scope-lar: knowledge:write, ai_agents:read.
    • Ehtiyac olsa əlavə edin: ai_agents:train (FAQ əlavə etmək və testlə yoxlamaq üçün).
    • Risk: orta. Review-da hər scope üçün hansı məlumatı nə üçün işlətdiyinizi yazın.

    Əsas endpoint-lər:

    • GET /v1/knowledge: Bilik bazası sənədləri
    • POST /v1/knowledge: Sənəd və ya link əlavə etmək
    • DELETE /v1/knowledge/{document_id}: Bilik bazası sənədini silmək
    • POST /v1/ai_agent_faqs: FAQ yazısı yaratmaq

    Ətraflı: Resept: AI agentdən cavab almaq, bilik bazası və öz botunuz, Scope-lar və endpoint-lər: AI agentlər, bilik bazası, kömək mərkəzi.

  12. 12

    9. AI agentin keyfiyyətini izləmək

    Agentin cavab verə bilmədiyi sualları, cavabların yoxlamalarını və nəticələrini öz panelinizə və ya hesabatınıza çəkirsiniz. Test sualları ilə agenti müntəzəm yoxlamaq üçün ai_agents:train əlavə edin, testlər AI kreditindən çıxılır.

    • Minimal scope-lar: ai_logs:read, ai_agents:read.
    • Ehtiyac olsa əlavə edin: ai_agents:train (test suallarını işə salmaq üçün).
    • Risk: orta. Review-da hər scope üçün hansı məlumatı nə üçün işlətdiyinizi yazın.

    Əsas endpoint-lər:

    • GET /v1/ai_agents/{ai_agent_id}/gaps: AI agentin cavab verə bilmədiyi suallar
    • GET /v1/ai_agents/{ai_agent_id}/reviews: AI cavablarının yoxlamaları
    • GET /v1/ai_agents/{ai_agent_id}/results: AI agentin nəticələri
    • POST /v1/ai_agents/{ai_agent_id}/test_runs: Test işini başlatmaq

    Ətraflı: Scope-lar və endpoint-lər: AI agentlər, bilik bazası, kömək mərkəzi.

  13. 13

    10. Hesabatları Power BI-a və ya başqa BI alətinə çəkmək

    Söhbət sayı, ilk cavab və həll müddəti, operator, inbox, komanda üzrə yekunları BI alətinizə çəkirsiniz. Toplu rəqəmlərdə müştərinin şəxsi məlumatı yoxdur, ona görə reports:read aşağı riskdir. Adları göstərmək üçün operator, komanda və inbox siyahılarını oxuyun. Hər söhbət üzrə ayrıca sətir lazımdırsa, sinxron yolunu (birinci istək) əlavə edin.

    • Minimal scope-lar: reports:read, agents:read, teams:read, inboxes:read.
    • Ehtiyac olsa əlavə edin: csat:read (müştəri məmnuniyyəti qiymətləri də lazımdırsa); sla:read (SLA pozuntularını göstərmək üçün).
    • Risk: aşağı. Hamısı aşağı riskdir, review tez keçir.

    Əsas endpoint-lər:

    • GET /v1/reports: Hesabat zaman sırası
    • GET /v1/reports/summary: Hesabat yekunları
    • GET /v1/reports/agents: Operatorlar üzrə yekunlar
    • GET /v1/summary_reports/team: Komandalar üzrə xülasə hesabatı
    • GET /v1/csat_survey_responses/metrics: Məmnuniyyət yekunları

    Ətraflı: Scope-lar və endpoint-lər: hesabatlar, CSAT, SLA, Resept: tarixçəni ixrac etmək və davamlı sinxron.

  14. 14

    11. Clomni söhbətlərini öz operator panelinizdə göstərmək

    Operatorlarınız müştəri ilə yazışmanı öz daxili sisteminizdən oxuyur, cavab yazır, söhbəti bağlayır və təyin edir. App yaradanda «Öz panelimdə Clomni» hazır dəstini seçin və lazım olmayanı silin.

    • Minimal scope-lar: conversations:read, conversations:write, conversations:assign, messages:read, messages:send.
    • Ehtiyac olsa əlavə edin: notes:write (daxili qeyd üçün); agents:read (təyin ediləcək operatorların siyahısı); teams:read (komandaya təyin etmək üçün); canned_responses:read (hazır cavab seçimi üçün).
    • Risk: yüksək (messages:send). Review-da ətraflı izah və funksiyanı göstərən qısa video lazımdır.

    Əsas endpoint-lər:

    • GET /v1/conversations: Söhbət siyahısı
    • GET /v1/conversations/{conversation_id}/messages: Söhbətin mesajları
    • POST /v1/conversations/{conversation_id}/messages: Mesaj göndərmək və ya daxili qeyd yazmaq
    • POST /v1/conversations/{conversation_id}/toggle_status: Söhbətin statusunu dəyişmək
    • POST /v1/conversations/{conversation_id}/assignments: Söhbəti təyin etmək

    Ətraflı: Resept: Clomni söhbətlərini öz panelinizdə göstərmək, Scope-lar və endpoint-lər: söhbətlər və mesajlar.

  15. 15

    12. Kampaniya hazırlamaq və göndərmək

    Kampaniyanı sisteminizdən qaralama kimi yaradırsınız, sonra göndərirsiniz və nəticəni oxuyursunuz. Yalnız qaralama hazırlayıb paneldə insan göndərirsə, campaigns:send istəməyin və yaradanda enabled: false yazın.

    • Minimal scope-lar: campaigns:write, campaigns:send.
    • Ehtiyac olsa əlavə edin: labels:read (auditoriyanı etiketlə seçmək üçün); inboxes:read (kampaniyanın gedəcəyi inbox-u seçmək üçün).
    • Risk: yüksək (campaigns:send). Review-da ətraflı izah və funksiyanı göstərən qısa video lazımdır.

    Əsas endpoint-lər:

    • POST /v1/campaigns: Kampaniya yaratmaq
    • POST /v1/campaigns/{campaign_id}/publish: Kampaniyanı dərc etmək
    • GET /v1/campaign_results: Kampaniya nəticələri
    • GET /v1/campaign_results/{campaign_result_id}/contacts: Kampaniya alıcıları və statusları

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

  16. 16

    13. Zəng qeydlərini CRM-ə yazmaq

    Telefon və WhatsApp zənglərinin jurnalını (istiqamət, status, müddət, cavab verən operator) CRM-ə çəkirsiniz. Zəng bitən kimi yazı və mətnlə birlikdə məlumat lazımdırsa, developer app əvəzinə workspace-in zəng webhook-larını qurun.

    • Minimal scope-lar: calls:read.
    • Ehtiyac olsa əlavə edin: conversations:read (zəngin aid olduğu söhbəti tapmaq üçün).
    • Risk: yüksək (calls:read). Review-da ətraflı izah və funksiyanı göstərən qısa video lazımdır.

    Əsas 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

    Ətraflı: Scope-lar və endpoint-lər: zənglər, webhook-lar, hadisələr, ixrac, Zəng webhook-ları: zəngləri öz sisteminizə ötürmək.

  17. 17

    14. Kömək mərkəzi məqalələrini idarə etmək

    Müştərilər üçün yardım saytı (portal) 5 noyabr 2026-dan Clomni paketlərində yoxdur və paneldə görünmür. help_center:* scope-ları kataloqda qalır, amma yeni inteqrasiyanı onlara bağlamayın. Məqsəd müştəri suallarına avtomatik cavabdırsa, bilik bazasını yeniləyin (yuxarıdakı istək).

    • Minimal scope-lar: knowledge:write, ai_agents:read.
    • Risk: orta. Review-da hər scope üçün hansı məlumatı nə üçün işlətdiyinizi yazın.

    Əsas endpoint-lər:

    • GET /v1/knowledge: Bilik bazası sənədləri
    • POST /v1/knowledge: Sənəd və ya link əlavə etmək

    Ətraflı: Scope-lar və endpoint-lər: AI agentlər, bilik bazası, kömək mərkəzi.

  18. 18

    15. Axınları (flow) kodla idarə etmək və işə salmaq

    Axınları yaradır, yoxlayır, aktivləşdirir və statistikasını oxuyursunuz. API ilə konkret müştəri üçün axını başlatmaq endpoint-i yoxdur: axını trigger (açar söz, hadisə), operator, AI agent və ya mobil tətbiq (Clomni.startFlow) başladır. Yalnız statistika lazımdırsa, flows:read kifayətdir.

    • Minimal scope-lar: flows:write, flows:publish.
    • Risk: yüksək (flows:publish). Review-da ətraflı izah və funksiyanı göstərən qısa video lazımdır.

    Əsas endpoint-lər:

    • GET /v1/flows: Axın siyahısı
    • GET /v1/flows/{flow_id}/check: Axını problemlərə görə yoxlamaq
    • POST /v1/flows/{flow_id}/publish: Axını aktivləşdirmək və ya söndürmək
    • GET /v1/flows/{flow_id}/analytics/funnel: Axının addım hunisi

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

  19. 19

    16. Avtomatlaşdırma qaydalarını kodla saxlamaq

    Qaydaları sisteminizdən yaradır və dəyişirsiniz. Yaradanda active: false yazın: onda qayda qaralama kimi qalır və automations:publish lazım olmur. Qaydanı yandırmaq da sizin işinizdirsə, automations:publish əlavə edin.

    • Minimal scope-lar: automations:write.
    • Ehtiyac olsa əlavə edin: automations:publish (qaydanı aktivləşdirmək və silmək üçün).
    • Risk: orta. Review-da hər scope üçün hansı məlumatı nə üçün işlətdiyinizi yazın.

    Əsas endpoint-lər:

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

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

  20. 20

    17. Operatorları və komandaları kadr sistemi ilə idarə etmək

    Yeni işçi gələndə operator kimi dəvət edirsiniz, komandaya və inbox-a əlavə edirsiniz, işdən çıxanda workspace-dən çıxarırsınız. Yalnız siyahını oxuyursunuzsa, agents:read və teams:read kifayətdir.

    • Minimal scope-lar: agents:manage, teams:write.
    • Ehtiyac olsa əlavə edin: inboxes:write (operatoru inbox-a əlavə etmək və çıxarmaq üçün).
    • Risk: yüksək (agents:manage). Review-da ətraflı izah və funksiyanı göstərən qısa video lazımdır.

    Əsas endpoint-lər:

    • POST /v1/agents: Operator dəvət etmək
    • PATCH /v1/agents/{agent_id}: Operatorun rolunu və ya statusunu dəyişmək
    • DELETE /v1/agents/{agent_id}: Operatoru workspace-dən çıxarmaq
    • POST /v1/teams/{team_id}/team_members: Komandaya operator əlavə etmək
    • POST /v1/inbox_members: Inbox-a operator əlavə etmək

    Ətraflı: Scope-lar və endpoint-lər: workspace, operatorlar, komandalar.

  21. 21

    18. Webhook ilə canlı bildiriş almaq

    Yeni mesaj, yeni söhbət, status dəyişikliyi, kontakt dəyişikliyi baş verən kimi Clomni serverinizə sorğu göndərir. Webhook ünvanını developer portalında, app-ın «Webhook-lar» bölməsində qurursunuz. Hər mövzu öz oxuma scope-unu istəyir: message.* üçün messages:read, conversation.* üçün conversations:read, contact.* üçün contacts:read. Yalnız lazım olan mövzunun scope-unu istəyin.

    • Minimal scope-lar: messages:read.
    • Ehtiyac olsa əlavə edin: conversations:read (conversation.* mövzuları üçün); contacts:read (contact.* mövzuları üçün); events:read (buraxılan hadisələri 30 gün ərzində lentdən götürmək üçün).
    • Risk: orta. Review-da hər scope üçün hansı məlumatı nə üçün işlətdiyinizi yazın.

    Əsas endpoint-lər:

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

    Ətraflı: App webhook-ları və hadisələr: qurmaq, mövzular, imzanın yoxlanması, Scope-lar və endpoint-lər: zənglər, webhook-lar, hadisələr, ixrac.

  22. 22

    19. Kanal kəsiləndə xəbər almaq

    WhatsApp nömrəsinin və ya başqa kanalın bağlı olub-olmadığını mütəmadi yoxlayıb öz monitorinq sisteminizdə xəbərdarlıq açırsınız. Bu, aşağı riskli tək scope ilə olur.

    • Minimal scope-lar: channels:read.
    • Ehtiyac olsa əlavə edin: inboxes:read (inbox-ların adlarını göstərmək üçün).
    • Risk: aşağı. Hamısı aşağı riskdir, review tez keçir.

    Əsas endpoint-lər:

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

    Ətraflı: Scope-lar və endpoint-lər: inbox-lar və kanallar.

  23. 23

    20. Sifariş sistemindən operatora daxili qeyd buraxmaq

    Sifariş, ödəniş və ya çatdırılma dəyişəndə sisteminiz söhbətə müştərinin görmədiyi qeyd yazır. Operator müştəriyə cavab verərkən vəziyyəti görür. notes:write aşağı riskdir və müştəriyə heç nə göndərmir.

    • Minimal scope-lar: notes:write, conversations:read.
    • Risk: orta. Review-da hər scope üçün hansı məlumatı nə üçün işlətdiyinizi yazın.

    Əsas endpoint-lər:

    • GET /v1/conversations/search: Söhbət axtarışı
    • POST /v1/conversations/{conversation_id}/messages: Mesaj göndərmək və ya daxili qeyd yazmaq

    Ətraflı: Scope-lar və endpoint-lər: söhbətlər və mesajlar.

  24. 24

    21. Kontaktları toplu idxal etmək

    Köhnə sistemdən və ya Excel-dən çıxan CSV faylını bir sorğu ilə yükləyirsiniz, idxal fonda işləyir. Kontaktları bir-bir yaradıb yeniləyəcəksinizsə, contacts:write lazımdır, contacts:import yox.

    • Minimal scope-lar: contacts:import.
    • Risk: orta. Review-da hər scope üçün hansı məlumatı nə üçün işlətdiyinizi yazın.

    Əsas endpoint-lər:

    • POST /v1/contacts/import: CSV faylından kontakt idxal etmək

    Ətraflı: Scope-lar və endpoint-lər: kontaktlar, etiketlər, xüsusi sahələr, hazır cavablar.

  25. 25

    22. Audit jurnalını təhlükəsizlik sisteminə köçürmək

    Kim, nə vaxt, nəyi dəyişib məlumatını mütəmadi oxuyub təhlükəsizlik və ya uyğunluq sisteminizdə saxlayırsınız.

    • Minimal scope-lar: audit_logs:read.
    • Risk: orta. Review-da hər scope üçün hansı məlumatı nə üçün işlətdiyinizi yazın.

    Əsas endpoint-lər:

    • GET /v1/audit_logs: Audit jurnalı

    Ətraflı: Scope-lar və endpoint-lər: workspace, operatorlar, komandalar.

  26. 26

    API ilə edilə bilməyənlər

    Bunlar developer tokeninə qəsdən açılmayıb. Belə endpoint-ə sorğu 403 endpoint_not_available qaytarır.

    • workspace yaratmaq və silmək, paketi və ödənişi dəyişmək;
    • kanal sirlərini almaq və kanalı API ilə qoşmaq (channels:manage-in öz endpoint-i yoxdur);
    • agent botları və onların tokenləri, inteqrasiyalar və onların OAuth icazələri;
    • profil, parol, giriş tokenləri, başqa istifadəçinin adından girmək;
    • workspace-in öz webhook-ları: developer app-ın mövzulu öz webhook-u var;
    • toplu əməliyyatlar, bildirişlər və hər istifadəçinin şəxsi ekranları;
    • API-dən zəng etmək;
    • SSO şirkət portalı, AI tətbiqlərinin (MCP) ayarları və tokenləri, developer app-ların özünün idarəsi;
    • WhatsApp toplu göndəriş (bulk_messages): bu, profil API açarı ilə işləyən ayrıca WhatsApp API-dədir, bax WhatsApp API ilə toplu göndəriş (bulk_messages);
    • konkret söhbətdə axını başlatmaq.
  27. 27

    Əlaqəli məqalələr

Sənəd

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