Zinn® Campaigns API და MCP: დეველოპერის სახელმძღვანელო

ყველაფერი, რისი გაკეთებაც სამართავ პანელზე Zinn® Campaigns-ში შეგიძლიათ, API-ს საშუალებითაც არის შესაძლებელი, ხოლო უმეტესი ნაწილის შესრულება — MCP-ით თქვენს ანგარიშთან დაკავშირებული AI ასისტენტიდანაც. ეს სახელმძღვანელო მოიცავს სისტემაში შესვლას, ნებართვებს, პრაქტიკულ მაგალითს ორივე გზით, ლიმიტებს, შეცდომებსა და Campaigns-ის თითოეულ 89 ოპერაციას. ქვემოთ მოცემული ოპერაციების სია გენერირებულია ჩვენი API-ს სპეციფიკაციიდან, ასე რომ, იგი ყოველთვის ემთხვევა API-ს რეალურ ფუნქციონირებას. თითოეული ოპერაციის თითოეული ველი მოცემულია API-ს ცნობარში მისამართზე: zinndigital.com/developers/api/zinn-campaigns.

სისტემაში შესვლა

• API გასაღებები. შექმენით გასაღები მართვის პანელში: პარამეტრები → API გასაღებები და გაგზავნეთ როგორც Authorization: Bearer zdk_live_… (zdk_test_… გასაღები მუშაობს სატესტო რეჟიმში). მიანიჭეთ გასაღებს მხოლოდ ის Campaigns-ის ნებართვები, რომლებიც მას სჭირდება და მეტი არაფერი.
• ხელოვნური ინტელექტის ასისტენტები (MCP). დააკავშირეთ Claude, ChatGPT, Cursor ან ნებისმიერი MCP კლიენტი https://api.zinndigital.com/v1/mcp-თან, აპლიკაციიდან შესვლით ან დაკავშირების ტოკენით (zmcp_live_…). იხილეთ Claude-ის, Cursor-ის ან ChatGPT-ის დაკავშირება თქვენს ანგარიშთან. თანხმობის ეკრანზე მონიშნეთ Zinn® Campaigns-ის ნებართვები.
• ნებართვები. email_marketing.view კითხულობს კამპანიებს, სიებს, კონტაქტებს, ფორმებს, გამგზავნებს, SMS-ის პარამეტრებსა და ანგარიშებს; email_marketing.manage ქმნის და ცვლის მათ. კამპანიები, რომლებსაც აგზავნით თქვენი საკუთარი ელფოსტის სერვისით, იყენებენ campaigns.view-ს და campaigns.manage-ს.
• რესელერები. გადაეცით org_id, რათა იმოქმედოთ თქვენი კლიენტი ორგანიზაციებიდან ერთ-ერთზე. გამოტოვეთ იგი, როდესაც თქვენი გასაღები ან კავშირი ზუსტად ერთ ორგანიზაციაზე ვრცელდება.

მაგალითი: შექმენით კამპანიის ჩანახატი API-ს მეშვეობით

curl -X POST https://api.zinndigital.com/v1/email-marketing/campaigns \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Spring sale",
  "subject": "Our spring sale starts today",
  "list_id": "<list id>",
  "sender_id": "<sender id>",
  "template": "basic"
}'

პასუხია 201 მონახაზით. გამოსცადეთ ის მოთხოვნით POST /v1/email-marketing/campaigns/{campaign_id}/test, შეამოწმეთ მოთხოვნით GET /v1/email-marketing/campaigns/{campaign_id}/lint, და გაგზავნეთ მოთხოვნით POST /v1/email-marketing/campaigns/{campaign_id}/send.

მაგალითი: იგივე მონახაზი AI ასისტენტისგან

სთხოვეთ თქვენს ასისტენტს მარტივი სიტყვებით, მაგალითად: „შეადგინე Zinn® Campaigns-ის ელფოსტის მონახაზი სახელწოდებით საგაზაფხულო ფასდაკლება, თემით 'ჩვენი საგაზაფხულო ფასდაკლება დღეს იწყება'“. კულისებს მიღმა ის პოულობს ოპერაციას ფუნქციით api_operations_search, კითხულობს მის პარამეტრებს ფუნქციით api_operation_get და უშვებს მას ფუნქციით api_operation_call:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "api_operation_call",
    "arguments": {
      "operation_id": "createEmailMarketingCampaign",
      "confirm": true,
      "body": {
        "name": "Spring sale",
        "subject": "Our spring sale starts today"
      }
    }
  }
}

რას არ გააკეთებს ასისტენტი. ყველაფერი, რაც გზავნის თქვენს მიმღებებთან ან ხარჯავს ფულს ან ლიმიტს — კამპანიის გაგზავნა, SMS ან WhatsApp შეტყობინებების გაგზავნა, AI კრედიტებით წერა, US ტექსტური შეტყობინებების რეგისტრაცია — უარყოფილია ასისტენტისთვის, ასე რომ არასწორად გაგებული ინსტრუქცია ვერასდროს მიაღწევს თქვენს მომხმარებლებს. ასისტენტი ამზადებს შავნამუშევარს; თქვენ აჭერთ გაგზავნა-ს სამართავ პანელში ან თავად იძახებთ API-ს. საიდუმლოებები, როგორიცაა SMTP პაროლი, ასევე არასდროს გადაეცემა ასისტენტის მეშვეობით: შეიყვანეთ ისინი სამართავ პანელში.

ლიმიტები

• 1,200 მოთხოვნა წუთში თითოეული ადამიანისთვის ან API გასაღებისთვის, და 6,000 მოთხოვნა წუთში თითოეული ორგანიზაციისთვის. მოქმედებს მათ შორის უფრო მკაცრი შეზღუდვა.
• 600 მოთხოვნა წუთში თითოეული MCP კავშირისთვის.
• ლიმიტის გადაჭარბებისას პასუხია 429 ერთად Retry-After თავსართით: დაიცადეთ მითითებული წამების რაოდენობა.
• სიის წევრების დამატება მოითხოვს მაქსიმუმ 1,000 მისამართს ერთ მოთხოვნაზე; თქვენი ტარიფის კონტაქტებისა და ელფოსტის ლიმიტები ვრცელდება ყველაფერზე, რასაც API-ს მეშვეობით აკეთებთ.

შეცდომები

ყველა შეცდომას აქვს ერთი და იგივე ფორმა:

{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}

code ერთი და იგივე პრობლემისთვის არასდროს იცვლება, ამიტომ შეამოწმეთ ის და არა message. მხარდაჭერის გუნდთან დაკავშირებისას მიუთითეთ request_id. პასუხები, რომლებსაც შეხვდებით: 401 UNAUTHORIZED, 403 FORBIDDEN, 404 NOT_FOUND, 409 CONFLICT, 422 UNPROCESSABLE_ENTITY, 429 TOO_MANY_REQUESTS. 403 ნიშნავს, რომ გასაღებს ან კავშირს არ აქვს ქვემოთ ჩამოთვლილი რომელიმე ნებართვა; 404 ასევე მოიცავს ორგანიზაციის იმ ობიექტს, რომლის ნახვაც არ შეგიძლიათ; 422 ჩამოთვლის თითოეულ არასწორ ველს details-ში; 429-ის შემდეგ დაელოდეთ Retry-After სათაურში მითითებულ წამების რაოდენობას.

ვებჰუკები

მიწოდების შედეგები შემოდის Zinn® Campaigns-ში იმ პროვაიდერისგან, რომელიც აგზავნის თქვენს ელფოსტას:

• თქვენი საკუთარი პროვაიდერის გამოყენებისას (მაგალითად Resend), შეინახეთ მისი ვებჰუკის ხელმოწერის საიდუმლო გასაღები მართვის პანელში გამავალ კავშირზე (Campaigns → გაგზავნა). თქვენ მიიღებთ webhook_url-ს; მიმართეთ პროვაიდერის მიწოდების, დაბრუნებისა და საჩივრების მოვლენები მასზე. დაბრუნება ან სპამის შესახებ საჩივარი მისამართს მომავალი გაგზავნებიდან დაუყოვნებლივ შლის.
• Zinn®-ის გაგზავნის სერვისით დასაყენებელი არაფერია.

წაიკითხეთ შედეგები ანგარიშის ოპერაციებით (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).

Campaigns-ის ყველა ოპერაცია

მიმოხილვა

• GET /v1/email-marketing — Zinn® Campaigns-ის მიმოხილვა ერთი ორგანიზაციისთვის. ოპერაცია getEmailMarketingOverview. შემოწმებული ნებართვები: email_marketing.view. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის მეშვეობით.

ელფოსტის კამპანიები

• GET /v1/email-marketing/campaigns — ელფოსტის კამპანიები, ჯერ უახლესი, კისეტის ერთი გვერდი. ოპერაცია listEmailMarketingCampaigns. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/campaigns — ელფოსტის კამპანიის მონახაზის შექმნა. ოპერაცია createEmailMarketingCampaign. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/email-marketing/campaigns/{campaign_id} — ერთი ელფოსტის კამპანია. ოპერაცია getEmailMarketingCampaign. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — მონახაზის რედაქტირება (ან უარყოფილი კამპანიის, რომელიც უბრუნდება მონახაზის სტატუსს). ოპერაცია updateEmailMarketingCampaign. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — კამპანიის ტექსტის შემოწმება მიწოდების პრობლემებზე გაგზავნამდე. ოპერაცია lintEmailMarketingCampaign. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — კამპანიის მონაცემები. ოპერაცია getEmailMarketingCampaignReport. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/campaigns/{campaign_id}/send — კამპანიის გაგზავნის დაწყება მისი სიისათვის. ოპერაცია sendEmailMarketingCampaign. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტისგან: მხოლოდ API და სამართავი პანელი: ის ხარჯავს თანხას ან ლიმიტს, ამიტომ მას პირი აჭერს (იგზავნება რეალურ მიმღებებთან და ხარჯავს ლიმიტს).
• POST /v1/email-marketing/campaigns/{campaign_id}/test — ორგანიზაციის წევრისთვის ერთი სატესტო ასლის გაგზავნა ახლავე. ოპერაცია testEmailMarketingCampaign. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — კამპანიის თარგმნა კონტაქტის ყველა იმ ენაზე, რომელიც აკლია ან მოძველებულია. ოპერაცია translateEmailMarketingCampaign. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — კამპანიის სიის კონტაქტის თითოეული ენა და არის თუ არა მისი თარგმანი აქტუალური. ოპერაცია listEmailMarketingCampaignTranslations. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.

AI-ით წერა

• POST /v1/email-marketing/ai/write — შექმენით კამპანიის წერილის მონახაზი მოკლე აღწერილობიდან Zinn® AI-ის გამოყენებით. ოპერაცია writeEmailMarketingCampaignWithAi. შემოწმებული უფლებები: email_marketing.manage, email_marketing.view. ხელოვნური ინტელექტის ასისტენტიდან: მხოლოდ API და სამართავი პანელი: იგი ხარჯავს თანხას ან ლიმიტს, ამიტომ მას ადამიანი აჭერს (ხელოვნური ინტელექტის მიერ ტექსტის შედგენა ხარჯავს AI კრედიტებს).

ბრენდის ნაკრები

• GET /v1/email-marketing/brand-kit — ორგანიზაციის ბრენდის ნაკრები (სახელი, ლოგო, ფერები, შრიფტი, სტილი). ოპერაცია getEmailMarketingBrandKit. შემოწმებული უფლებები: email_marketing.view. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• PUT /v1/email-marketing/brand-kit — ჩაასწორეთ ბრენდის ნაკრები. ოპერაცია updateEmailMarketingBrandKit. შემოწმებული უფლებები: email_marketing.manage, email_marketing.view. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/brand-kit/read — წაიკითხეთ ბრენდის ნაკრები ორგანიზაციის ვებსაიტიდან. ოპერაცია readEmailMarketingBrandKit. შემოწმებული უფლებები: email_marketing.manage, email_marketing.view. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის მეშვეობით.

კონტაქტები და ერთჯერადი შეტყობინებები

• GET /v1/email-marketing/contacts — ორგანიზაციის კონტაქტები, თითო keyset გვერდი ერთ ჯერზე. ოპერაცია listEmailMarketingContacts. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/contacts/{contact_id}/messages — ერთი SMS-ის გაგზავნა ერთ კონტაქტთან, გადახდილი Zinn®-ის კრედიტის ბალანსიდან. ოპერაცია sendEmailMarketingMessage. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტისგან: მხოლოდ API და სამართავი პანელი: ის ხარჯავს თანხას ან ლიმიტს, ამიტომ მას ადამიანი აჭერს (კონტაქტისთვის ერთჯერადი შეტყობინების გაგზავნა ხარჯავს ლიმიტს).
• GET /v1/email-marketing/messages — ორგანიზაციის მიერ გაგზავნილი SMS და WhatsApp შეტყობინებები, უახლესი პირველ რიგში, ერთი keyset გვერდი. ოპერაცია listEmailMarketingMessages. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.

სიები

• GET /v1/email-marketing/lists — ორგანიზაციის საფოსტო სიები გამოწერილი / გამოწერაგაუქმებული მომხმარებლების რაოდენობით. ოპერაცია listEmailMarketingLists. შემოწმებული ნებართვები: email_marketing.view. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის საშუალებით.
• POST /v1/email-marketing/lists — შექმენით საფოსტო სია (ან დააბრუნეთ ამ სახელის მქონე სია). ოპერაცია createEmailMarketingList. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის საშუალებით.
• POST /v1/email-marketing/lists/{list_id}/members — კონტაქტების დამატება სიაში ელფოსტის მისამართის მიხედვით (მაქსიმუმ 1,000 მოთხოვნაზე). ოპერაცია addEmailMarketingListMembers. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის საშუალებით.

იმპორტი

• GET /v1/email-marketing/imports — კონტაქტების წინა იმპორტები, უახლესი პირველ რიგში, ერთ ჯერზე ერთი keyset გვერდი. ოპერაცია listEmailMarketingImports. შემოწმებული ნებართვები: email_marketing.view. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის საშუალებით.
• POST /v1/email-marketing/imports — კონტაქტების ერთი ნაწილის იმპორტი თანხმობის დადასტურებით. ოპერაცია createEmailMarketingImport. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის საშუალებით.

რეგისტრაციის ფორმები

• GET /v1/email-marketing/forms — რეგისტრაციის ფორმები (ორმაგი დადასტურება), უახლესი პირველ რიგში, keyset-ის ერთი გვერდი. ოპერაცია listEmailMarketingForms. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/forms — რეგისტრაციის ფორმის შექმნა, რომელიც დადასტურებულ პირებს ერთ სიაში ამატებს. ოპერაცია createEmailMarketingForm. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• DELETE /v1/email-marketing/forms/{form_id} — რეგისტრაციის ფორმის წაშლა (უკვე დადასტურებული პირები რჩებიან სიაში). ოპერაცია deleteEmailMarketingForm. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• PATCH /v1/email-marketing/forms/{form_id} — რეგისტრაციის ფორმის შეცვლა (ფორმულირება, სია, გადამისამართება, ჩართვა ან გამორთვა). ოპერაცია updateEmailMarketingForm. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.

გაგზავნის კავშირები

• GET /v1/email-marketing/senders — ორგანიზაციის გაგზავნის კავშირები. ოპერაცია listEmailMarketingSenders. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/senders — კამპანიის გამგზავნის დაკავშირება (Zinn® გაგზავნა ან კლიენტის საკუთარი SMTP სერვერი). ოპერაცია createEmailMarketingSender. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: მხოლოდ API და სამართავი პანელი: შეიცავს საიდუმლო ინფორმაციას, რომელიც არასოდეს არ უნდა მოხვდეს AI მოდელში (ტანი წარმოადგენს SMTP პაროლს).
• DELETE /v1/email-marketing/senders/{sender_id} — გაგზავნის კავშირისა და მისი შენახული პაროლის წაშლა. ოპერაცია deleteEmailMarketingSender. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/senders/{sender_id}/verify — გაგზავნის კავშირის მუშაობის დადასტურება, არაფრის გაგზავნის გარეშე. ოპერაცია verifyEmailMarketingSender. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — შეინახეთ თქვენი ელფოსტის პროვაიდერის webhook-ის ხელმოწერის საიდუმლო ამ კავშირისთვის. ოპერაცია setEmailMarketingSenderWebhook. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: გამოიძახება სხვა სისტემის მიერ (პროვაიდერი ან ვიზიტორი) და არა თქვენ მიერ (ინახავს პროვაიდერის webhook-ის საიდუმლოს).

SMS და WhatsApp

• GET /v1/email-marketing/sms — რა სჭირდება SMS ეკრანს — ღიაა?, შეჩერებულია?, კრედიტის ბალანსი და ფასები. ოპერაცია getEmailMarketingSms. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/email-marketing/sms/campaigns — მასობრივი SMS კამპანიები, უახლესი პირველ რიგში, keyset-ის ერთი გვერდი. ოპერაცია listSmsMarketingCampaigns. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/sms/campaigns — სიისთვის SMS-ის შავი ვარიანტის შექმნა. ოპერაცია createSmsMarketingCampaign. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — ერთი მასობრივი SMS კამპანია. ოპერაცია getSmsMarketingCampaign. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — შავი ვარიანტის (ან უარყოფილი კამპანიის, რომელიც ბრუნდება შავ ვარიანტში) რედაქტირება. ოპერაცია updateSmsMarketingCampaign. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — მასობრივი SMS კამპანიის მონაცემები. ოპერაცია getSmsMarketingCampaignReport. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — იწყებს SMS-ის გაგზავნას სიის ყველა წევრთან, ვინც დათანხმდა SMS-ის მიღებას, ან განაახლებს კრედიტის გამო შეჩერებულ კამპანიას. ოპერაცია sendSmsMarketingCampaign. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: მხოლოდ API და სამართავი პანელი: რადგან იხარჯება თანხა ან ლიმიტი, მას პიროვნება აჭერს (აგზავნის ფასიან SMS/WhatsApp შეტყობინებებს).
• GET /v1/email-marketing/sms/registrations/us — ამ ორგანიზაციის US 10DLC რეგისტრაცია და მისი ღირებულება. ოპერაცია getEmailMarketingUsRegistration. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/sms/registrations/us — ამ ორგანიზაციის ბრენდისა და კამპანიის გაგზავნა US 10DLC-სთვის (თანხა ჩამოიჭრება გაგზავნისას). ოპერაცია submitEmailMarketingUsRegistration. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: მხოლოდ API და სამართავი პანელი: რადგან იხარჯება თანხა ან ლიმიტი, მას პიროვნება აჭერს (US 10DLC რეგისტრაცია მოიცავს ოპერატორის საკომისიოებს).

კამპანიები თქვენი ელფოსტის სერვისით (შაბლონები, სეგმენტები, შეზღუდვები)

• GET /v1/campaigns — ორგანიზაციის კამპანიები. ოპერაცია listCampaigns. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• POST /v1/campaigns — კამპანიის შექმნა შაბლონიდან და აუდიტორიიდან. ოპერაცია createCampaign. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• DELETE /v1/campaigns/esp — გათიშეთ პროვაიდერის ანგარიში და წაშალეთ მისი შენახული გასაღები. ოპერაცია disconnectEsp. AI ასისტენტისგან: მხოლოდ API და სამართავი პანელი: შეიცავს საიდუმლოებას, რომელიც არასოდეს უნდა მოხვდეს AI მოდელში (ანადგურებს შენახულ ESP გასაღებს).
• GET /v1/campaigns/esp — ორგანიზაციის ელფოსტის პროვაიდერის საკუთარი ანგარიში. ოპერაცია getEspConnection. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/campaigns/esp — დააკავშირეთ ელფოსტის პროვაიდერის ანგარიში. ოპერაცია connectEsp. AI ასისტენტისგან: მხოლოდ API და სამართავი პანელი: შეიცავს საიდუმლოებას, რომელიც არასოდეს უნდა მოხვდეს AI მოდელში (ტექსტის ძირითადი ნაწილი არის ESP API გასაღები).
• POST /v1/campaigns/esp/verify — დაადასტურეთ, რომ პროვაიდერის ანგარიში მუშაობს და წაიკითხეთ მისი დამოწმებული დომენები. ოპერაცია verifyEspConnection. AI ასისტენტისგან: მხოლოდ API და სამართავი პანელი: შეიცავს საიდუმლოებას, რომელიც არასოდეს უნდა მოხვდეს AI მოდელში (ხელახლა ამოწმებს შენახულ ESP გასაღებს).
• POST /v1/campaigns/preview — Render შაბლონი სანიმუშო მნიშვნელობებით. ოპერაცია previewCampaignTemplate. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/campaigns/segments — თქვენი შენახული აუდიტორიის სეგმენტები. ოპერაცია listCampaignSegments. შემოწმებული ნებართვები: campaigns.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/campaigns/segments — შეინახეთ აუდიტორიის ახალი სეგმენტი. ოპერაცია createCampaignSegment. შემოწმებული ნებართვები: campaigns.manage. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/campaigns/segments/fields — ფილტრის ლექსიკა, მისი მნიშვნელობების სიები და ჯადოსნური ტეგები. ოპერაცია getCampaignSegmentFields. შემოწმებული ნებართვები: campaigns.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/campaigns/segments/preview — რამდენ ადამიანს სწვდება ეს, ვინ არიან ისინი და ვის გამორიცხავს. ოპერაცია previewCampaignSegment. შემოწმებული ნებართვები: campaigns.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• DELETE /v1/campaigns/segments/{segmentId} — სეგმენტის დაარქივება. ოპერაცია archiveCampaignSegment. შემოწმებული ნებართვები: campaigns.manage. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/campaigns/segments/{segmentId} — ერთი შენახული სეგმენტი. ოპერაცია getCampaignSegment. შემოწმებული ნებართვები: campaigns.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• PATCH /v1/campaigns/segments/{segmentId} — სეგმენტის სახელის გადარქმევა ან მისი ფილტრების შეცვლა. ოპერაცია updateCampaignSegment. შემოწმებული ნებართვები: campaigns.manage. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/campaigns/suppressions — მისამართები, რომლებმაც არ უნდა მიიღონ მარკეტინგი. ოპერაცია listCampaignSuppressions. შემოწმებული ნებართვები: campaigns.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/campaigns/suppressions — მისამართის დამატება ჩახშობის სიაში. ოპერაცია createCampaignSuppression. შემოწმებული ნებართვები: campaigns.manage. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/campaigns/tags — ჯადოსნური ჭდეების პალიტრა, რომელსაც კამპანიის შემქმნელი გთავაზობთ. ოპერაცია listCampaignTags. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• GET /v1/campaigns/templates — ორგანიზაციის კამპანიის შაბლონები. ოპერაცია listCampaignTemplates. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• POST /v1/campaigns/templates — კამპანიის შაბლონის შექმნა. ოპერაცია createCampaignTemplate. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• DELETE /v1/campaigns/templates/{templateId} — შაბლონის დაარქივება და მისი თარგმანის წყაროების გაუქმება. ოპერაცია archiveCampaignTemplate. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• GET /v1/campaigns/templates/{templateId} — კამპანიის ერთი შაბლონი. ოპერაცია getCampaignTemplate. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• PUT /v1/campaigns/templates/{templateId} — კამპანიის შაბლონის რედაქტირება. ოპერაცია updateCampaignTemplate. ხელოვნური ინტელექტის ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• POST /v1/campaigns/unsubscribe — მარკეტინგული სიიდან გამოსვლა. ანგარიში არ არის საჭირო. ოპერაცია unsubscribeFromCampaigns. ხელოვნური ინტელექტის ასისტენტიდან: მხოლოდ API და სამართავი პანელი: შეიცავს საიდუმლო ინფორმაციას, რომელიც არასდროს უნდა მოხვდეს ხელოვნური ინტელექტის მოდელში (იღებს მიმღების ხელმოწერილ გამოწერის გაუქმების ტოკენს).
• DELETE /v1/campaigns/{campaignId} — კამპანიის წაშლა და მისი მიწოდების ჩანაწერების გაუქმება. ოპერაცია deleteCampaign. ხელოვნური ინტელექტის ასისტენტიდან: მხოლოდ API და სამართავი პანელი: საჭიროებს ნებართვას, რომელიც ხელოვნური ინტელექტის კავშირებისთვის არ არის ხელმისაწვდომი (ESP კამპანიის წაშლას სჭირდება campaigns.send).
• GET /v1/campaigns/{campaignId} — ერთი კამპანია და მისი მიწოდების ანგარიში. ოპერაცია getCampaign. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/campaigns/{campaignId}/control — მიმდინარე გაგზავნის დაპაუზება, განახლება ან გაუქმება. ოპერაცია controlCampaign. AI ასისტენტისგან: მხოლოდ API და სამართავი პანელი: იგი ხარჯავს თანხას ან ლიმიტს, ამიტომ მას ადამიანი აჭერს (აპაუზებს/აახლებს ცოცხალ გაგზავნას).
• POST /v1/campaigns/{campaignId}/send — ხანგრძლივი გაგზავნის დაწყება. ოპერაცია sendCampaign. AI ასისტენტისგან: მხოლოდ API და სამართავი პანელი: იგი ხარჯავს თანხას ან ლიმიტს, ამიტომ მას ადამიანი აჭერს (უგზავნის ESP კამპანიას რეალურ ადრესატებს).
• POST /v1/campaigns/{campaignId}/test — ერთი რეალური შეტყობინების გაგზავნა იმ არხზე, რომელსაც კამპანია რეალურად გამოიყენებს. ოპერაცია testSendCampaign. AI ასისტენტისგან: მხოლოდ API და სამართავი პანელი: მას სჭირდება ნებართვა, რომელიც AI კავშირებს არ გააჩნია (ESP სატესტო გაგზავნას სჭირდება campaigns.send).

საჯარო გვერდები და შემომავალი ვებჰუკები

• GET /v1/public/email-marketing/c/{token} — დაწკაპუნებების მრიცხველი. აღრიცხავს ერთ დაწკაპუნებას თითოეულ ადრესატზე და გადაამისამართებს თავდაპირველ ბმულზე. ოპერაცია emailMarketingClick. AI ასისტენტისგან: გვერდი, რომელსაც თქვენი ადრესატები ხსნიან ელფოსტიდან (დაწკაპუნების აღრიცხვის გადამისამართება).
• GET /v1/public/email-marketing/f/{public_id} — რეგისტრაციის ფორმის ჰოსტირებული გვერდი (ავტორიზაციის გარეშე). ოპერაცია emailMarketingFormPage. AI ასისტენტისგან: გვერდი, რომელსაც თქვენი ადრესატები ხსნიან ელფოსტიდან (რეგისტრაციის საჯარო ფორმის გვერდი).
• POST /v1/public/email-marketing/f/{public_id} — რეგისტრაციის ფორმის გაგზავნა (ჰოსტირებული გვერდი, ჩაშენებული ან JSON). ოპერაცია emailMarketingFormSubmit. AI ასისტენტისგან: გამოძახებულია სხვა სისტემის მიერ (პროვაიდერი ან ვიზიტორი), და არა თქვენ მიერ (ვიზიტორი აგზავნის რეგისტრაციის ფორმას).
• GET /v1/public/email-marketing/fc — ორმაგი დათანხმების (double opt-in) დადასტურების გვერდი (შესვლის გარეშე). ოპერაცია emailMarketingFormConfirmPage. AI ასისტენტისგან: გვერდი, რომელსაც თქვენი ადრესატები ხსნიან ელფოსტიდან (ორმაგი დათანხმების დადასტურების გვერდი).
• POST /v1/public/email-marketing/fc — რეგისტრაციის დადასტურება (ამატებს პირს სიაში თანხმობის ჩანაწერით). ოპერაცია emailMarketingFormConfirm. AI ასისტენტისგან: გამოძახებულია სხვა სისტემის მიერ (პროვაიდერი ან ვიზიტორი), და არა თქვენ მიერ (ვიზიტორი ადასტურებს ორმაგ დათანხმებას).
• GET /v1/public/email-marketing/o/{token} — გახსნის აღმრიცხველი სურათი (1x1 GIF). ითვლის ერთ გახსნას თითოეულ ადრესატზე. ოპერაცია emailMarketingOpenPixel. AI ასისტენტისგან: გვერდი, რომელსაც თქვენი ადრესატები ხსნიან ელფოსტიდან (გახსნის აღმრიცხველი პიქსელი).
• GET /v1/public/email-marketing/u/{token} — ქვედა კოლონტიტულის გამოწერის გაუქმების ბმული (შესვლის გარეშე). ოპერაცია emailMarketingUnsubscribePage. AI ასისტენტისგან: გვერდი, რომელსაც თქვენი ადრესატები ხსნიან ელფოსტიდან (გამოწერის გაუქმების გვერდი).
• POST /v1/public/email-marketing/u/{token} — RFC 8058 ერთი დაწკაპუნებით გამოწერის გაუქმება (და გვერდის ღილაკი „ყველაფრის შეწყვეტა“). ოპერაცია emailMarketingUnsubscribeOneClick. AI ასისტენტისგან: გამოძახებულია სხვა სისტემის (პროვაიდერის ან ვიზიტორის) მიერ და არა თქვენ მიერ (RFC 8058 ერთი დაწკაპუნებით გამოწერის გაუქმება).
• GET /v1/public/email-marketing/warmup-u/{token} — მარკეტინგული პულის გახურების წერილის გამოწერის გაუქმების ბმული (ავტორიზაციის გარეშე). ოპერაცია emailMarketingWarmupUnsubscribePage. AI ასისტენტისგან: გვერდი, რომელსაც თქვენი ადრესატები ხსნიან ელფოსტიდან (გახურების გამოწერის გაუქმების გვერდი).
• POST /v1/public/email-marketing/warmup-u/{token} — RFC 8058 ერთი დაწკაპუნებით გამოწერის გაუქმება გახურების წერილიდან. ოპერაცია emailMarketingWarmupUnsubscribeOneClick. AI ასისტენტისგან: გამოძახებულია სხვა სისტემის (პროვაიდერის ან ვიზიტორის) მიერ და არა თქვენ მიერ (გახურების ერთი დაწკაპუნებით გამოწერის გაუქმება).
• POST /v1/webhooks/campaign-events — ელფოსტის პროვაიდერისგან ხელმოწერილი მიწოდების მოვლენის მიღება. ოპერაცია receiveCampaignDeliveryWebhook. AI ასისტენტისგან: გამოძახებულია სხვა სისტემის (პროვაიდერის ან ვიზიტორის) მიერ და არა თქვენ მიერ (ხელმოწერილი ESP მიწოდების ვებჰუკი).
• POST /v1/webhooks/campaigns/telnyx — შემომავალი SMS პასუხები (STOP / START) ჩვენი SMS პროვაიდერისგან. ოპერაცია receiveCampaignsTelnyxInbound. AI ასისტენტისგან: გამოძახებულია სხვა სისტემის (პროვაიდერის ან ვიზიტორის) მიერ და არა თქვენ მიერ (ხელმოწერილი Telnyx შემომავალი ვებჰუკი).
• POST /v1/webhooks/email-marketing/{connection_id} — მომხმარებლის საკუთარი ელფოსტის პროვაიდერის მიწოდების მოვლენები ერთი გამგზავნი კავშირისთვის. ოპერაცია receiveEmailMarketingProviderWebhook. AI ასისტენტისგან: გამოძახებულია სხვა სისტემის მიერ (პროვაიდერი ან ვიზიტორი), არა თქვენ მიერ (ხელმოწერილი გამგზავნ-პროვაიდერის ვებჰუკი).

ნაკადები

• GET /v1/email-marketing/flows — ელფოსტის ნაკადები (მისალმება, drip, წლიური თარიღი), keyset-ის ერთი გვერდი. ოპერაცია listEmailMarketingFlows. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/flows — ნაკადის შექმნა (იწყება როგორც მონახაზი). ოპერაცია createEmailMarketingFlow. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• DELETE /v1/email-marketing/flows/{flow_id} — ნაკადისა და მასში რეგისტრაციების წაშლა (გაგზავნილი გაშვებები რჩება კამპანიებად). ოპერაცია deleteEmailMarketingFlow. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• GET /v1/email-marketing/flows/{flow_id} — ერთი ნაკადი თავისი ნაბიჯებითა და ანგარიშით (დარეგისტრირებული, მიმდინარე, გაშვებები და მიმღებები თითოეულ ნაბიჯზე). ოპერაცია getEmailMarketingFlow. შემოწმებული ნებართვები: email_marketing.view. AI ასისტენტისგან: დიახ, MCP-ის მეშვეობით.
• PATCH /v1/email-marketing/flows/{flow_id} — ნაკადის შეცვლა; steps, მითითების შემთხვევაში, ანაცვლებს მთელ თანმიმდევრობას. ოპერაცია updateEmailMarketingFlow. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/flows/{flow_id}/activate — ნაკადის ჩართვა; ჩაირიცხებიან მხოლოდ ის პირები, რომლებიც სიას ამიერიდან შეუერთდებიან. ოპერაცია activateEmailMarketingFlow. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.
• POST /v1/email-marketing/flows/{flow_id}/pause — ნაკადის შეჩერება; შესასრულებელი ნაბიჯები დაელოდება და ხელახლა ჩართვამდე ახალ წერილებს არავინ მიიღებს. ოპერაცია pauseEmailMarketingFlow. შემოწმებული ნებართვები: email_marketing.manage, email_marketing.view. AI ასისტენტიდან: დიახ, MCP-ის მეშვეობით.